From 7c73af5aa00b5fa58e5b70df36845d81fd9dac95 Mon Sep 17 00:00:00 2001 From: Daniil Gentili Date: Tue, 27 Mar 2018 14:41:50 +0200 Subject: [PATCH] Improve docs --- docs/API_docs/methods/account_changePhone.md | 20 +++--- .../API_docs/methods/account_checkUsername.md | 16 ++--- docs/API_docs/methods/account_confirmPhone.md | 20 +++--- .../API_docs/methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- docs/API_docs/methods/account_getPrivacy.md | 16 ++--- .../methods/account_getTmpPassword.md | 20 +++--- .../methods/account_registerDevice.md | 22 +++--- docs/API_docs/methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_resetWebAuthorization.md | 2 +- .../methods/account_sendChangePhoneCode.md | 20 +++--- .../methods/account_sendConfirmPhoneCode.md | 20 +++--- .../API_docs/methods/account_setAccountTTL.md | 16 ++--- docs/API_docs/methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 20 +++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../API_docs/methods/account_updateProfile.md | 22 +++--- docs/API_docs/methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- docs/API_docs/methods/auth_cancelCode.md | 18 ++--- docs/API_docs/methods/auth_checkPhone.md | 20 +++--- .../API_docs/methods/auth_dropTempAuthKeys.md | 2 +- docs/API_docs/methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- docs/API_docs/methods/auth_resendCode.md | 18 ++--- .../methods/auth_resetAuthorizations.md | 14 ++-- docs/API_docs/methods/auth_sendInvites.md | 18 ++--- .../methods/bots_answerWebhookJSONQuery.md | 20 +++--- .../methods/bots_sendCustomRequest.md | 18 ++--- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteHistory.md | 2 +- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- docs/API_docs/methods/channels_editAbout.md | 22 +++--- docs/API_docs/methods/channels_editAdmin.md | 34 ++++----- docs/API_docs/methods/channels_editBanned.md | 24 +++---- docs/API_docs/methods/channels_editPhoto.md | 20 +++--- docs/API_docs/methods/channels_editTitle.md | 20 +++--- .../API_docs/methods/channels_exportInvite.md | 18 ++--- .../methods/channels_exportMessageLink.md | 18 ++--- docs/API_docs/methods/channels_getAdminLog.md | 28 ++++---- docs/API_docs/methods/channels_getChannels.md | 18 ++--- docs/API_docs/methods/channels_getMessages.md | 18 ++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 30 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ docs/API_docs/methods/channels_joinChannel.md | 18 ++--- .../API_docs/methods/channels_leaveChannel.md | 22 +++--- docs/API_docs/methods/channels_readHistory.md | 18 ++--- .../methods/channels_readMessageContents.md | 18 ++--- docs/API_docs/methods/channels_reportSpam.md | 18 ++--- docs/API_docs/methods/channels_setStickers.md | 18 ++--- .../methods/channels_toggleInvites.md | 20 +++--- .../channels_togglePreHistoryHidden.md | 2 +- .../methods/channels_toggleSignatures.md | 16 ++--- .../methods/channels_updatePinnedMessage.md | 24 +++---- .../methods/channels_updateUsername.md | 24 +++---- docs/API_docs/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- docs/API_docs/methods/contacts_getBlocked.md | 4 +- docs/API_docs/methods/contacts_getContacts.md | 2 +- docs/API_docs/methods/contacts_getTopPeers.md | 32 ++++----- docs/API_docs/methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 2 +- .../methods/contacts_resetTopPeerRating.md | 16 ++--- docs/API_docs/methods/contacts_search.md | 22 +++--- docs/API_docs/methods/contacts_unblock.md | 14 ++-- docs/API_docs/methods/help_getAppChangelog.md | 2 +- docs/API_docs/methods/help_getCdnConfig.md | 14 ++-- docs/API_docs/methods/help_getConfig.md | 14 ++-- docs/API_docs/methods/help_getRecentMeUrls.md | 2 +- docs/API_docs/methods/help_saveAppLog.md | 2 +- .../methods/help_setBotUpdatesStatus.md | 4 +- docs/API_docs/methods/initConnection.md | 32 ++++----- docs/API_docs/methods/invokeAfterMsg.md | 4 +- docs/API_docs/methods/invokeAfterMsgs.md | 4 +- docs/API_docs/methods/invokeWithLayer.md | 38 +++++----- docs/API_docs/methods/invokeWithoutUpdates.md | 2 +- .../methods/langpack_getDifference.md | 16 ++--- docs/API_docs/methods/langpack_getLangPack.md | 16 ++--- .../API_docs/methods/langpack_getLanguages.md | 14 ++-- docs/API_docs/methods/langpack_getStrings.md | 18 ++--- docs/API_docs/methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_clearRecentStickers.md | 2 +- docs/API_docs/methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 18 ++--- .../methods/messages_deleteMessages.md | 18 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_editInlineBotMessage.md | 30 ++++---- docs/API_docs/methods/messages_editMessage.md | 46 ++++++------ .../methods/messages_exportChatInvite.md | 14 ++-- docs/API_docs/methods/messages_faveSticker.md | 16 ++--- .../methods/messages_forwardMessages.md | 66 ++++++++--------- docs/API_docs/methods/messages_getAllChats.md | 2 +- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getArchivedStickers.md | 6 +- .../methods/messages_getAttachedStickers.md | 2 +- .../methods/messages_getBotCallbackAnswer.md | 28 ++++---- docs/API_docs/methods/messages_getChats.md | 18 ++--- .../methods/messages_getCommonChats.md | 18 ++--- docs/API_docs/methods/messages_getDialogs.md | 28 ++++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getFavedStickers.md | 2 +- .../methods/messages_getFeaturedStickers.md | 2 +- .../methods/messages_getGameHighScores.md | 18 ++--- docs/API_docs/methods/messages_getHistory.md | 38 +++++----- .../methods/messages_getInlineBotResults.md | 26 +++---- .../messages_getInlineGameHighScores.md | 18 ++--- .../methods/messages_getMaskStickers.md | 2 +- .../methods/messages_getMessageEditData.md | 18 ++--- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getPeerDialogs.md | 16 ++--- .../methods/messages_getPeerSettings.md | 16 ++--- .../methods/messages_getRecentLocations.md | 2 +- .../methods/messages_getRecentStickers.md | 4 +- .../API_docs/methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- docs/API_docs/methods/messages_getStickers.md | 4 +- .../methods/messages_getUnreadMentions.md | 24 +++---- docs/API_docs/methods/messages_getWebPage.md | 18 ++--- .../methods/messages_getWebPagePreview.md | 4 +- .../methods/messages_hideReportSpam.md | 14 ++-- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- docs/API_docs/methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readFeaturedStickers.md | 2 +- docs/API_docs/methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderPinnedDialogs.md | 16 ++--- .../methods/messages_reorderStickerSets.md | 4 +- .../methods/messages_reportEncryptedSpam.md | 14 ++-- docs/API_docs/methods/messages_reportSpam.md | 14 ++-- docs/API_docs/methods/messages_saveDraft.md | 22 +++--- docs/API_docs/methods/messages_saveGif.md | 16 ++--- .../methods/messages_saveRecentSticker.md | 18 ++--- docs/API_docs/methods/messages_search.md | 44 ++++++------ docs/API_docs/methods/messages_searchGifs.md | 18 ++--- .../API_docs/methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 36 +++++----- docs/API_docs/methods/messages_sendMedia.md | 70 +++++++++---------- docs/API_docs/methods/messages_sendMessage.md | 70 +++++++++---------- .../methods/messages_sendMultiMedia.md | 10 +-- .../messages_sendScreenshotNotification.md | 16 ++--- .../methods/messages_setBotCallbackAnswer.md | 24 +++---- .../messages_setBotPrecheckoutResults.md | 20 +++--- .../methods/messages_setBotShippingResults.md | 20 +++--- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../API_docs/methods/messages_setGameScore.md | 24 +++---- .../methods/messages_setInlineBotResults.md | 48 ++++++------- .../methods/messages_setInlineGameScore.md | 24 +++---- docs/API_docs/methods/messages_setTyping.md | 30 ++++---- docs/API_docs/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_toggleDialogPin.md | 16 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- docs/API_docs/methods/messages_uploadMedia.md | 18 ++--- .../methods/payments_clearSavedInfo.md | 4 +- .../methods/payments_getPaymentForm.md | 16 ++--- .../methods/payments_getPaymentReceipt.md | 16 ++--- .../methods/payments_sendPaymentForm.md | 22 +++--- .../methods/payments_validateRequestedInfo.md | 20 +++--- docs/API_docs/methods/phone_receivedCall.md | 18 ++--- docs/API_docs/methods/phone_saveCallDebug.md | 20 +++--- docs/API_docs/methods/phone_setCallRating.md | 20 +++--- docs/API_docs/methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_uploadProfilePhoto.md | 20 +++--- .../methods/stickers_addStickerToSet.md | 20 +++--- .../methods/stickers_changeStickerPosition.md | 18 ++--- .../methods/stickers_createStickerSet.md | 38 +++++----- .../methods/stickers_removeStickerFromSet.md | 16 ++--- docs/API_docs/methods/upload_getWebFile.md | 20 +++--- docs/API_docs/methods/users_getUsers.md | 20 +++--- docs/MTProto_docs/methods/destroy_session.md | 2 +- docs/MTProto_docs/methods/get_future_salts.md | 2 +- docs/MTProto_docs/methods/http_wait.md | 6 +- docs/MTProto_docs/methods/ping.md | 2 +- .../methods/ping_delay_disconnect.md | 4 +- docs/MTProto_docs/methods/req_DH_params.md | 12 ++-- docs/MTProto_docs/methods/req_pq.md | 2 +- docs/MTProto_docs/methods/req_pq_multi.md | 2 +- docs/MTProto_docs/methods/rpc_drop_answer.md | 2 +- .../methods/set_client_DH_params.md | 6 +- docs/TD_docs/methods/acceptCall.md | 4 +- docs/TD_docs/methods/addChatMember.md | 6 +- docs/TD_docs/methods/addChatMembers.md | 4 +- docs/TD_docs/methods/addFavoriteSticker.md | 2 +- docs/TD_docs/methods/addNetworkStatistics.md | 2 +- docs/TD_docs/methods/addRecentSticker.md | 4 +- docs/TD_docs/methods/addRecentlyFoundChat.md | 2 +- docs/TD_docs/methods/addSavedAnimation.md | 2 +- docs/TD_docs/methods/addStickerToSet.md | 6 +- docs/TD_docs/methods/answerCallbackQuery.md | 10 +-- docs/TD_docs/methods/answerCustomQuery.md | 4 +- docs/TD_docs/methods/answerInlineQuery.md | 14 ++-- .../TD_docs/methods/answerPreCheckoutQuery.md | 4 +- docs/TD_docs/methods/answerShippingQuery.md | 6 +- docs/TD_docs/methods/blockUser.md | 2 +- docs/TD_docs/methods/cancelDownloadFile.md | 2 +- docs/TD_docs/methods/cancelUploadFile.md | 2 +- docs/TD_docs/methods/changeAbout.md | 2 +- docs/TD_docs/methods/changeAccountTtl.md | 2 +- .../methods/changeChannelDescription.md | 4 +- docs/TD_docs/methods/changeChannelUsername.md | 4 +- .../TD_docs/methods/changeChatDraftMessage.md | 4 +- .../TD_docs/methods/changeChatMemberStatus.md | 6 +- docs/TD_docs/methods/changeChatPhoto.md | 4 +- .../methods/changeChatReportSpamState.md | 4 +- docs/TD_docs/methods/changeChatTitle.md | 4 +- docs/TD_docs/methods/changeName.md | 4 +- docs/TD_docs/methods/changePhoneNumber.md | 6 +- docs/TD_docs/methods/changeStickerSet.md | 6 +- docs/TD_docs/methods/changeUsername.md | 2 +- docs/TD_docs/methods/checkAuthBotToken.md | 2 +- docs/TD_docs/methods/checkAuthCode.md | 6 +- docs/TD_docs/methods/checkAuthPassword.md | 2 +- .../methods/checkChangePhoneNumberCode.md | 2 +- docs/TD_docs/methods/checkChatInviteLink.md | 2 +- docs/TD_docs/methods/clearRecentStickers.md | 2 +- docs/TD_docs/methods/closeChat.md | 2 +- docs/TD_docs/methods/closeSecretChat.md | 2 +- docs/TD_docs/methods/createCall.md | 4 +- docs/TD_docs/methods/createChannelChat.md | 2 +- docs/TD_docs/methods/createGroupChat.md | 2 +- docs/TD_docs/methods/createNewChannelChat.md | 6 +- docs/TD_docs/methods/createNewGroupChat.md | 4 +- docs/TD_docs/methods/createNewSecretChat.md | 2 +- docs/TD_docs/methods/createNewStickerSet.md | 10 +-- docs/TD_docs/methods/createPrivateChat.md | 2 +- docs/TD_docs/methods/createSecretChat.md | 2 +- .../methods/createTemporaryPassword.md | 4 +- docs/TD_docs/methods/debugCall.md | 4 +- docs/TD_docs/methods/deleteAccount.md | 2 +- docs/TD_docs/methods/deleteChannel.md | 2 +- docs/TD_docs/methods/deleteChatHistory.md | 4 +- docs/TD_docs/methods/deleteChatReplyMarkup.md | 4 +- docs/TD_docs/methods/deleteContacts.md | 2 +- docs/TD_docs/methods/deleteFavoriteSticker.md | 2 +- docs/TD_docs/methods/deleteFile.md | 2 +- docs/TD_docs/methods/deleteMessages.md | 6 +- .../TD_docs/methods/deleteMessagesFromUser.md | 4 +- docs/TD_docs/methods/deleteProfilePhoto.md | 2 +- docs/TD_docs/methods/deleteRecentHashtag.md | 2 +- docs/TD_docs/methods/deleteRecentSticker.md | 4 +- .../methods/deleteRecentlyFoundChat.md | 2 +- docs/TD_docs/methods/deleteSavedAnimation.md | 2 +- docs/TD_docs/methods/deleteStickerFromSet.md | 2 +- docs/TD_docs/methods/deleteTopChat.md | 4 +- docs/TD_docs/methods/discardCall.md | 8 +-- docs/TD_docs/methods/downloadFile.md | 4 +- .../methods/editInlineMessageCaption.md | 6 +- .../methods/editInlineMessageReplyMarkup.md | 4 +- docs/TD_docs/methods/editInlineMessageText.md | 6 +- docs/TD_docs/methods/editMessageCaption.md | 8 +-- .../TD_docs/methods/editMessageReplyMarkup.md | 6 +- docs/TD_docs/methods/editMessageText.md | 8 +-- docs/TD_docs/methods/exportChatInviteLink.md | 2 +- docs/TD_docs/methods/finishFileGeneration.md | 2 +- docs/TD_docs/methods/forwardMessages.md | 10 +-- .../TD_docs/methods/getArchivedStickerSets.md | 6 +- .../TD_docs/methods/getAttachedStickerSets.md | 2 +- docs/TD_docs/methods/getBlockedUsers.md | 4 +- .../TD_docs/methods/getCallbackQueryAnswer.md | 6 +- docs/TD_docs/methods/getChannel.md | 2 +- docs/TD_docs/methods/getChannelFull.md | 2 +- docs/TD_docs/methods/getChannelMembers.md | 8 +-- docs/TD_docs/methods/getChat.md | 2 +- docs/TD_docs/methods/getChatEventLog.md | 12 ++-- docs/TD_docs/methods/getChatHistory.md | 10 +-- docs/TD_docs/methods/getChatMember.md | 4 +- .../TD_docs/methods/getChatReportSpamState.md | 2 +- docs/TD_docs/methods/getChats.md | 6 +- docs/TD_docs/methods/getCommonChats.md | 6 +- docs/TD_docs/methods/getFile.md | 2 +- docs/TD_docs/methods/getFileExtension.md | 2 +- docs/TD_docs/methods/getFileMimeType.md | 2 +- docs/TD_docs/methods/getFilePersistent.md | 4 +- docs/TD_docs/methods/getGameHighScores.md | 6 +- docs/TD_docs/methods/getGroup.md | 2 +- docs/TD_docs/methods/getGroupFull.md | 2 +- .../methods/getInlineGameHighScores.md | 4 +- docs/TD_docs/methods/getInlineQueryResults.md | 10 +-- .../methods/getInstalledStickerSets.md | 2 +- docs/TD_docs/methods/getMessage.md | 4 +- docs/TD_docs/methods/getMessages.md | 4 +- docs/TD_docs/methods/getNetworkStatistics.md | 2 +- .../methods/getNotificationSettings.md | 2 +- docs/TD_docs/methods/getOption.md | 2 +- docs/TD_docs/methods/getPaymentForm.md | 4 +- docs/TD_docs/methods/getPaymentReceipt.md | 4 +- docs/TD_docs/methods/getPrivacy.md | 2 +- docs/TD_docs/methods/getPublicMessageLink.md | 4 +- docs/TD_docs/methods/getRecentStickers.md | 2 +- docs/TD_docs/methods/getRecoveryEmail.md | 2 +- docs/TD_docs/methods/getSecretChat.md | 2 +- docs/TD_docs/methods/getStickerEmojis.md | 2 +- docs/TD_docs/methods/getStickerSet.md | 2 +- docs/TD_docs/methods/getStickers.md | 4 +- docs/TD_docs/methods/getStorageStatistics.md | 2 +- docs/TD_docs/methods/getTextEntities.md | 2 +- docs/TD_docs/methods/getTopChats.md | 4 +- docs/TD_docs/methods/getUser.md | 2 +- docs/TD_docs/methods/getUserFull.md | 2 +- docs/TD_docs/methods/getUserProfilePhotos.md | 6 +- docs/TD_docs/methods/getWebPageInstantView.md | 4 +- docs/TD_docs/methods/getWebPagePreview.md | 2 +- docs/TD_docs/methods/importChatInviteLink.md | 2 +- docs/TD_docs/methods/importContacts.md | 2 +- .../methods/migrateGroupChatToChannelChat.md | 2 +- docs/TD_docs/methods/openChat.md | 2 +- docs/TD_docs/methods/openMessageContent.md | 4 +- docs/TD_docs/methods/optimizeStorage.md | 16 ++--- docs/TD_docs/methods/pinChannelMessage.md | 6 +- docs/TD_docs/methods/processDcUpdate.md | 4 +- docs/TD_docs/methods/rateCall.md | 6 +- docs/TD_docs/methods/recoverAuthPassword.md | 2 +- docs/TD_docs/methods/recoverPassword.md | 2 +- docs/TD_docs/methods/registerDevice.md | 2 +- .../methods/reorderInstalledStickerSets.md | 4 +- docs/TD_docs/methods/reportChannelSpam.md | 6 +- docs/TD_docs/methods/reportChat.md | 4 +- docs/TD_docs/methods/resetAuth.md | 2 +- docs/TD_docs/methods/searchCallMessages.md | 6 +- docs/TD_docs/methods/searchChatMembers.md | 6 +- docs/TD_docs/methods/searchChatMessages.md | 14 ++-- docs/TD_docs/methods/searchChats.md | 4 +- docs/TD_docs/methods/searchContacts.md | 4 +- docs/TD_docs/methods/searchHashtags.md | 4 +- docs/TD_docs/methods/searchMessages.md | 10 +-- docs/TD_docs/methods/searchPublicChat.md | 2 +- docs/TD_docs/methods/searchPublicChats.md | 2 +- docs/TD_docs/methods/searchSecretMessages.md | 10 +-- docs/TD_docs/methods/searchStickerSet.md | 2 +- docs/TD_docs/methods/sendBotStartMessage.md | 6 +- docs/TD_docs/methods/sendChatAction.md | 4 +- .../sendChatScreenshotTakenNotification.md | 2 +- docs/TD_docs/methods/sendChatSetTtlMessage.md | 4 +- docs/TD_docs/methods/sendCustomRequest.md | 4 +- .../methods/sendInlineQueryResultMessage.md | 12 ++-- docs/TD_docs/methods/sendMessage.md | 12 ++-- docs/TD_docs/methods/sendPaymentForm.md | 10 +-- docs/TD_docs/methods/setAlarm.md | 2 +- docs/TD_docs/methods/setAuthPhoneNumber.md | 6 +- docs/TD_docs/methods/setBotUpdatesStatus.md | 4 +- docs/TD_docs/methods/setChannelStickerSet.md | 4 +- docs/TD_docs/methods/setChatClientData.md | 4 +- .../methods/setFileGenerationProgress.md | 6 +- docs/TD_docs/methods/setGameScore.md | 12 ++-- docs/TD_docs/methods/setInlineGameScore.md | 10 +-- docs/TD_docs/methods/setNetworkType.md | 2 +- .../methods/setNotificationSettings.md | 4 +- docs/TD_docs/methods/setOption.md | 4 +- docs/TD_docs/methods/setPassword.md | 10 +-- docs/TD_docs/methods/setPinnedChats.md | 2 +- docs/TD_docs/methods/setPrivacy.md | 4 +- docs/TD_docs/methods/setProfilePhoto.md | 2 +- docs/TD_docs/methods/setProxy.md | 2 +- docs/TD_docs/methods/setRecoveryEmail.md | 4 +- .../methods/setStickerPositionInSet.md | 4 +- docs/TD_docs/methods/terminateSession.md | 2 +- docs/TD_docs/methods/testCallBytes.md | 2 +- docs/TD_docs/methods/testCallString.md | 2 +- docs/TD_docs/methods/testCallVectorInt.md | 2 +- .../methods/testCallVectorIntObject.md | 2 +- docs/TD_docs/methods/testCallVectorString.md | 2 +- .../methods/testCallVectorStringObject.md | 2 +- docs/TD_docs/methods/testSquareInt.md | 2 +- docs/TD_docs/methods/toggleChannelInvites.md | 4 +- .../methods/toggleChannelSignMessages.md | 4 +- docs/TD_docs/methods/toggleChatIsPinned.md | 4 +- .../methods/toggleGroupAdministrators.md | 4 +- docs/TD_docs/methods/unblockUser.md | 2 +- docs/TD_docs/methods/unpinChannelMessage.md | 2 +- docs/TD_docs/methods/uploadFile.md | 6 +- docs/TD_docs/methods/uploadStickerFile.md | 4 +- docs/TD_docs/methods/validateOrderInfo.md | 8 +-- docs/TD_docs/methods/viewMessages.md | 4 +- .../methods/viewTrendingStickerSets.md | 2 +- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_registerDevice.md | 28 ++++---- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updateProfile.md | 20 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v18/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v18/methods/auth_sendCall.md | 4 +- .../API_docs_v18/methods/auth_sendInvites.md | 18 ++--- old_docs/API_docs_v18/methods/auth_sendSms.md | 4 +- .../API_docs_v18/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getSuggested.md | 2 +- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../API_docs_v18/methods/contacts_search.md | 22 +++--- .../API_docs_v18/methods/contacts_unblock.md | 14 ++-- .../API_docs_v18/methods/help_getAppUpdate.md | 8 +-- .../API_docs_v18/methods/help_getConfig.md | 14 ++-- .../methods/help_getInviteText.md | 2 +- .../API_docs_v18/methods/help_saveAppLog.md | 2 +- .../API_docs_v18/methods/initConnection.md | 28 ++++---- .../API_docs_v18/methods/invokeAfterMsg.md | 4 +- .../API_docs_v18/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v18/methods/invokeWithLayer18.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 16 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 58 +++++++-------- .../API_docs_v18/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 26 +++---- .../methods/messages_getHistory.md | 30 ++++---- .../methods/messages_getMessages.md | 2 +- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 22 +++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reportSpam.md | 14 ++-- .../API_docs_v18/methods/messages_search.md | 40 +++++------ .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendMedia.md | 56 +++++++-------- .../methods/messages_sendMessage.md | 56 +++++++-------- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setTyping.md | 30 ++++---- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v18/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 28 ++++---- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 16 ++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updateProfile.md | 20 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v23/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v23/methods/auth_sendCall.md | 4 +- .../API_docs_v23/methods/auth_sendInvites.md | 18 ++--- old_docs/API_docs_v23/methods/auth_sendSms.md | 4 +- .../API_docs_v23/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getSuggested.md | 2 +- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../API_docs_v23/methods/contacts_search.md | 22 +++--- .../API_docs_v23/methods/contacts_unblock.md | 14 ++-- .../API_docs_v23/methods/help_getAppUpdate.md | 8 +-- .../API_docs_v23/methods/help_getConfig.md | 14 ++-- .../methods/help_getInviteText.md | 2 +- .../API_docs_v23/methods/help_saveAppLog.md | 2 +- .../API_docs_v23/methods/initConnection.md | 28 ++++---- .../API_docs_v23/methods/invokeAfterMsg.md | 4 +- .../API_docs_v23/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v23/methods/invokeWithLayer.md | 38 +++++----- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 16 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 58 +++++++-------- .../methods/messages_getAllStickers.md | 2 +- .../API_docs_v23/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 26 +++---- .../methods/messages_getHistory.md | 30 ++++---- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getStickers.md | 4 +- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 22 +++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reportSpam.md | 14 ++-- .../API_docs_v23/methods/messages_search.md | 40 +++++------ .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendMedia.md | 56 +++++++-------- .../methods/messages_sendMessage.md | 56 +++++++-------- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setTyping.md | 30 ++++---- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v23/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 28 ++++---- .../methods/account_sendChangePhoneCode.md | 16 ++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPassword.md | 8 +-- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updateProfile.md | 20 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v25/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v25/methods/auth_sendCall.md | 4 +- .../API_docs_v25/methods/auth_sendInvites.md | 18 ++--- old_docs/API_docs_v25/methods/auth_sendSms.md | 4 +- .../API_docs_v25/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getSuggested.md | 2 +- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../API_docs_v25/methods/contacts_search.md | 22 +++--- .../API_docs_v25/methods/contacts_unblock.md | 14 ++-- .../API_docs_v25/methods/geochats_checkin.md | 2 +- .../methods/geochats_createGeoChat.md | 8 +-- .../methods/geochats_editChatPhoto.md | 4 +- .../methods/geochats_editChatTitle.md | 6 +- .../methods/geochats_getFullChat.md | 2 +- .../methods/geochats_getHistory.md | 8 +-- .../methods/geochats_getLocated.md | 6 +- .../methods/geochats_getRecents.md | 4 +- .../API_docs_v25/methods/geochats_search.md | 16 ++--- .../methods/geochats_sendMedia.md | 2 +- .../methods/geochats_sendMessage.md | 4 +- .../methods/geochats_setTyping.md | 4 +- .../API_docs_v25/methods/help_getAppUpdate.md | 8 +-- .../API_docs_v25/methods/help_getConfig.md | 14 ++-- .../methods/help_getInviteText.md | 2 +- .../API_docs_v25/methods/help_saveAppLog.md | 2 +- .../API_docs_v25/methods/initConnection.md | 28 ++++---- .../API_docs_v25/methods/invokeAfterMsg.md | 4 +- .../API_docs_v25/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v25/methods/invokeWithLayer.md | 38 +++++----- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 16 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 58 +++++++-------- .../methods/messages_getAllStickers.md | 2 +- .../API_docs_v25/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 26 +++---- .../methods/messages_getHistory.md | 30 ++++---- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getStickers.md | 4 +- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 20 +++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../API_docs_v25/methods/messages_search.md | 40 +++++------ .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendMedia.md | 58 +++++++-------- .../methods/messages_sendMessage.md | 58 +++++++-------- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setTyping.md | 30 ++++---- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v25/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 28 ++++---- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 16 ++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 20 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v27/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v27/methods/auth_sendCall.md | 4 +- .../API_docs_v27/methods/auth_sendInvites.md | 18 ++--- old_docs/API_docs_v27/methods/auth_sendSms.md | 4 +- .../API_docs_v27/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getSuggested.md | 2 +- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../API_docs_v27/methods/contacts_search.md | 22 +++--- .../API_docs_v27/methods/contacts_unblock.md | 14 ++-- .../API_docs_v27/methods/geochats_checkin.md | 2 +- .../methods/geochats_createGeoChat.md | 8 +-- .../methods/geochats_editChatPhoto.md | 4 +- .../methods/geochats_editChatTitle.md | 6 +- .../methods/geochats_getFullChat.md | 2 +- .../methods/geochats_getHistory.md | 8 +-- .../methods/geochats_getLocated.md | 6 +- .../methods/geochats_getRecents.md | 4 +- .../API_docs_v27/methods/geochats_search.md | 16 ++--- .../methods/geochats_sendMedia.md | 2 +- .../methods/geochats_sendMessage.md | 4 +- .../methods/geochats_setTyping.md | 4 +- .../API_docs_v27/methods/help_getAppUpdate.md | 8 +-- .../API_docs_v27/methods/help_getConfig.md | 14 ++-- .../methods/help_getInviteText.md | 2 +- .../API_docs_v27/methods/help_saveAppLog.md | 2 +- .../API_docs_v27/methods/initConnection.md | 28 ++++---- .../API_docs_v27/methods/invokeAfterMsg.md | 4 +- .../API_docs_v27/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v27/methods/invokeWithLayer.md | 38 +++++----- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 16 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 58 +++++++-------- .../methods/messages_getAllStickers.md | 2 +- .../API_docs_v27/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 26 +++---- .../methods/messages_getHistory.md | 30 ++++---- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getStickers.md | 4 +- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 20 +++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../API_docs_v27/methods/messages_search.md | 40 +++++------ .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendMedia.md | 58 +++++++-------- .../methods/messages_sendMessage.md | 58 +++++++-------- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setTyping.md | 30 ++++---- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v27/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 28 ++++---- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 16 ++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 20 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v33/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v33/methods/auth_sendCall.md | 4 +- .../API_docs_v33/methods/auth_sendInvites.md | 18 ++--- old_docs/API_docs_v33/methods/auth_sendSms.md | 4 +- .../API_docs_v33/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getSuggested.md | 2 +- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../API_docs_v33/methods/contacts_search.md | 22 +++--- .../API_docs_v33/methods/contacts_unblock.md | 14 ++-- .../API_docs_v33/methods/geochats_checkin.md | 2 +- .../methods/geochats_createGeoChat.md | 8 +-- .../methods/geochats_editChatPhoto.md | 4 +- .../methods/geochats_editChatTitle.md | 6 +- .../methods/geochats_getFullChat.md | 2 +- .../methods/geochats_getHistory.md | 8 +-- .../methods/geochats_getLocated.md | 6 +- .../methods/geochats_getRecents.md | 4 +- .../API_docs_v33/methods/geochats_search.md | 16 ++--- .../methods/geochats_sendMedia.md | 2 +- .../methods/geochats_sendMessage.md | 4 +- .../methods/geochats_setTyping.md | 4 +- .../methods/help_getAppChangelog.md | 8 +-- .../API_docs_v33/methods/help_getAppUpdate.md | 8 +-- .../API_docs_v33/methods/help_getConfig.md | 14 ++-- .../methods/help_getInviteText.md | 2 +- .../API_docs_v33/methods/help_saveAppLog.md | 2 +- .../API_docs_v33/methods/initConnection.md | 28 ++++---- .../API_docs_v33/methods/invokeAfterMsg.md | 4 +- .../API_docs_v33/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v33/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 16 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 58 +++++++-------- .../methods/messages_getAllStickers.md | 2 +- .../API_docs_v33/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 26 +++---- .../methods/messages_getHistory.md | 30 ++++---- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getStickers.md | 4 +- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 20 +++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../API_docs_v33/methods/messages_search.md | 40 +++++------ .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendMedia.md | 60 ++++++++-------- .../methods/messages_sendMessage.md | 60 ++++++++-------- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v33/methods/messages_startBot.md | 22 +++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v33/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 28 ++++---- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 16 ++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 20 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v38/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v38/methods/auth_sendCall.md | 4 +- .../API_docs_v38/methods/auth_sendInvites.md | 18 ++--- old_docs/API_docs_v38/methods/auth_sendSms.md | 4 +- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 20 +++--- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getDialogs.md | 4 +- .../methods/channels_getImportantHistory.md | 10 +-- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_kickFromChannel.md | 2 +- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleComments.md | 2 +- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v38/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getSuggested.md | 2 +- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../API_docs_v38/methods/contacts_search.md | 22 +++--- .../API_docs_v38/methods/contacts_unblock.md | 14 ++-- .../methods/help_getAppChangelog.md | 8 +-- .../API_docs_v38/methods/help_getAppUpdate.md | 8 +-- .../API_docs_v38/methods/help_getConfig.md | 14 ++-- .../methods/help_getInviteText.md | 2 +- .../API_docs_v38/methods/help_saveAppLog.md | 2 +- .../API_docs_v38/methods/initConnection.md | 28 ++++---- .../API_docs_v38/methods/invokeAfterMsg.md | 4 +- .../API_docs_v38/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v38/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 16 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 58 +++++++-------- .../methods/messages_getAllStickers.md | 2 +- .../API_docs_v38/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 24 +++---- .../methods/messages_getHistory.md | 34 ++++----- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getStickers.md | 4 +- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 20 +++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reportSpam.md | 14 ++-- .../API_docs_v38/methods/messages_search.md | 40 +++++------ .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendMedia.md | 60 ++++++++-------- .../methods/messages_sendMessage.md | 62 ++++++++-------- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v38/methods/messages_startBot.md | 22 +++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v38/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 28 ++++---- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 16 ++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 20 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v40/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v40/methods/auth_sendCall.md | 4 +- .../API_docs_v40/methods/auth_sendInvites.md | 18 ++--- old_docs/API_docs_v40/methods/auth_sendSms.md | 4 +- .../API_docs_v40/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getSuggested.md | 2 +- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../API_docs_v40/methods/contacts_search.md | 22 +++--- .../API_docs_v40/methods/contacts_unblock.md | 14 ++-- .../methods/help_getAppChangelog.md | 8 +-- .../API_docs_v40/methods/help_getAppUpdate.md | 8 +-- .../API_docs_v40/methods/help_getConfig.md | 14 ++-- .../methods/help_getInviteText.md | 2 +- .../API_docs_v40/methods/help_saveAppLog.md | 2 +- .../API_docs_v40/methods/initConnection.md | 28 ++++---- .../API_docs_v40/methods/invokeAfterMsg.md | 4 +- .../API_docs_v40/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v40/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_createChannel.md | 2 +- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChannelMessages.md | 2 +- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 16 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 58 +++++++-------- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getChannelDialogs.md | 4 +- .../API_docs_v40/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 24 +++---- .../methods/messages_getHistory.md | 32 ++++----- .../methods/messages_getImportantHistory.md | 6 +- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getStickers.md | 4 +- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_readChannelHistory.md | 2 +- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 20 +++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../API_docs_v40/methods/messages_search.md | 40 +++++------ .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendMedia.md | 60 ++++++++-------- .../methods/messages_sendMessage.md | 62 ++++++++-------- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v40/methods/messages_startBot.md | 22 +++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v40/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 28 ++++---- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 16 ++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 20 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v41/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v41/methods/auth_sendCall.md | 4 +- .../API_docs_v41/methods/auth_sendInvites.md | 18 ++--- old_docs/API_docs_v41/methods/auth_sendSms.md | 4 +- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getDialogs.md | 4 +- .../methods/channels_getImportantHistory.md | 10 +-- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_kickFromChannel.md | 2 +- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleComments.md | 2 +- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v41/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getSuggested.md | 2 +- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../API_docs_v41/methods/contacts_search.md | 22 +++--- .../API_docs_v41/methods/contacts_unblock.md | 14 ++-- .../methods/help_getAppChangelog.md | 8 +-- .../API_docs_v41/methods/help_getAppUpdate.md | 8 +-- .../API_docs_v41/methods/help_getConfig.md | 14 ++-- .../methods/help_getInviteText.md | 2 +- .../API_docs_v41/methods/help_saveAppLog.md | 2 +- .../API_docs_v41/methods/initConnection.md | 28 ++++---- .../API_docs_v41/methods/invokeAfterMsg.md | 4 +- .../API_docs_v41/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v41/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deactivateChat.md | 2 +- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 16 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 60 ++++++++-------- .../methods/messages_getAllStickers.md | 2 +- .../API_docs_v41/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 24 +++---- .../methods/messages_getHistory.md | 34 ++++----- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getStickers.md | 4 +- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reportSpam.md | 14 ++-- .../API_docs_v41/methods/messages_search.md | 42 +++++------ .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendMedia.md | 62 ++++++++-------- .../methods/messages_sendMessage.md | 66 ++++++++--------- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v41/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v41/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 28 ++++---- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 16 ++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 20 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v42/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v42/methods/auth_sendCall.md | 4 +- .../API_docs_v42/methods/auth_sendInvites.md | 18 ++--- old_docs/API_docs_v42/methods/auth_sendSms.md | 4 +- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getDialogs.md | 4 +- .../methods/channels_getImportantHistory.md | 10 +-- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_kickFromChannel.md | 2 +- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleComments.md | 2 +- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v42/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getSuggested.md | 2 +- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../API_docs_v42/methods/contacts_search.md | 22 +++--- .../API_docs_v42/methods/contacts_unblock.md | 14 ++-- .../methods/help_getAppChangelog.md | 8 +-- .../API_docs_v42/methods/help_getAppUpdate.md | 8 +-- .../API_docs_v42/methods/help_getConfig.md | 14 ++-- .../methods/help_getInviteText.md | 2 +- .../API_docs_v42/methods/help_saveAppLog.md | 2 +- .../API_docs_v42/methods/initConnection.md | 28 ++++---- .../API_docs_v42/methods/invokeAfterMsg.md | 4 +- .../API_docs_v42/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v42/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 16 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 60 ++++++++-------- .../methods/messages_getAllStickers.md | 2 +- .../API_docs_v42/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 26 +++---- .../methods/messages_getHistory.md | 34 ++++----- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getStickers.md | 4 +- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reportSpam.md | 14 ++-- .../API_docs_v42/methods/messages_search.md | 42 +++++------ .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendMedia.md | 62 ++++++++-------- .../methods/messages_sendMessage.md | 66 ++++++++--------- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v42/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v42/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 28 ++++---- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 16 ++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 20 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v44/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v44/methods/auth_sendCall.md | 4 +- .../API_docs_v44/methods/auth_sendInvites.md | 18 ++--- old_docs/API_docs_v44/methods/auth_sendSms.md | 4 +- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getDialogs.md | 4 +- .../methods/channels_getImportantHistory.md | 10 +-- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_kickFromChannel.md | 2 +- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleComments.md | 2 +- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v44/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getSuggested.md | 2 +- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../API_docs_v44/methods/contacts_search.md | 22 +++--- .../API_docs_v44/methods/contacts_unblock.md | 14 ++-- .../methods/help_getAppChangelog.md | 8 +-- .../API_docs_v44/methods/help_getAppUpdate.md | 8 +-- .../API_docs_v44/methods/help_getConfig.md | 14 ++-- .../methods/help_getInviteText.md | 2 +- .../methods/help_getTermsOfService.md | 2 +- .../API_docs_v44/methods/help_saveAppLog.md | 2 +- .../API_docs_v44/methods/initConnection.md | 28 ++++---- .../API_docs_v44/methods/invokeAfterMsg.md | 4 +- .../API_docs_v44/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v44/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 16 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 60 ++++++++-------- .../methods/messages_getAllStickers.md | 2 +- .../API_docs_v44/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 26 +++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getHistory.md | 34 ++++----- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getStickers.md | 4 +- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderStickerSets.md | 2 +- .../methods/messages_reportSpam.md | 14 ++-- .../API_docs_v44/methods/messages_search.md | 42 +++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendMedia.md | 62 ++++++++-------- .../methods/messages_sendMessage.md | 66 ++++++++--------- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v44/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v44/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 28 ++++---- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 16 ++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 20 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v45/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v45/methods/auth_sendCall.md | 4 +- .../API_docs_v45/methods/auth_sendInvites.md | 18 ++--- old_docs/API_docs_v45/methods/auth_sendSms.md | 4 +- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getDialogs.md | 4 +- .../methods/channels_getImportantHistory.md | 10 +-- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_kickFromChannel.md | 2 +- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleComments.md | 2 +- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v45/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getSuggested.md | 2 +- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../API_docs_v45/methods/contacts_search.md | 22 +++--- .../API_docs_v45/methods/contacts_unblock.md | 14 ++-- .../methods/help_getAppChangelog.md | 8 +-- .../API_docs_v45/methods/help_getAppUpdate.md | 8 +-- .../API_docs_v45/methods/help_getConfig.md | 14 ++-- .../methods/help_getInviteText.md | 2 +- .../methods/help_getTermsOfService.md | 2 +- .../API_docs_v45/methods/help_saveAppLog.md | 2 +- .../API_docs_v45/methods/initConnection.md | 28 ++++---- .../API_docs_v45/methods/invokeAfterMsg.md | 4 +- .../API_docs_v45/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v45/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 16 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 60 ++++++++-------- .../methods/messages_getAllStickers.md | 2 +- .../API_docs_v45/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 26 +++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getHistory.md | 34 ++++----- .../methods/messages_getInlineBotResults.md | 24 +++---- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getStickers.md | 4 +- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderStickerSets.md | 2 +- .../methods/messages_reportSpam.md | 14 ++-- .../API_docs_v45/methods/messages_saveGif.md | 16 ++--- .../API_docs_v45/methods/messages_search.md | 42 +++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 32 ++++----- .../methods/messages_sendMedia.md | 62 ++++++++-------- .../methods/messages_sendMessage.md | 66 ++++++++--------- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setInlineBotResults.md | 46 ++++++------ .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v45/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v45/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 28 ++++---- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 16 ++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 20 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v46/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v46/methods/auth_sendCall.md | 4 +- .../API_docs_v46/methods/auth_sendInvites.md | 18 ++--- old_docs/API_docs_v46/methods/auth_sendSms.md | 4 +- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getDialogs.md | 4 +- .../methods/channels_getImportantHistory.md | 10 +-- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_kickFromChannel.md | 2 +- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleComments.md | 2 +- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v46/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getSuggested.md | 2 +- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../API_docs_v46/methods/contacts_search.md | 22 +++--- .../API_docs_v46/methods/contacts_unblock.md | 14 ++-- .../methods/help_getAppChangelog.md | 8 +-- .../API_docs_v46/methods/help_getAppUpdate.md | 8 +-- .../API_docs_v46/methods/help_getConfig.md | 14 ++-- .../methods/help_getInviteText.md | 2 +- .../methods/help_getTermsOfService.md | 2 +- .../API_docs_v46/methods/help_saveAppLog.md | 2 +- .../API_docs_v46/methods/initConnection.md | 28 ++++---- .../API_docs_v46/methods/invokeAfterMsg.md | 4 +- .../API_docs_v46/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v46/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 16 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 60 ++++++++-------- .../methods/messages_getAllStickers.md | 2 +- .../API_docs_v46/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 26 +++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getHistory.md | 34 ++++----- .../methods/messages_getInlineBotResults.md | 24 +++---- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getStickers.md | 4 +- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderStickerSets.md | 2 +- .../methods/messages_reportSpam.md | 14 ++-- .../API_docs_v46/methods/messages_saveGif.md | 16 ++--- .../API_docs_v46/methods/messages_search.md | 42 +++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 32 ++++----- .../methods/messages_sendMedia.md | 62 ++++++++-------- .../methods/messages_sendMessage.md | 66 ++++++++--------- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setInlineBotResults.md | 46 ++++++------ .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v46/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v46/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 28 ++++---- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 20 +++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 22 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v51/methods/auth_cancelCode.md | 18 ++--- .../API_docs_v51/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../API_docs_v51/methods/auth_resendCode.md | 18 ++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v51/methods/auth_sendInvites.md | 18 ++--- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_exportMessageLink.md | 16 ++--- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getDialogs.md | 4 +- .../methods/channels_getImportantHistory.md | 12 ++-- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_kickFromChannel.md | 2 +- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleComments.md | 2 +- .../methods/channels_toggleInvites.md | 20 +++--- .../methods/channels_toggleSignatures.md | 16 ++--- .../methods/channels_updatePinnedMessage.md | 24 +++---- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v51/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../API_docs_v51/methods/contacts_search.md | 22 +++--- .../API_docs_v51/methods/contacts_unblock.md | 14 ++-- .../methods/help_getAppChangelog.md | 8 +-- .../API_docs_v51/methods/help_getAppUpdate.md | 8 +-- .../API_docs_v51/methods/help_getConfig.md | 14 ++-- .../methods/help_getInviteText.md | 2 +- .../methods/help_getTermsOfService.md | 2 +- .../API_docs_v51/methods/help_saveAppLog.md | 2 +- .../API_docs_v51/methods/initConnection.md | 28 ++++---- .../API_docs_v51/methods/invokeAfterMsg.md | 4 +- .../API_docs_v51/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v51/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 16 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_editInlineBotMessage.md | 26 +++---- .../methods/messages_editMessage.md | 42 +++++------ .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 64 ++++++++--------- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getBotCallbackAnswer.md | 26 +++---- .../API_docs_v51/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 26 +++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getHistory.md | 36 +++++----- .../methods/messages_getInlineBotResults.md | 26 +++---- .../methods/messages_getMessageEditData.md | 18 ++--- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getPeerSettings.md | 16 ++--- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getStickers.md | 4 +- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_hideReportSpam.md | 14 ++-- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderStickerSets.md | 2 +- .../methods/messages_reportSpam.md | 14 ++-- .../API_docs_v51/methods/messages_saveGif.md | 16 ++--- .../API_docs_v51/methods/messages_search.md | 42 +++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 36 +++++----- .../methods/messages_sendMedia.md | 66 ++++++++--------- .../methods/messages_sendMessage.md | 70 +++++++++---------- .../methods/messages_setBotCallbackAnswer.md | 20 +++--- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setInlineBotResults.md | 48 ++++++------- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v51/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v51/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 18 ++--- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 20 +++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 22 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v53/methods/auth_cancelCode.md | 18 ++--- .../API_docs_v53/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../API_docs_v53/methods/auth_resendCode.md | 18 ++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v53/methods/auth_sendInvites.md | 18 ++--- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_exportMessageLink.md | 16 ++--- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_kickFromChannel.md | 2 +- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleInvites.md | 20 +++--- .../methods/channels_toggleSignatures.md | 16 ++--- .../methods/channels_updatePinnedMessage.md | 24 +++---- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v53/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getTopPeers.md | 30 ++++---- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../methods/contacts_resetTopPeerRating.md | 16 ++--- .../API_docs_v53/methods/contacts_search.md | 22 +++--- .../API_docs_v53/methods/contacts_unblock.md | 14 ++-- .../API_docs_v53/methods/help_getConfig.md | 14 ++-- .../API_docs_v53/methods/help_saveAppLog.md | 2 +- .../API_docs_v53/methods/initConnection.md | 28 ++++---- .../API_docs_v53/methods/invokeAfterMsg.md | 4 +- .../API_docs_v53/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v53/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 18 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_editInlineBotMessage.md | 26 +++---- .../methods/messages_editMessage.md | 42 +++++------ .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 62 ++++++++-------- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getBotCallbackAnswer.md | 26 +++---- .../API_docs_v53/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 26 +++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getHistory.md | 36 +++++----- .../methods/messages_getInlineBotResults.md | 26 +++---- .../methods/messages_getMessageEditData.md | 18 ++--- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getPeerDialogs.md | 16 ++--- .../methods/messages_getPeerSettings.md | 16 ++--- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getStickers.md | 4 +- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_hideReportSpam.md | 14 ++-- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderStickerSets.md | 2 +- .../methods/messages_reportSpam.md | 14 ++-- .../methods/messages_saveDraft.md | 22 +++--- .../API_docs_v53/methods/messages_saveGif.md | 16 ++--- .../API_docs_v53/methods/messages_search.md | 40 +++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 36 +++++----- .../methods/messages_sendMedia.md | 66 ++++++++--------- .../methods/messages_sendMessage.md | 70 +++++++++---------- .../methods/messages_setBotCallbackAnswer.md | 20 +++--- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setInlineBotResults.md | 48 ++++++------- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v53/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v53/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_confirmPhone.md | 20 +++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 18 ++--- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 20 +++--- .../methods/account_sendConfirmPhoneCode.md | 20 +++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 22 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v55/methods/auth_cancelCode.md | 18 ++--- .../API_docs_v55/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../API_docs_v55/methods/auth_resendCode.md | 18 ++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v55/methods/auth_sendInvites.md | 18 ++--- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_exportMessageLink.md | 16 ++--- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_kickFromChannel.md | 2 +- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleInvites.md | 20 +++--- .../methods/channels_toggleSignatures.md | 16 ++--- .../methods/channels_updatePinnedMessage.md | 24 +++---- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v55/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getTopPeers.md | 30 ++++---- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../methods/contacts_resetTopPeerRating.md | 16 ++--- .../API_docs_v55/methods/contacts_search.md | 22 +++--- .../API_docs_v55/methods/contacts_unblock.md | 14 ++-- .../API_docs_v55/methods/help_getConfig.md | 14 ++-- .../API_docs_v55/methods/help_saveAppLog.md | 2 +- .../API_docs_v55/methods/initConnection.md | 28 ++++---- .../API_docs_v55/methods/invokeAfterMsg.md | 4 +- .../API_docs_v55/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v55/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 18 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_editInlineBotMessage.md | 26 +++---- .../methods/messages_editMessage.md | 42 +++++------ .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 62 ++++++++-------- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getArchivedStickers.md | 4 +- .../methods/messages_getBotCallbackAnswer.md | 26 +++---- .../API_docs_v55/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 26 +++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getFeaturedStickers.md | 2 +- .../methods/messages_getHistory.md | 36 +++++----- .../methods/messages_getInlineBotResults.md | 26 +++---- .../methods/messages_getMessageEditData.md | 18 ++--- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getPeerDialogs.md | 16 ++--- .../methods/messages_getPeerSettings.md | 16 ++--- .../methods/messages_getRecentStickers.md | 2 +- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getStickers.md | 4 +- .../methods/messages_getUnusedStickers.md | 2 +- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_hideReportSpam.md | 14 ++-- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderStickerSets.md | 2 +- .../methods/messages_reportSpam.md | 14 ++-- .../methods/messages_saveDraft.md | 22 +++--- .../API_docs_v55/methods/messages_saveGif.md | 16 ++--- .../methods/messages_saveRecentSticker.md | 16 ++--- .../API_docs_v55/methods/messages_search.md | 40 +++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendBroadcast.md | 2 +- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 36 +++++----- .../methods/messages_sendMedia.md | 66 ++++++++--------- .../methods/messages_sendMessage.md | 70 +++++++++---------- .../methods/messages_setBotCallbackAnswer.md | 22 +++--- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setInlineBotResults.md | 48 ++++++------- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v55/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_updateProfilePhoto.md | 2 +- .../methods/photos_uploadProfilePhoto.md | 26 +++---- .../API_docs_v55/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_confirmPhone.md | 20 +++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 18 ++--- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 20 +++--- .../methods/account_sendConfirmPhoneCode.md | 20 +++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 22 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v57/methods/auth_cancelCode.md | 18 ++--- .../API_docs_v57/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_dropTempAuthKeys.md | 2 +- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../API_docs_v57/methods/auth_resendCode.md | 18 ++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v57/methods/auth_sendInvites.md | 18 ++--- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_exportMessageLink.md | 16 ++--- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_kickFromChannel.md | 2 +- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleInvites.md | 20 +++--- .../methods/channels_toggleSignatures.md | 16 ++--- .../methods/channels_updatePinnedMessage.md | 24 +++---- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v57/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getTopPeers.md | 30 ++++---- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../methods/contacts_resetTopPeerRating.md | 16 ++--- .../API_docs_v57/methods/contacts_search.md | 22 +++--- .../API_docs_v57/methods/contacts_unblock.md | 14 ++-- .../API_docs_v57/methods/help_getConfig.md | 14 ++-- .../API_docs_v57/methods/help_saveAppLog.md | 2 +- .../API_docs_v57/methods/initConnection.md | 28 ++++---- .../API_docs_v57/methods/invokeAfterMsg.md | 4 +- .../API_docs_v57/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v57/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_clearRecentStickers.md | 2 +- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 18 ++--- .../methods/messages_deleteMessages.md | 16 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_editInlineBotMessage.md | 26 +++---- .../methods/messages_editMessage.md | 42 +++++------ .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 64 ++++++++--------- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getArchivedStickers.md | 6 +- .../methods/messages_getAttachedStickers.md | 2 +- .../methods/messages_getBotCallbackAnswer.md | 28 ++++---- .../API_docs_v57/methods/messages_getChats.md | 18 ++--- .../methods/messages_getDialogs.md | 26 +++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getFeaturedStickers.md | 2 +- .../methods/messages_getGameHighScores.md | 18 ++--- .../methods/messages_getHistory.md | 36 +++++----- .../methods/messages_getInlineBotResults.md | 26 +++---- .../messages_getInlineGameHighScores.md | 18 ++--- .../methods/messages_getMaskStickers.md | 2 +- .../methods/messages_getMessageEditData.md | 18 ++--- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getPeerDialogs.md | 16 ++--- .../methods/messages_getPeerSettings.md | 16 ++--- .../methods/messages_getRecentStickers.md | 4 +- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_hideReportSpam.md | 14 ++-- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readFeaturedStickers.md | 2 +- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderStickerSets.md | 4 +- .../methods/messages_reportSpam.md | 14 ++-- .../methods/messages_saveDraft.md | 22 +++--- .../API_docs_v57/methods/messages_saveGif.md | 16 ++--- .../methods/messages_saveRecentSticker.md | 18 ++--- .../API_docs_v57/methods/messages_search.md | 40 +++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 36 +++++----- .../methods/messages_sendMedia.md | 66 ++++++++--------- .../methods/messages_sendMessage.md | 70 +++++++++---------- .../methods/messages_setBotCallbackAnswer.md | 22 +++--- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setGameScore.md | 22 +++--- .../methods/messages_setInlineBotResults.md | 48 ++++++------- .../methods/messages_setInlineGameScore.md | 22 +++--- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v57/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_uploadProfilePhoto.md | 20 +++--- .../API_docs_v57/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_confirmPhone.md | 20 +++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_registerDevice.md | 18 ++--- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 20 +++--- .../methods/account_sendConfirmPhoneCode.md | 20 +++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 22 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v62/methods/auth_cancelCode.md | 18 ++--- .../API_docs_v62/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_dropTempAuthKeys.md | 2 +- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../API_docs_v62/methods/auth_resendCode.md | 18 ++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v62/methods/auth_sendInvites.md | 18 ++--- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_exportMessageLink.md | 16 ++--- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_kickFromChannel.md | 2 +- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleInvites.md | 20 +++--- .../methods/channels_toggleSignatures.md | 16 ++--- .../methods/channels_updatePinnedMessage.md | 24 +++---- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v62/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getTopPeers.md | 30 ++++---- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../methods/contacts_resetTopPeerRating.md | 16 ++--- .../API_docs_v62/methods/contacts_search.md | 22 +++--- .../API_docs_v62/methods/contacts_unblock.md | 14 ++-- .../API_docs_v62/methods/help_getConfig.md | 14 ++-- .../API_docs_v62/methods/help_saveAppLog.md | 2 +- .../methods/help_setBotUpdatesStatus.md | 4 +- .../API_docs_v62/methods/initConnection.md | 28 ++++---- .../API_docs_v62/methods/invokeAfterMsg.md | 4 +- .../API_docs_v62/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v62/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_clearRecentStickers.md | 2 +- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 18 ++--- .../methods/messages_deleteMessages.md | 18 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_editInlineBotMessage.md | 26 +++---- .../methods/messages_editMessage.md | 42 +++++------ .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 64 ++++++++--------- .../methods/messages_getAllChats.md | 2 +- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getArchivedStickers.md | 6 +- .../methods/messages_getAttachedStickers.md | 2 +- .../methods/messages_getBotCallbackAnswer.md | 28 ++++---- .../API_docs_v62/methods/messages_getChats.md | 18 ++--- .../methods/messages_getCommonChats.md | 18 ++--- .../methods/messages_getDialogs.md | 28 ++++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getFeaturedStickers.md | 2 +- .../methods/messages_getGameHighScores.md | 18 ++--- .../methods/messages_getHistory.md | 36 +++++----- .../methods/messages_getInlineBotResults.md | 26 +++---- .../messages_getInlineGameHighScores.md | 18 ++--- .../methods/messages_getMaskStickers.md | 2 +- .../methods/messages_getMessageEditData.md | 18 ++--- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getPeerDialogs.md | 16 ++--- .../methods/messages_getPeerSettings.md | 16 ++--- .../methods/messages_getRecentStickers.md | 4 +- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getWebPage.md | 18 ++--- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_hideReportSpam.md | 14 ++-- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readFeaturedStickers.md | 2 +- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderPinnedDialogs.md | 16 ++--- .../methods/messages_reorderStickerSets.md | 4 +- .../methods/messages_reportEncryptedSpam.md | 14 ++-- .../methods/messages_reportSpam.md | 14 ++-- .../methods/messages_saveDraft.md | 22 +++--- .../API_docs_v62/methods/messages_saveGif.md | 16 ++--- .../methods/messages_saveRecentSticker.md | 18 ++--- .../API_docs_v62/methods/messages_search.md | 40 +++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 36 +++++----- .../methods/messages_sendMedia.md | 66 ++++++++--------- .../methods/messages_sendMessage.md | 70 +++++++++---------- .../methods/messages_setBotCallbackAnswer.md | 24 +++---- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setGameScore.md | 24 +++---- .../methods/messages_setInlineBotResults.md | 48 ++++++------- .../methods/messages_setInlineGameScore.md | 24 +++---- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v62/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_toggleDialogPin.md | 16 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/phone_receivedCall.md | 18 ++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_uploadProfilePhoto.md | 20 +++--- .../API_docs_v62/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_confirmPhone.md | 20 +++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_getTmpPassword.md | 20 +++--- .../methods/account_registerDevice.md | 18 ++--- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 20 +++--- .../methods/account_sendConfirmPhoneCode.md | 20 +++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 22 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v65/methods/auth_cancelCode.md | 18 ++--- .../API_docs_v65/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_dropTempAuthKeys.md | 2 +- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../API_docs_v65/methods/auth_resendCode.md | 18 ++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v65/methods/auth_sendInvites.md | 18 ++--- .../methods/bots_answerWebhookJSONQuery.md | 20 +++--- .../methods/bots_sendCustomRequest.md | 18 ++--- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_exportMessageLink.md | 16 ++--- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_kickFromChannel.md | 2 +- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleInvites.md | 20 +++--- .../methods/channels_toggleSignatures.md | 16 ++--- .../methods/channels_updatePinnedMessage.md | 24 +++---- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v65/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getTopPeers.md | 30 ++++---- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../methods/contacts_resetTopPeerRating.md | 16 ++--- .../API_docs_v65/methods/contacts_search.md | 22 +++--- .../API_docs_v65/methods/contacts_unblock.md | 14 ++-- .../methods/contest_saveDeveloperInfo.md | 10 +-- .../API_docs_v65/methods/destroy_session.md | 2 +- .../API_docs_v65/methods/get_future_salts.md | 2 +- .../methods/help_getAppChangelog.md | 2 +- .../API_docs_v65/methods/help_getConfig.md | 14 ++-- .../API_docs_v65/methods/help_saveAppLog.md | 2 +- .../methods/help_setBotUpdatesStatus.md | 4 +- .../API_docs_v65/methods/initConnection.md | 28 ++++---- .../API_docs_v65/methods/invokeAfterMsg.md | 4 +- .../API_docs_v65/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v65/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_clearRecentStickers.md | 2 +- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 18 ++--- .../methods/messages_deleteMessages.md | 18 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_editInlineBotMessage.md | 26 +++---- .../methods/messages_editMessage.md | 42 +++++------ .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 64 ++++++++--------- .../methods/messages_getAllChats.md | 2 +- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getArchivedStickers.md | 6 +- .../methods/messages_getAttachedStickers.md | 2 +- .../methods/messages_getBotCallbackAnswer.md | 28 ++++---- .../API_docs_v65/methods/messages_getChats.md | 18 ++--- .../methods/messages_getCommonChats.md | 18 ++--- .../methods/messages_getDialogs.md | 28 ++++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getFeaturedStickers.md | 2 +- .../methods/messages_getGameHighScores.md | 18 ++--- .../methods/messages_getHistory.md | 36 +++++----- .../methods/messages_getInlineBotResults.md | 26 +++---- .../messages_getInlineGameHighScores.md | 18 ++--- .../methods/messages_getMaskStickers.md | 2 +- .../methods/messages_getMessageEditData.md | 18 ++--- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getPeerDialogs.md | 16 ++--- .../methods/messages_getPeerSettings.md | 16 ++--- .../methods/messages_getRecentStickers.md | 4 +- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getWebPage.md | 18 ++--- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_hideReportSpam.md | 14 ++-- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readFeaturedStickers.md | 2 +- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderPinnedDialogs.md | 16 ++--- .../methods/messages_reorderStickerSets.md | 4 +- .../methods/messages_reportEncryptedSpam.md | 14 ++-- .../methods/messages_reportSpam.md | 14 ++-- .../methods/messages_saveDraft.md | 22 +++--- .../API_docs_v65/methods/messages_saveGif.md | 16 ++--- .../methods/messages_saveRecentSticker.md | 18 ++--- .../API_docs_v65/methods/messages_search.md | 40 +++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 36 +++++----- .../methods/messages_sendMedia.md | 66 ++++++++--------- .../methods/messages_sendMessage.md | 70 +++++++++---------- .../methods/messages_setBotCallbackAnswer.md | 24 +++---- .../messages_setBotPrecheckoutResults.md | 20 +++--- .../methods/messages_setBotShippingResults.md | 20 +++--- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setGameScore.md | 24 +++---- .../methods/messages_setInlineBotResults.md | 48 ++++++------- .../methods/messages_setInlineGameScore.md | 24 +++---- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v65/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_toggleDialogPin.md | 16 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/payments_clearSavedInfo.md | 4 +- .../methods/payments_getPaymentForm.md | 16 ++--- .../methods/payments_getPaymentReceipt.md | 16 ++--- .../methods/payments_sendPaymentForm.md | 22 +++--- .../methods/payments_validateRequestedInfo.md | 20 +++--- .../methods/phone_receivedCall.md | 18 ++--- .../methods/phone_saveCallDebug.md | 20 +++--- .../methods/phone_setCallRating.md | 20 +++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_uploadProfilePhoto.md | 20 +++--- old_docs/API_docs_v65/methods/ping.md | 2 +- .../methods/ping_delay_disconnect.md | 4 +- .../API_docs_v65/methods/req_DH_params.md | 12 ++-- old_docs/API_docs_v65/methods/req_pq.md | 2 +- .../API_docs_v65/methods/rpc_drop_answer.md | 2 +- .../methods/set_client_DH_params.md | 6 +- .../API_docs_v65/methods/upload_getWebFile.md | 20 +++--- .../API_docs_v65/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_confirmPhone.md | 20 +++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_getTmpPassword.md | 20 +++--- .../methods/account_registerDevice.md | 18 ++--- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 20 +++--- .../methods/account_sendConfirmPhoneCode.md | 20 +++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 22 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v66/methods/auth_cancelCode.md | 18 ++--- .../API_docs_v66/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_dropTempAuthKeys.md | 2 +- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../API_docs_v66/methods/auth_resendCode.md | 18 ++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v66/methods/auth_sendInvites.md | 18 ++--- .../methods/bots_answerWebhookJSONQuery.md | 20 +++--- .../methods/bots_sendCustomRequest.md | 18 ++--- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_exportMessageLink.md | 16 ++--- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_kickFromChannel.md | 2 +- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleInvites.md | 20 +++--- .../methods/channels_toggleSignatures.md | 16 ++--- .../methods/channels_updatePinnedMessage.md | 24 +++---- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v66/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getTopPeers.md | 30 ++++---- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../methods/contacts_resetTopPeerRating.md | 16 ++--- .../API_docs_v66/methods/contacts_search.md | 22 +++--- .../API_docs_v66/methods/contacts_unblock.md | 14 ++-- .../methods/contest_saveDeveloperInfo.md | 10 +-- .../API_docs_v66/methods/destroy_session.md | 2 +- .../API_docs_v66/methods/get_future_salts.md | 2 +- .../methods/help_getAppChangelog.md | 2 +- .../API_docs_v66/methods/help_getCdnConfig.md | 14 ++-- .../API_docs_v66/methods/help_getConfig.md | 14 ++-- .../API_docs_v66/methods/help_saveAppLog.md | 2 +- .../methods/help_setBotUpdatesStatus.md | 4 +- .../API_docs_v66/methods/initConnection.md | 28 ++++---- .../API_docs_v66/methods/invokeAfterMsg.md | 4 +- .../API_docs_v66/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v66/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_clearRecentStickers.md | 2 +- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 18 ++--- .../methods/messages_deleteMessages.md | 18 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_editInlineBotMessage.md | 26 +++---- .../methods/messages_editMessage.md | 42 +++++------ .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 64 ++++++++--------- .../methods/messages_getAllChats.md | 2 +- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getArchivedStickers.md | 6 +- .../methods/messages_getAttachedStickers.md | 2 +- .../methods/messages_getBotCallbackAnswer.md | 28 ++++---- .../API_docs_v66/methods/messages_getChats.md | 18 ++--- .../methods/messages_getCommonChats.md | 18 ++--- .../methods/messages_getDialogs.md | 28 ++++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getFeaturedStickers.md | 2 +- .../methods/messages_getGameHighScores.md | 18 ++--- .../methods/messages_getHistory.md | 36 +++++----- .../methods/messages_getInlineBotResults.md | 26 +++---- .../messages_getInlineGameHighScores.md | 18 ++--- .../methods/messages_getMaskStickers.md | 2 +- .../methods/messages_getMessageEditData.md | 18 ++--- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getPeerDialogs.md | 16 ++--- .../methods/messages_getPeerSettings.md | 16 ++--- .../methods/messages_getRecentStickers.md | 4 +- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getWebPage.md | 18 ++--- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_hideReportSpam.md | 14 ++-- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readFeaturedStickers.md | 2 +- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderPinnedDialogs.md | 16 ++--- .../methods/messages_reorderStickerSets.md | 4 +- .../methods/messages_reportEncryptedSpam.md | 14 ++-- .../methods/messages_reportSpam.md | 14 ++-- .../methods/messages_saveDraft.md | 22 +++--- .../API_docs_v66/methods/messages_saveGif.md | 16 ++--- .../methods/messages_saveRecentSticker.md | 18 ++--- .../API_docs_v66/methods/messages_search.md | 40 +++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 36 +++++----- .../methods/messages_sendMedia.md | 66 ++++++++--------- .../methods/messages_sendMessage.md | 70 +++++++++---------- .../methods/messages_setBotCallbackAnswer.md | 24 +++---- .../messages_setBotPrecheckoutResults.md | 20 +++--- .../methods/messages_setBotShippingResults.md | 20 +++--- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setGameScore.md | 24 +++---- .../methods/messages_setInlineBotResults.md | 48 ++++++------- .../methods/messages_setInlineGameScore.md | 24 +++---- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v66/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_toggleDialogPin.md | 16 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/payments_clearSavedInfo.md | 4 +- .../methods/payments_getPaymentForm.md | 16 ++--- .../methods/payments_getPaymentReceipt.md | 16 ++--- .../methods/payments_sendPaymentForm.md | 22 +++--- .../methods/payments_validateRequestedInfo.md | 20 +++--- .../methods/phone_receivedCall.md | 18 ++--- .../methods/phone_saveCallDebug.md | 20 +++--- .../methods/phone_setCallRating.md | 20 +++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_uploadProfilePhoto.md | 20 +++--- old_docs/API_docs_v66/methods/ping.md | 2 +- .../methods/ping_delay_disconnect.md | 4 +- .../API_docs_v66/methods/req_DH_params.md | 12 ++-- old_docs/API_docs_v66/methods/req_pq.md | 2 +- .../API_docs_v66/methods/rpc_drop_answer.md | 2 +- .../methods/set_client_DH_params.md | 6 +- .../API_docs_v66/methods/upload_getWebFile.md | 20 +++--- .../API_docs_v66/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_confirmPhone.md | 20 +++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_getTmpPassword.md | 20 +++--- .../methods/account_registerDevice.md | 18 ++--- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 20 +++--- .../methods/account_sendConfirmPhoneCode.md | 20 +++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 22 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v68/methods/auth_cancelCode.md | 18 ++--- .../API_docs_v68/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_dropTempAuthKeys.md | 2 +- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../API_docs_v68/methods/auth_resendCode.md | 18 ++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v68/methods/auth_sendInvites.md | 18 ++--- .../methods/bots_answerWebhookJSONQuery.md | 20 +++--- .../methods/bots_sendCustomRequest.md | 18 ++--- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editBanned.md | 24 +++---- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_exportMessageLink.md | 16 ++--- .../methods/channels_getAdminLog.md | 28 ++++---- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleInvites.md | 20 +++--- .../methods/channels_toggleSignatures.md | 16 ++--- .../methods/channels_updatePinnedMessage.md | 24 +++---- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v68/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getTopPeers.md | 32 ++++----- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../methods/contacts_resetTopPeerRating.md | 16 ++--- .../API_docs_v68/methods/contacts_search.md | 22 +++--- .../API_docs_v68/methods/contacts_unblock.md | 14 ++-- .../methods/contest_saveDeveloperInfo.md | 10 +-- .../API_docs_v68/methods/destroy_session.md | 2 +- .../API_docs_v68/methods/get_future_salts.md | 2 +- .../methods/help_getAppChangelog.md | 2 +- .../API_docs_v68/methods/help_getCdnConfig.md | 14 ++-- .../API_docs_v68/methods/help_getConfig.md | 14 ++-- .../API_docs_v68/methods/help_saveAppLog.md | 2 +- .../methods/help_setBotUpdatesStatus.md | 4 +- .../API_docs_v68/methods/initConnection.md | 32 ++++----- .../API_docs_v68/methods/invokeAfterMsg.md | 4 +- .../API_docs_v68/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v68/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/langpack_getDifference.md | 16 ++--- .../methods/langpack_getLangPack.md | 16 ++--- .../methods/langpack_getLanguages.md | 14 ++-- .../methods/langpack_getStrings.md | 18 ++--- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_clearRecentStickers.md | 2 +- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 18 ++--- .../methods/messages_deleteMessages.md | 18 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_editInlineBotMessage.md | 26 +++---- .../methods/messages_editMessage.md | 42 +++++------ .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 64 ++++++++--------- .../methods/messages_getAllChats.md | 2 +- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getArchivedStickers.md | 6 +- .../methods/messages_getAttachedStickers.md | 2 +- .../methods/messages_getBotCallbackAnswer.md | 28 ++++---- .../API_docs_v68/methods/messages_getChats.md | 18 ++--- .../methods/messages_getCommonChats.md | 18 ++--- .../methods/messages_getDialogs.md | 28 ++++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getFeaturedStickers.md | 2 +- .../methods/messages_getGameHighScores.md | 18 ++--- .../methods/messages_getHistory.md | 36 +++++----- .../methods/messages_getInlineBotResults.md | 26 +++---- .../messages_getInlineGameHighScores.md | 18 ++--- .../methods/messages_getMaskStickers.md | 2 +- .../methods/messages_getMessageEditData.md | 18 ++--- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getPeerDialogs.md | 16 ++--- .../methods/messages_getPeerSettings.md | 16 ++--- .../methods/messages_getRecentStickers.md | 4 +- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getWebPage.md | 18 ++--- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_hideReportSpam.md | 14 ++-- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readFeaturedStickers.md | 2 +- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderPinnedDialogs.md | 16 ++--- .../methods/messages_reorderStickerSets.md | 4 +- .../methods/messages_reportEncryptedSpam.md | 14 ++-- .../methods/messages_reportSpam.md | 14 ++-- .../methods/messages_saveDraft.md | 22 +++--- .../API_docs_v68/methods/messages_saveGif.md | 16 ++--- .../methods/messages_saveRecentSticker.md | 18 ++--- .../API_docs_v68/methods/messages_search.md | 40 +++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 36 +++++----- .../methods/messages_sendMedia.md | 66 ++++++++--------- .../methods/messages_sendMessage.md | 70 +++++++++---------- .../methods/messages_setBotCallbackAnswer.md | 24 +++---- .../messages_setBotPrecheckoutResults.md | 20 +++--- .../methods/messages_setBotShippingResults.md | 20 +++--- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setGameScore.md | 24 +++---- .../methods/messages_setInlineBotResults.md | 48 ++++++------- .../methods/messages_setInlineGameScore.md | 24 +++---- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v68/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_toggleDialogPin.md | 16 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/messages_uploadMedia.md | 18 ++--- .../methods/payments_clearSavedInfo.md | 4 +- .../methods/payments_getPaymentForm.md | 16 ++--- .../methods/payments_getPaymentReceipt.md | 16 ++--- .../methods/payments_sendPaymentForm.md | 22 +++--- .../methods/payments_validateRequestedInfo.md | 20 +++--- .../methods/phone_receivedCall.md | 18 ++--- .../methods/phone_saveCallDebug.md | 20 +++--- .../methods/phone_setCallRating.md | 20 +++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_uploadProfilePhoto.md | 20 +++--- old_docs/API_docs_v68/methods/ping.md | 2 +- .../methods/ping_delay_disconnect.md | 4 +- .../API_docs_v68/methods/req_DH_params.md | 12 ++-- old_docs/API_docs_v68/methods/req_pq.md | 2 +- .../API_docs_v68/methods/rpc_drop_answer.md | 2 +- .../methods/set_client_DH_params.md | 6 +- .../methods/stickers_addStickerToSet.md | 20 +++--- .../methods/stickers_changeStickerPosition.md | 18 ++--- .../methods/stickers_createStickerSet.md | 38 +++++----- .../methods/stickers_removeStickerFromSet.md | 16 ++--- .../API_docs_v68/methods/upload_getWebFile.md | 20 +++--- .../API_docs_v68/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_confirmPhone.md | 20 +++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_getTmpPassword.md | 20 +++--- .../methods/account_registerDevice.md | 18 ++--- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 20 +++--- .../methods/account_sendConfirmPhoneCode.md | 20 +++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 22 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v70/methods/auth_cancelCode.md | 18 ++--- .../API_docs_v70/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_dropTempAuthKeys.md | 2 +- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../API_docs_v70/methods/auth_resendCode.md | 18 ++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v70/methods/auth_sendInvites.md | 18 ++--- .../methods/bots_answerWebhookJSONQuery.md | 20 +++--- .../methods/bots_sendCustomRequest.md | 18 ++--- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editBanned.md | 24 +++---- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_exportMessageLink.md | 16 ++--- .../methods/channels_getAdminLog.md | 28 ++++---- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_toggleInvites.md | 20 +++--- .../methods/channels_toggleSignatures.md | 16 ++--- .../methods/channels_updatePinnedMessage.md | 24 +++---- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v70/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getTopPeers.md | 32 ++++----- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 4 +- .../methods/contacts_resetTopPeerRating.md | 16 ++--- .../API_docs_v70/methods/contacts_search.md | 22 +++--- .../API_docs_v70/methods/contacts_unblock.md | 14 ++-- .../methods/contest_saveDeveloperInfo.md | 10 +-- .../API_docs_v70/methods/destroy_session.md | 2 +- .../API_docs_v70/methods/get_future_salts.md | 2 +- .../methods/help_getAppChangelog.md | 2 +- .../API_docs_v70/methods/help_getCdnConfig.md | 14 ++-- .../API_docs_v70/methods/help_getConfig.md | 14 ++-- .../API_docs_v70/methods/help_saveAppLog.md | 2 +- .../methods/help_setBotUpdatesStatus.md | 4 +- .../API_docs_v70/methods/initConnection.md | 32 ++++----- .../API_docs_v70/methods/invokeAfterMsg.md | 4 +- .../API_docs_v70/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v70/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/langpack_getDifference.md | 16 ++--- .../methods/langpack_getLangPack.md | 16 ++--- .../methods/langpack_getLanguages.md | 14 ++-- .../methods/langpack_getStrings.md | 18 ++--- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_clearRecentStickers.md | 2 +- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 18 ++--- .../methods/messages_deleteMessages.md | 18 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_editInlineBotMessage.md | 26 +++---- .../methods/messages_editMessage.md | 42 +++++------ .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 64 ++++++++--------- .../methods/messages_getAllChats.md | 2 +- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getArchivedStickers.md | 6 +- .../methods/messages_getAttachedStickers.md | 2 +- .../methods/messages_getBotCallbackAnswer.md | 28 ++++---- .../API_docs_v70/methods/messages_getChats.md | 18 ++--- .../methods/messages_getCommonChats.md | 18 ++--- .../methods/messages_getDialogs.md | 28 ++++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getFeaturedStickers.md | 2 +- .../methods/messages_getGameHighScores.md | 18 ++--- .../methods/messages_getHistory.md | 36 +++++----- .../methods/messages_getInlineBotResults.md | 26 +++---- .../messages_getInlineGameHighScores.md | 18 ++--- .../methods/messages_getMaskStickers.md | 2 +- .../methods/messages_getMessageEditData.md | 18 ++--- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getPeerDialogs.md | 16 ++--- .../methods/messages_getPeerSettings.md | 16 ++--- .../methods/messages_getRecentStickers.md | 4 +- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getWebPage.md | 18 ++--- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_hideReportSpam.md | 14 ++-- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readFeaturedStickers.md | 2 +- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderPinnedDialogs.md | 16 ++--- .../methods/messages_reorderStickerSets.md | 4 +- .../methods/messages_reportEncryptedSpam.md | 14 ++-- .../methods/messages_reportSpam.md | 14 ++-- .../methods/messages_saveDraft.md | 22 +++--- .../API_docs_v70/methods/messages_saveGif.md | 16 ++--- .../methods/messages_saveRecentSticker.md | 18 ++--- .../API_docs_v70/methods/messages_search.md | 40 +++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 36 +++++----- .../methods/messages_sendMedia.md | 66 ++++++++--------- .../methods/messages_sendMessage.md | 70 +++++++++---------- .../messages_sendScreenshotNotification.md | 16 ++--- .../methods/messages_setBotCallbackAnswer.md | 24 +++---- .../messages_setBotPrecheckoutResults.md | 20 +++--- .../methods/messages_setBotShippingResults.md | 20 +++--- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setGameScore.md | 24 +++---- .../methods/messages_setInlineBotResults.md | 48 ++++++------- .../methods/messages_setInlineGameScore.md | 24 +++---- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v70/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_toggleDialogPin.md | 16 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/messages_uploadMedia.md | 18 ++--- .../methods/payments_clearSavedInfo.md | 4 +- .../methods/payments_getPaymentForm.md | 16 ++--- .../methods/payments_getPaymentReceipt.md | 16 ++--- .../methods/payments_sendPaymentForm.md | 22 +++--- .../methods/payments_validateRequestedInfo.md | 20 +++--- .../methods/phone_receivedCall.md | 18 ++--- .../methods/phone_saveCallDebug.md | 20 +++--- .../methods/phone_setCallRating.md | 20 +++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_uploadProfilePhoto.md | 20 +++--- old_docs/API_docs_v70/methods/ping.md | 2 +- .../methods/ping_delay_disconnect.md | 4 +- .../API_docs_v70/methods/req_DH_params.md | 12 ++-- old_docs/API_docs_v70/methods/req_pq.md | 2 +- .../API_docs_v70/methods/rpc_drop_answer.md | 2 +- .../methods/set_client_DH_params.md | 6 +- .../methods/stickers_addStickerToSet.md | 20 +++--- .../methods/stickers_changeStickerPosition.md | 18 ++--- .../methods/stickers_createStickerSet.md | 38 +++++----- .../methods/stickers_removeStickerFromSet.md | 16 ++--- .../API_docs_v70/methods/upload_getWebFile.md | 20 +++--- .../API_docs_v70/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_confirmPhone.md | 20 +++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_getTmpPassword.md | 20 +++--- .../methods/account_registerDevice.md | 18 ++--- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 20 +++--- .../methods/account_sendConfirmPhoneCode.md | 20 +++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 22 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v71/methods/auth_cancelCode.md | 18 ++--- .../API_docs_v71/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_dropTempAuthKeys.md | 2 +- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../API_docs_v71/methods/auth_resendCode.md | 18 ++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v71/methods/auth_sendInvites.md | 18 ++--- .../methods/bots_answerWebhookJSONQuery.md | 20 +++--- .../methods/bots_sendCustomRequest.md | 18 ++--- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editBanned.md | 24 +++---- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_exportMessageLink.md | 16 ++--- .../methods/channels_getAdminLog.md | 28 ++++---- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 28 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_readMessageContents.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_setStickers.md | 18 ++--- .../methods/channels_toggleInvites.md | 20 +++--- .../methods/channels_toggleSignatures.md | 16 ++--- .../methods/channels_updatePinnedMessage.md | 24 +++---- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v71/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getTopPeers.md | 32 ++++----- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 2 +- .../methods/contacts_resetTopPeerRating.md | 16 ++--- .../API_docs_v71/methods/contacts_search.md | 22 +++--- .../API_docs_v71/methods/contacts_unblock.md | 14 ++-- .../methods/contest_saveDeveloperInfo.md | 10 +-- .../API_docs_v71/methods/destroy_session.md | 2 +- .../API_docs_v71/methods/get_future_salts.md | 2 +- .../methods/help_getAppChangelog.md | 2 +- .../API_docs_v71/methods/help_getCdnConfig.md | 14 ++-- .../API_docs_v71/methods/help_getConfig.md | 14 ++-- .../API_docs_v71/methods/help_saveAppLog.md | 2 +- .../methods/help_setBotUpdatesStatus.md | 4 +- .../API_docs_v71/methods/initConnection.md | 32 ++++----- .../API_docs_v71/methods/invokeAfterMsg.md | 4 +- .../API_docs_v71/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v71/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/langpack_getDifference.md | 16 ++--- .../methods/langpack_getLangPack.md | 16 ++--- .../methods/langpack_getLanguages.md | 14 ++-- .../methods/langpack_getStrings.md | 18 ++--- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_clearRecentStickers.md | 2 +- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 18 ++--- .../methods/messages_deleteMessages.md | 18 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_editInlineBotMessage.md | 26 +++---- .../methods/messages_editMessage.md | 42 +++++------ .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_faveSticker.md | 16 ++--- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 64 ++++++++--------- .../methods/messages_getAllChats.md | 2 +- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getArchivedStickers.md | 6 +- .../methods/messages_getAttachedStickers.md | 2 +- .../methods/messages_getBotCallbackAnswer.md | 28 ++++---- .../API_docs_v71/methods/messages_getChats.md | 18 ++--- .../methods/messages_getCommonChats.md | 18 ++--- .../methods/messages_getDialogs.md | 28 ++++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getFavedStickers.md | 2 +- .../methods/messages_getFeaturedStickers.md | 2 +- .../methods/messages_getGameHighScores.md | 18 ++--- .../methods/messages_getHistory.md | 36 +++++----- .../methods/messages_getInlineBotResults.md | 26 +++---- .../messages_getInlineGameHighScores.md | 18 ++--- .../methods/messages_getMaskStickers.md | 2 +- .../methods/messages_getMessageEditData.md | 18 ++--- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getPeerDialogs.md | 16 ++--- .../methods/messages_getPeerSettings.md | 16 ++--- .../methods/messages_getRecentStickers.md | 4 +- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getUnreadMentions.md | 24 +++---- .../methods/messages_getWebPage.md | 18 ++--- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_hideReportSpam.md | 14 ++-- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readFeaturedStickers.md | 2 +- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderPinnedDialogs.md | 16 ++--- .../methods/messages_reorderStickerSets.md | 4 +- .../methods/messages_reportEncryptedSpam.md | 14 ++-- .../methods/messages_reportSpam.md | 14 ++-- .../methods/messages_saveDraft.md | 22 +++--- .../API_docs_v71/methods/messages_saveGif.md | 16 ++--- .../methods/messages_saveRecentSticker.md | 18 ++--- .../API_docs_v71/methods/messages_search.md | 44 ++++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 36 +++++----- .../methods/messages_sendMedia.md | 66 ++++++++--------- .../methods/messages_sendMessage.md | 70 +++++++++---------- .../messages_sendScreenshotNotification.md | 16 ++--- .../methods/messages_setBotCallbackAnswer.md | 24 +++---- .../messages_setBotPrecheckoutResults.md | 20 +++--- .../methods/messages_setBotShippingResults.md | 20 +++--- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setGameScore.md | 24 +++---- .../methods/messages_setInlineBotResults.md | 48 ++++++------- .../methods/messages_setInlineGameScore.md | 24 +++---- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v71/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_toggleDialogPin.md | 16 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/messages_uploadMedia.md | 18 ++--- .../methods/payments_clearSavedInfo.md | 4 +- .../methods/payments_getPaymentForm.md | 16 ++--- .../methods/payments_getPaymentReceipt.md | 16 ++--- .../methods/payments_sendPaymentForm.md | 22 +++--- .../methods/payments_validateRequestedInfo.md | 20 +++--- .../methods/phone_receivedCall.md | 18 ++--- .../methods/phone_saveCallDebug.md | 20 +++--- .../methods/phone_setCallRating.md | 20 +++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_uploadProfilePhoto.md | 20 +++--- old_docs/API_docs_v71/methods/ping.md | 2 +- .../methods/ping_delay_disconnect.md | 4 +- .../API_docs_v71/methods/req_DH_params.md | 12 ++-- old_docs/API_docs_v71/methods/req_pq.md | 2 +- .../API_docs_v71/methods/rpc_drop_answer.md | 2 +- .../methods/set_client_DH_params.md | 6 +- .../methods/stickers_addStickerToSet.md | 20 +++--- .../methods/stickers_changeStickerPosition.md | 18 ++--- .../methods/stickers_createStickerSet.md | 38 +++++----- .../methods/stickers_removeStickerFromSet.md | 16 ++--- .../API_docs_v71/methods/upload_getWebFile.md | 20 +++--- .../API_docs_v71/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_confirmPhone.md | 20 +++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_getTmpPassword.md | 20 +++--- .../methods/account_registerDevice.md | 18 ++--- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 20 +++--- .../methods/account_sendConfirmPhoneCode.md | 20 +++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 22 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v72/methods/auth_cancelCode.md | 18 ++--- .../API_docs_v72/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_dropTempAuthKeys.md | 2 +- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../API_docs_v72/methods/auth_resendCode.md | 18 ++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v72/methods/auth_sendInvites.md | 18 ++--- .../methods/bots_answerWebhookJSONQuery.md | 20 +++--- .../methods/bots_sendCustomRequest.md | 18 ++--- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteHistory.md | 2 +- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editBanned.md | 24 +++---- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_exportMessageLink.md | 16 ++--- .../methods/channels_getAdminLog.md | 28 ++++---- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 30 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_readMessageContents.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_setStickers.md | 18 ++--- .../methods/channels_toggleInvites.md | 20 +++--- .../channels_togglePreHistoryHidden.md | 2 +- .../methods/channels_toggleSignatures.md | 16 ++--- .../methods/channels_updatePinnedMessage.md | 24 +++---- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v72/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getTopPeers.md | 32 ++++----- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 2 +- .../methods/contacts_resetTopPeerRating.md | 16 ++--- .../API_docs_v72/methods/contacts_search.md | 22 +++--- .../API_docs_v72/methods/contacts_unblock.md | 14 ++-- .../methods/contest_saveDeveloperInfo.md | 10 +-- .../API_docs_v72/methods/destroy_session.md | 2 +- .../API_docs_v72/methods/get_future_salts.md | 2 +- .../methods/help_getAppChangelog.md | 2 +- .../API_docs_v72/methods/help_getCdnConfig.md | 14 ++-- .../API_docs_v72/methods/help_getConfig.md | 14 ++-- .../methods/help_getRecentMeUrls.md | 2 +- .../API_docs_v72/methods/help_saveAppLog.md | 2 +- .../methods/help_setBotUpdatesStatus.md | 4 +- .../API_docs_v72/methods/initConnection.md | 32 ++++----- .../API_docs_v72/methods/invokeAfterMsg.md | 4 +- .../API_docs_v72/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v72/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/langpack_getDifference.md | 16 ++--- .../methods/langpack_getLangPack.md | 16 ++--- .../methods/langpack_getLanguages.md | 14 ++-- .../methods/langpack_getStrings.md | 18 ++--- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_clearRecentStickers.md | 2 +- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 18 ++--- .../methods/messages_deleteMessages.md | 18 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_editInlineBotMessage.md | 26 +++---- .../methods/messages_editMessage.md | 46 ++++++------ .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_faveSticker.md | 16 ++--- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 64 ++++++++--------- .../methods/messages_getAllChats.md | 2 +- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getArchivedStickers.md | 6 +- .../methods/messages_getAttachedStickers.md | 2 +- .../methods/messages_getBotCallbackAnswer.md | 28 ++++---- .../API_docs_v72/methods/messages_getChats.md | 18 ++--- .../methods/messages_getCommonChats.md | 18 ++--- .../methods/messages_getDialogs.md | 28 ++++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getFavedStickers.md | 2 +- .../methods/messages_getFeaturedStickers.md | 2 +- .../methods/messages_getGameHighScores.md | 18 ++--- .../methods/messages_getHistory.md | 36 +++++----- .../methods/messages_getInlineBotResults.md | 26 +++---- .../messages_getInlineGameHighScores.md | 18 ++--- .../methods/messages_getMaskStickers.md | 2 +- .../methods/messages_getMessageEditData.md | 18 ++--- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getPeerDialogs.md | 16 ++--- .../methods/messages_getPeerSettings.md | 16 ++--- .../methods/messages_getRecentLocations.md | 2 +- .../methods/messages_getRecentStickers.md | 4 +- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getUnreadMentions.md | 24 +++---- .../methods/messages_getWebPage.md | 18 ++--- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_hideReportSpam.md | 14 ++-- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readFeaturedStickers.md | 2 +- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderPinnedDialogs.md | 16 ++--- .../methods/messages_reorderStickerSets.md | 4 +- .../methods/messages_reportEncryptedSpam.md | 14 ++-- .../methods/messages_reportSpam.md | 14 ++-- .../methods/messages_saveDraft.md | 22 +++--- .../API_docs_v72/methods/messages_saveGif.md | 16 ++--- .../methods/messages_saveRecentSticker.md | 18 ++--- .../API_docs_v72/methods/messages_search.md | 44 ++++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 36 +++++----- .../methods/messages_sendMedia.md | 66 ++++++++--------- .../methods/messages_sendMessage.md | 70 +++++++++---------- .../messages_sendScreenshotNotification.md | 16 ++--- .../methods/messages_setBotCallbackAnswer.md | 24 +++---- .../messages_setBotPrecheckoutResults.md | 20 +++--- .../methods/messages_setBotShippingResults.md | 20 +++--- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setGameScore.md | 24 +++---- .../methods/messages_setInlineBotResults.md | 48 ++++++------- .../methods/messages_setInlineGameScore.md | 24 +++---- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v72/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_toggleDialogPin.md | 16 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/messages_uploadMedia.md | 18 ++--- .../methods/payments_clearSavedInfo.md | 4 +- .../methods/payments_getPaymentForm.md | 16 ++--- .../methods/payments_getPaymentReceipt.md | 16 ++--- .../methods/payments_sendPaymentForm.md | 22 +++--- .../methods/payments_validateRequestedInfo.md | 20 +++--- .../methods/phone_receivedCall.md | 18 ++--- .../methods/phone_saveCallDebug.md | 20 +++--- .../methods/phone_setCallRating.md | 20 +++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_uploadProfilePhoto.md | 20 +++--- old_docs/API_docs_v72/methods/ping.md | 2 +- .../methods/ping_delay_disconnect.md | 4 +- .../API_docs_v72/methods/req_DH_params.md | 12 ++-- old_docs/API_docs_v72/methods/req_pq.md | 2 +- .../API_docs_v72/methods/rpc_drop_answer.md | 2 +- .../methods/set_client_DH_params.md | 6 +- .../methods/stickers_addStickerToSet.md | 20 +++--- .../methods/stickers_changeStickerPosition.md | 18 ++--- .../methods/stickers_createStickerSet.md | 38 +++++----- .../methods/stickers_removeStickerFromSet.md | 16 ++--- .../API_docs_v72/methods/upload_getWebFile.md | 20 +++--- .../API_docs_v72/methods/users_getUsers.md | 20 +++--- .../methods/account_changePhone.md | 20 +++--- .../methods/account_checkUsername.md | 16 ++--- .../methods/account_confirmPhone.md | 20 +++--- .../methods/account_deleteAccount.md | 2 +- .../methods/account_getNotifySettings.md | 16 ++--- .../methods/account_getPasswordSettings.md | 16 ++--- .../methods/account_getPrivacy.md | 16 ++--- .../methods/account_getTmpPassword.md | 20 +++--- .../methods/account_registerDevice.md | 18 ++--- .../methods/account_reportPeer.md | 16 ++--- .../methods/account_resetAuthorization.md | 16 ++--- .../methods/account_sendChangePhoneCode.md | 20 +++--- .../methods/account_sendConfirmPhoneCode.md | 20 +++--- .../methods/account_setAccountTTL.md | 16 ++--- .../methods/account_setPrivacy.md | 18 ++--- .../methods/account_unregisterDevice.md | 18 ++--- .../methods/account_updateDeviceLocked.md | 2 +- .../methods/account_updateNotifySettings.md | 18 ++--- .../methods/account_updatePasswordSettings.md | 24 +++---- .../methods/account_updateProfile.md | 22 +++--- .../methods/account_updateStatus.md | 16 ++--- .../methods/account_updateUsername.md | 20 +++--- .../API_docs_v73/methods/auth_cancelCode.md | 18 ++--- .../API_docs_v73/methods/auth_checkPhone.md | 20 +++--- .../methods/auth_dropTempAuthKeys.md | 2 +- .../methods/auth_recoverPassword.md | 16 ++--- .../methods/auth_requestPasswordRecovery.md | 14 ++-- .../API_docs_v73/methods/auth_resendCode.md | 18 ++--- .../methods/auth_resetAuthorizations.md | 14 ++-- .../API_docs_v73/methods/auth_sendInvites.md | 18 ++--- .../methods/bots_answerWebhookJSONQuery.md | 20 +++--- .../methods/bots_sendCustomRequest.md | 18 ++--- .../methods/channels_checkUsername.md | 20 +++--- .../methods/channels_createChannel.md | 24 +++---- .../methods/channels_deleteChannel.md | 16 ++--- .../methods/channels_deleteHistory.md | 2 +- .../methods/channels_deleteMessages.md | 20 +++--- .../methods/channels_deleteUserHistory.md | 16 ++--- .../methods/channels_editAbout.md | 22 +++--- .../methods/channels_editAdmin.md | 34 ++++----- .../methods/channels_editBanned.md | 24 +++---- .../methods/channels_editPhoto.md | 20 +++--- .../methods/channels_editTitle.md | 20 +++--- .../methods/channels_exportInvite.md | 18 ++--- .../methods/channels_exportMessageLink.md | 16 ++--- .../methods/channels_getAdminLog.md | 28 ++++---- .../methods/channels_getChannels.md | 18 ++--- .../methods/channels_getMessages.md | 20 +++--- .../methods/channels_getParticipant.md | 22 +++--- .../methods/channels_getParticipants.md | 30 ++++---- .../methods/channels_inviteToChannel.md | 44 ++++++------ .../methods/channels_joinChannel.md | 18 ++--- .../methods/channels_leaveChannel.md | 22 +++--- .../methods/channels_readHistory.md | 18 ++--- .../methods/channels_readMessageContents.md | 18 ++--- .../methods/channels_reportSpam.md | 18 ++--- .../methods/channels_setStickers.md | 18 ++--- .../methods/channels_toggleInvites.md | 20 +++--- .../channels_togglePreHistoryHidden.md | 2 +- .../methods/channels_toggleSignatures.md | 16 ++--- .../methods/channels_updatePinnedMessage.md | 24 +++---- .../methods/channels_updateUsername.md | 24 +++---- .../API_docs_v73/methods/contacts_block.md | 14 ++-- .../methods/contacts_deleteContact.md | 14 ++-- .../methods/contacts_deleteContacts.md | 16 ++--- .../methods/contacts_getBlocked.md | 4 +- .../methods/contacts_getContacts.md | 2 +- .../methods/contacts_getTopPeers.md | 32 ++++----- .../methods/contacts_importCard.md | 18 ++--- .../methods/contacts_importContacts.md | 2 +- .../methods/contacts_resetTopPeerRating.md | 16 ++--- .../API_docs_v73/methods/contacts_search.md | 22 +++--- .../API_docs_v73/methods/contacts_unblock.md | 14 ++-- .../methods/help_getAppChangelog.md | 2 +- .../API_docs_v73/methods/help_getCdnConfig.md | 14 ++-- .../API_docs_v73/methods/help_getConfig.md | 14 ++-- .../methods/help_getRecentMeUrls.md | 2 +- .../API_docs_v73/methods/help_saveAppLog.md | 2 +- .../methods/help_setBotUpdatesStatus.md | 4 +- .../API_docs_v73/methods/initConnection.md | 32 ++++----- .../API_docs_v73/methods/invokeAfterMsg.md | 4 +- .../API_docs_v73/methods/invokeAfterMsgs.md | 4 +- .../API_docs_v73/methods/invokeWithLayer.md | 38 +++++----- .../methods/invokeWithoutUpdates.md | 2 +- .../methods/langpack_getDifference.md | 16 ++--- .../methods/langpack_getLangPack.md | 16 ++--- .../methods/langpack_getLanguages.md | 14 ++-- .../methods/langpack_getStrings.md | 18 ++--- .../methods/messages_addChatUser.md | 32 ++++----- .../methods/messages_checkChatInvite.md | 20 +++--- .../methods/messages_clearRecentStickers.md | 2 +- .../methods/messages_createChat.md | 18 ++--- .../methods/messages_deleteChatUser.md | 18 ++--- .../methods/messages_deleteHistory.md | 18 ++--- .../methods/messages_deleteMessages.md | 18 ++--- .../methods/messages_editChatAdmin.md | 16 ++--- .../methods/messages_editChatPhoto.md | 24 +++---- .../methods/messages_editChatTitle.md | 18 ++--- .../methods/messages_editInlineBotMessage.md | 30 ++++---- .../methods/messages_editMessage.md | 46 ++++++------ .../methods/messages_exportChatInvite.md | 14 ++-- .../methods/messages_faveSticker.md | 16 ++--- .../methods/messages_forwardMessage.md | 22 +++--- .../methods/messages_forwardMessages.md | 66 ++++++++--------- .../methods/messages_getAllChats.md | 2 +- .../methods/messages_getAllStickers.md | 2 +- .../methods/messages_getArchivedStickers.md | 6 +- .../methods/messages_getAttachedStickers.md | 2 +- .../methods/messages_getBotCallbackAnswer.md | 28 ++++---- .../API_docs_v73/methods/messages_getChats.md | 18 ++--- .../methods/messages_getCommonChats.md | 18 ++--- .../methods/messages_getDialogs.md | 28 ++++---- .../methods/messages_getDocumentByHash.md | 20 +++--- .../methods/messages_getFavedStickers.md | 2 +- .../methods/messages_getFeaturedStickers.md | 2 +- .../methods/messages_getGameHighScores.md | 18 ++--- .../methods/messages_getHistory.md | 38 +++++----- .../methods/messages_getInlineBotResults.md | 26 +++---- .../messages_getInlineGameHighScores.md | 18 ++--- .../methods/messages_getMaskStickers.md | 2 +- .../methods/messages_getMessageEditData.md | 18 ++--- .../methods/messages_getMessages.md | 2 +- .../methods/messages_getMessagesViews.md | 22 +++--- .../methods/messages_getPeerDialogs.md | 16 ++--- .../methods/messages_getPeerSettings.md | 16 ++--- .../methods/messages_getRecentLocations.md | 2 +- .../methods/messages_getRecentStickers.md | 4 +- .../methods/messages_getSavedGifs.md | 2 +- .../methods/messages_getStickerSet.md | 16 ++--- .../methods/messages_getUnreadMentions.md | 24 +++---- .../methods/messages_getWebPage.md | 18 ++--- .../methods/messages_getWebPagePreview.md | 2 +- .../methods/messages_hideReportSpam.md | 14 ++-- .../methods/messages_importChatInvite.md | 28 ++++---- .../methods/messages_installStickerSet.md | 18 ++--- .../methods/messages_migrateChat.md | 18 ++--- .../methods/messages_readEncryptedHistory.md | 16 ++--- .../methods/messages_readFeaturedStickers.md | 2 +- .../methods/messages_readHistory.md | 18 ++--- .../methods/messages_readMessageContents.md | 2 +- .../methods/messages_receivedMessages.md | 2 +- .../methods/messages_reorderPinnedDialogs.md | 16 ++--- .../methods/messages_reorderStickerSets.md | 4 +- .../methods/messages_reportEncryptedSpam.md | 14 ++-- .../methods/messages_reportSpam.md | 14 ++-- .../methods/messages_saveDraft.md | 22 +++--- .../API_docs_v73/methods/messages_saveGif.md | 16 ++--- .../methods/messages_saveRecentSticker.md | 18 ++--- .../API_docs_v73/methods/messages_search.md | 44 ++++++------ .../methods/messages_searchGifs.md | 18 ++--- .../methods/messages_searchGlobal.md | 22 +++--- .../methods/messages_sendEncrypted.md | 22 +++--- .../methods/messages_sendEncryptedFile.md | 16 ++--- .../methods/messages_sendEncryptedService.md | 22 +++--- .../methods/messages_sendInlineBotResult.md | 36 +++++----- .../methods/messages_sendMedia.md | 66 ++++++++--------- .../methods/messages_sendMessage.md | 70 +++++++++---------- .../methods/messages_sendMultiMedia.md | 10 +-- .../messages_sendScreenshotNotification.md | 16 ++--- .../methods/messages_setBotCallbackAnswer.md | 24 +++---- .../messages_setBotPrecheckoutResults.md | 20 +++--- .../methods/messages_setBotShippingResults.md | 20 +++--- .../methods/messages_setEncryptedTyping.md | 16 ++--- .../methods/messages_setGameScore.md | 24 +++---- .../methods/messages_setInlineBotResults.md | 48 ++++++------- .../methods/messages_setInlineGameScore.md | 24 +++---- .../methods/messages_setTyping.md | 30 ++++---- .../API_docs_v73/methods/messages_startBot.md | 22 +++--- .../methods/messages_toggleChatAdmins.md | 18 ++--- .../methods/messages_toggleDialogPin.md | 16 ++--- .../methods/messages_uninstallStickerSet.md | 16 ++--- .../methods/messages_uploadMedia.md | 18 ++--- .../methods/payments_clearSavedInfo.md | 4 +- .../methods/payments_getPaymentForm.md | 16 ++--- .../methods/payments_getPaymentReceipt.md | 16 ++--- .../methods/payments_sendPaymentForm.md | 22 +++--- .../methods/payments_validateRequestedInfo.md | 20 +++--- .../methods/phone_receivedCall.md | 18 ++--- .../methods/phone_saveCallDebug.md | 20 +++--- .../methods/phone_setCallRating.md | 20 +++--- .../methods/photos_getUserPhotos.md | 22 +++--- .../methods/photos_uploadProfilePhoto.md | 20 +++--- .../methods/stickers_addStickerToSet.md | 20 +++--- .../methods/stickers_changeStickerPosition.md | 18 ++--- .../methods/stickers_createStickerSet.md | 38 +++++----- .../methods/stickers_removeStickerFromSet.md | 16 ++--- .../API_docs_v73/methods/upload_getWebFile.md | 20 +++--- .../API_docs_v73/methods/users_getUsers.md | 20 +++--- .../MadelineProto/DocsBuilder/Methods.php | 24 +++---- 3600 files changed, 30259 insertions(+), 30259 deletions(-) diff --git a/docs/API_docs/methods/account_changePhone.md b/docs/API_docs/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/docs/API_docs/methods/account_changePhone.md +++ b/docs/API_docs/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/docs/API_docs/methods/account_checkUsername.md b/docs/API_docs/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/docs/API_docs/methods/account_checkUsername.md +++ b/docs/API_docs/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/docs/API_docs/methods/account_confirmPhone.md b/docs/API_docs/methods/account_confirmPhone.md index 68490f35..7ffabc24 100644 --- a/docs/API_docs/methods/account_confirmPhone.md +++ b/docs/API_docs/methods/account_confirmPhone.md @@ -12,8 +12,8 @@ Confirm this phone number is associated to this account, obtain phone_code_hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| +|phone\_code\_hash|[string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Confirm this phone number is associated to this account, obtain phone_code_hash ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_HASH_INVALID|Code hash invalid| -|PHONE_CODE_EMPTY|phone_code is missing| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_HASH_INVALID|Code hash invalid| +|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/docs/API_docs/methods/account_deleteAccount.md b/docs/API_docs/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/docs/API_docs/methods/account_deleteAccount.md +++ b/docs/API_docs/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/account_getNotifySettings.md b/docs/API_docs/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/docs/API_docs/methods/account_getNotifySettings.md +++ b/docs/API_docs/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/account_getPasswordSettings.md b/docs/API_docs/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/docs/API_docs/methods/account_getPasswordSettings.md +++ b/docs/API_docs/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/docs/API_docs/methods/account_getPrivacy.md b/docs/API_docs/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/docs/API_docs/methods/account_getPrivacy.md +++ b/docs/API_docs/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/docs/API_docs/methods/account_getTmpPassword.md b/docs/API_docs/methods/account_getTmpPassword.md index 01b1ebfc..c82ff37a 100644 --- a/docs/API_docs/methods/account_getTmpPassword.md +++ b/docs/API_docs/methods/account_getTmpPassword.md @@ -12,8 +12,8 @@ Get temporary password for buying products through bots | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|The password hash| -|period|[CLICK ME int](../types/int.md) | Yes|The validity period| +|password\_hash|[bytes](../types/bytes.md) | Yes|The password hash| +|period|[int](../types/int.md) | Yes|The validity period| ### Return type: [account\_TmpPassword](../types/account_TmpPassword.md) @@ -21,14 +21,6 @@ Get temporary password for buying products through bots ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| -|TMP_PASSWORD_DISABLED|The temporary password is disabled| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: account_TmpPassword = account.getTmpPassword({password_hash='bytes', period=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|TMP_PASSWORD_DISABLED|The temporary password is disabled| + + diff --git a/docs/API_docs/methods/account_registerDevice.md b/docs/API_docs/methods/account_registerDevice.md index c94ed9e0..0ce46517 100644 --- a/docs/API_docs/methods/account_registerDevice.md +++ b/docs/API_docs/methods/account_registerDevice.md @@ -12,10 +12,10 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|other\_uids|Array of [CLICK ME int](../types/int.md) | Yes|Other UIDs| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|other\_uids|Array of [int](../types/int.md) | Yes|Other UIDs| ### Return type: [Bool](../types/Bool.md) @@ -23,13 +23,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', app_sandbox=Bool, other_uids={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/docs/API_docs/methods/account_reportPeer.md b/docs/API_docs/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/docs/API_docs/methods/account_reportPeer.md +++ b/docs/API_docs/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/account_resetAuthorization.md b/docs/API_docs/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/docs/API_docs/methods/account_resetAuthorization.md +++ b/docs/API_docs/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/docs/API_docs/methods/account_resetWebAuthorization.md b/docs/API_docs/methods/account_resetWebAuthorization.md index ce635206..610c917d 100644 --- a/docs/API_docs/methods/account_resetWebAuthorization.md +++ b/docs/API_docs/methods/account_resetWebAuthorization.md @@ -12,7 +12,7 @@ Delete a certain telegram web login authorization | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The authorization's hash| +|hash|[long](../types/long.md) | Yes|The authorization's hash| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/account_sendChangePhoneCode.md b/docs/API_docs/methods/account_sendChangePhoneCode.md index bdf7331f..476b6d79 100644 --- a/docs/API_docs/methods/account_sendChangePhoneCode.md +++ b/docs/API_docs/methods/account_sendChangePhoneCode.md @@ -12,9 +12,9 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|Current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/docs/API_docs/methods/account_sendConfirmPhoneCode.md b/docs/API_docs/methods/account_sendConfirmPhoneCode.md index 86035d19..8917355f 100644 --- a/docs/API_docs/methods/account_sendConfirmPhoneCode.md +++ b/docs/API_docs/methods/account_sendConfirmPhoneCode.md @@ -12,9 +12,9 @@ Send confirmation phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| -|hash|[CLICK ME string](../types/string.md) | Yes|The hash| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|The current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| +|hash|[string](../types/string.md) | Yes|The hash| +|current\_number|[Bool](../types/Bool.md) | Optional|The current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Send confirmation phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendConfirmPhoneCode({allow_flashcall=Bool, hash='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/docs/API_docs/methods/account_setAccountTTL.md b/docs/API_docs/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/docs/API_docs/methods/account_setAccountTTL.md +++ b/docs/API_docs/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/docs/API_docs/methods/account_setPrivacy.md b/docs/API_docs/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/docs/API_docs/methods/account_setPrivacy.md +++ b/docs/API_docs/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/docs/API_docs/methods/account_unregisterDevice.md b/docs/API_docs/methods/account_unregisterDevice.md index fd771afc..602a123e 100644 --- a/docs/API_docs/methods/account_unregisterDevice.md +++ b/docs/API_docs/methods/account_unregisterDevice.md @@ -12,9 +12,9 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|other\_uids|Array of [CLICK ME int](../types/int.md) | Yes|Other UIDs| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|other\_uids|Array of [int](../types/int.md) | Yes|Other UIDs| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', other_uids={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/docs/API_docs/methods/account_updateDeviceLocked.md b/docs/API_docs/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/docs/API_docs/methods/account_updateDeviceLocked.md +++ b/docs/API_docs/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/account_updateNotifySettings.md b/docs/API_docs/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/docs/API_docs/methods/account_updateNotifySettings.md +++ b/docs/API_docs/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/account_updatePasswordSettings.md b/docs/API_docs/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/docs/API_docs/methods/account_updatePasswordSettings.md +++ b/docs/API_docs/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/docs/API_docs/methods/account_updateProfile.md b/docs/API_docs/methods/account_updateProfile.md index 59629188..ef19dc00 100644 --- a/docs/API_docs/methods/account_updateProfile.md +++ b/docs/API_docs/methods/account_updateProfile.md @@ -12,9 +12,9 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Optional|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Optional|The last name| -|about|[CLICK ME string](../types/string.md) | Optional|The bio/about field| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| ### Return type: [User](../types/User.md) @@ -22,14 +22,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/docs/API_docs/methods/account_updateStatus.md b/docs/API_docs/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/docs/API_docs/methods/account_updateStatus.md +++ b/docs/API_docs/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/docs/API_docs/methods/account_updateUsername.md b/docs/API_docs/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/docs/API_docs/methods/account_updateUsername.md +++ b/docs/API_docs/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/docs/API_docs/methods/auth_cancelCode.md b/docs/API_docs/methods/auth_cancelCode.md index 52b85d4c..84401c62 100644 --- a/docs/API_docs/methods/auth_cancelCode.md +++ b/docs/API_docs/methods/auth_cancelCode.md @@ -12,8 +12,8 @@ Invalidate sent phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invalidate sent phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/docs/API_docs/methods/auth_checkPhone.md b/docs/API_docs/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/docs/API_docs/methods/auth_checkPhone.md +++ b/docs/API_docs/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/docs/API_docs/methods/auth_dropTempAuthKeys.md b/docs/API_docs/methods/auth_dropTempAuthKeys.md index 5aa98b3b..537afbc1 100644 --- a/docs/API_docs/methods/auth_dropTempAuthKeys.md +++ b/docs/API_docs/methods/auth_dropTempAuthKeys.md @@ -12,7 +12,7 @@ Delete all temporary authorization keys except the ones provided | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_auth\_keys|Array of [CLICK ME long](../types/long.md) | Yes|The temporary authorization keys to keep| +|except\_auth\_keys|Array of [long](../types/long.md) | Yes|The temporary authorization keys to keep| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/auth_recoverPassword.md b/docs/API_docs/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/docs/API_docs/methods/auth_recoverPassword.md +++ b/docs/API_docs/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/docs/API_docs/methods/auth_requestPasswordRecovery.md b/docs/API_docs/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/docs/API_docs/methods/auth_requestPasswordRecovery.md +++ b/docs/API_docs/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/docs/API_docs/methods/auth_resendCode.md b/docs/API_docs/methods/auth_resendCode.md index 253480a3..4402bfe6 100644 --- a/docs/API_docs/methods/auth_resendCode.md +++ b/docs/API_docs/methods/auth_resendCode.md @@ -12,8 +12,8 @@ Resend the SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -21,13 +21,6 @@ Resend the SMS verification code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/docs/API_docs/methods/auth_resetAuthorizations.md b/docs/API_docs/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/docs/API_docs/methods/auth_resetAuthorizations.md +++ b/docs/API_docs/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/auth_sendInvites.md b/docs/API_docs/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/docs/API_docs/methods/auth_sendInvites.md +++ b/docs/API_docs/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/docs/API_docs/methods/bots_answerWebhookJSONQuery.md b/docs/API_docs/methods/bots_answerWebhookJSONQuery.md index 40cb0477..3dbf62ef 100644 --- a/docs/API_docs/methods/bots_answerWebhookJSONQuery.md +++ b/docs/API_docs/methods/bots_answerWebhookJSONQuery.md @@ -12,8 +12,8 @@ Send webhook request via bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|data|[DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Send webhook request via bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Bool = bots.answerWebhookJSONQuery({query_id=long, data=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/docs/API_docs/methods/bots_sendCustomRequest.md b/docs/API_docs/methods/bots_sendCustomRequest.md index 5a7f4e86..cb7c32e2 100644 --- a/docs/API_docs/methods/bots_sendCustomRequest.md +++ b/docs/API_docs/methods/bots_sendCustomRequest.md @@ -12,8 +12,8 @@ Send a custom request to the bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| +|custom\_method|[string](../types/string.md) | Yes|The method to call| +|params|[DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) @@ -21,13 +21,6 @@ Send a custom request to the bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: DataJSON = bots.sendCustomRequest({custom_method='string', params=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/docs/API_docs/methods/channels_checkUsername.md b/docs/API_docs/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/docs/API_docs/methods/channels_checkUsername.md +++ b/docs/API_docs/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/docs/API_docs/methods/channels_createChannel.md b/docs/API_docs/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/docs/API_docs/methods/channels_createChannel.md +++ b/docs/API_docs/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/docs/API_docs/methods/channels_deleteChannel.md b/docs/API_docs/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/docs/API_docs/methods/channels_deleteChannel.md +++ b/docs/API_docs/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/docs/API_docs/methods/channels_deleteHistory.md b/docs/API_docs/methods/channels_deleteHistory.md index 856a32e8..f7c225f6 100644 --- a/docs/API_docs/methods/channels_deleteHistory.md +++ b/docs/API_docs/methods/channels_deleteHistory.md @@ -13,7 +13,7 @@ Delete the history of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to delete| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/channels_deleteMessages.md b/docs/API_docs/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/docs/API_docs/methods/channels_deleteMessages.md +++ b/docs/API_docs/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/docs/API_docs/methods/channels_deleteUserHistory.md b/docs/API_docs/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/docs/API_docs/methods/channels_deleteUserHistory.md +++ b/docs/API_docs/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/docs/API_docs/methods/channels_editAbout.md b/docs/API_docs/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/docs/API_docs/methods/channels_editAbout.md +++ b/docs/API_docs/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/docs/API_docs/methods/channels_editAdmin.md b/docs/API_docs/methods/channels_editAdmin.md index 7cecbd64..f08473eb 100644 --- a/docs/API_docs/methods/channels_editAdmin.md +++ b/docs/API_docs/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| +|admin\_rights|[ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, admin_rights=ChannelAdminRights, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/docs/API_docs/methods/channels_editBanned.md b/docs/API_docs/methods/channels_editBanned.md index ca9f2596..03dc70a5 100644 --- a/docs/API_docs/methods/channels_editBanned.md +++ b/docs/API_docs/methods/channels_editBanned.md @@ -14,7 +14,7 @@ Kick or ban a user from a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban| -|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| +|banned\_rights|[ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| ### Return type: [Updates](../types/Updates.md) @@ -22,17 +22,6 @@ Kick or ban a user from a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ADMIN_INVALID|You're not an admin| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +71,14 @@ Or, if you're into Lua: Updates = channels.editBanned({channel=InputChannel, user_id=InputUser, banned_rights=ChannelBannedRights, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ADMIN_INVALID|You're not an admin| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/docs/API_docs/methods/channels_editPhoto.md b/docs/API_docs/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/docs/API_docs/methods/channels_editPhoto.md +++ b/docs/API_docs/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/docs/API_docs/methods/channels_editTitle.md b/docs/API_docs/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/docs/API_docs/methods/channels_editTitle.md +++ b/docs/API_docs/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/docs/API_docs/methods/channels_exportInvite.md b/docs/API_docs/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/docs/API_docs/methods/channels_exportInvite.md +++ b/docs/API_docs/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/docs/API_docs/methods/channels_exportMessageLink.md b/docs/API_docs/methods/channels_exportMessageLink.md index ee22d67c..d14abed7 100644 --- a/docs/API_docs/methods/channels_exportMessageLink.md +++ b/docs/API_docs/methods/channels_exportMessageLink.md @@ -13,8 +13,8 @@ Get the link of a message in a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| -|grouped|[CLICK ME Bool](../types/Bool.md) | Yes|Is this an album?| +|id|[int](../types/int.md) | Yes|The ID of the message| +|grouped|[Bool](../types/Bool.md) | Yes|Is this an album?| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -22,13 +22,6 @@ Get the link of a message in a channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, grouped=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/docs/API_docs/methods/channels_getAdminLog.md b/docs/API_docs/methods/channels_getAdminLog.md index 4a419778..1ffcf5c3 100644 --- a/docs/API_docs/methods/channels_getAdminLog.md +++ b/docs/API_docs/methods/channels_getAdminLog.md @@ -13,12 +13,12 @@ Get admin log of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|q|[CLICK ME string](../types/string.md) | Yes|Search query| -|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| +|q|[string](../types/string.md) | Yes|Search query| +|events\_filter|[ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| |admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME long](../types/long.md) | Yes|Minimum message ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[long](../types/long.md) | Yes|Maximum message ID to fetch| +|min\_id|[long](../types/long.md) | Yes|Minimum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) @@ -26,15 +26,6 @@ Get admin log of a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -83,3 +74,12 @@ Or, if you're into Lua: channels_AdminLogResults = channels.getAdminLog({channel=InputChannel, q='string', events_filter=ChannelAdminLogEventsFilter, admins={InputUser}, max_id=long, min_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/docs/API_docs/methods/channels_getChannels.md b/docs/API_docs/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/docs/API_docs/methods/channels_getChannels.md +++ b/docs/API_docs/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/docs/API_docs/methods/channels_getMessages.md b/docs/API_docs/methods/channels_getMessages.md index 3056e1f9..d4c2033a 100644 --- a/docs/API_docs/methods/channels_getMessages.md +++ b/docs/API_docs/methods/channels_getMessages.md @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={InputMessage}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/docs/API_docs/methods/channels_getParticipant.md b/docs/API_docs/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/docs/API_docs/methods/channels_getParticipant.md +++ b/docs/API_docs/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/docs/API_docs/methods/channels_getParticipants.md b/docs/API_docs/methods/channels_getParticipants.md index 3772ef4b..32b677d5 100644 --- a/docs/API_docs/methods/channels_getParticipants.md +++ b/docs/API_docs/methods/channels_getParticipants.md @@ -13,10 +13,10 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched participant IDs)| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched participant IDs)| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -24,17 +24,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -88,3 +77,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/channels_inviteToChannel.md b/docs/API_docs/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/docs/API_docs/methods/channels_inviteToChannel.md +++ b/docs/API_docs/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/docs/API_docs/methods/channels_joinChannel.md b/docs/API_docs/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/docs/API_docs/methods/channels_joinChannel.md +++ b/docs/API_docs/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/docs/API_docs/methods/channels_leaveChannel.md b/docs/API_docs/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/docs/API_docs/methods/channels_leaveChannel.md +++ b/docs/API_docs/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/docs/API_docs/methods/channels_readHistory.md b/docs/API_docs/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/docs/API_docs/methods/channels_readHistory.md +++ b/docs/API_docs/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/docs/API_docs/methods/channels_readMessageContents.md b/docs/API_docs/methods/channels_readMessageContents.md index aa9893c2..912adfcf 100644 --- a/docs/API_docs/methods/channels_readMessageContents.md +++ b/docs/API_docs/methods/channels_readMessageContents.md @@ -13,7 +13,7 @@ Mark channel/supergroup messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|id|Array of [CLICK ME int](../types/int.md) | Yes|List of message IDs| +|id|Array of [int](../types/int.md) | Yes|List of message IDs| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readMessageContents({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/docs/API_docs/methods/channels_reportSpam.md b/docs/API_docs/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/docs/API_docs/methods/channels_reportSpam.md +++ b/docs/API_docs/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/docs/API_docs/methods/channels_setStickers.md b/docs/API_docs/methods/channels_setStickers.md index d9be32a4..b5142d9f 100644 --- a/docs/API_docs/methods/channels_setStickers.md +++ b/docs/API_docs/methods/channels_setStickers.md @@ -13,7 +13,7 @@ Set the supergroup/channel stickerpack | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergoup| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Set the supergroup/channel stickerpack ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PARTICIPANTS_TOO_FEW|Not enough participants| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Bool = channels.setStickers({channel=InputChannel, stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PARTICIPANTS_TOO_FEW|Not enough participants| + + diff --git a/docs/API_docs/methods/channels_toggleInvites.md b/docs/API_docs/methods/channels_toggleInvites.md index e9e6450d..d437682f 100644 --- a/docs/API_docs/methods/channels_toggleInvites.md +++ b/docs/API_docs/methods/channels_toggleInvites.md @@ -13,7 +13,7 @@ Allow or disallow any user to invite users to this channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Allow or disallow any user to invite users to this channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/docs/API_docs/methods/channels_togglePreHistoryHidden.md b/docs/API_docs/methods/channels_togglePreHistoryHidden.md index d07784de..4374991f 100644 --- a/docs/API_docs/methods/channels_togglePreHistoryHidden.md +++ b/docs/API_docs/methods/channels_togglePreHistoryHidden.md @@ -13,7 +13,7 @@ Enable or disable hidden history for new channel/supergroup users | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable hidden history for new channel/supergroup users| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable hidden history for new channel/supergroup users| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_toggleSignatures.md b/docs/API_docs/methods/channels_toggleSignatures.md index 36d1eccb..d40bf67b 100644 --- a/docs/API_docs/methods/channels_toggleSignatures.md +++ b/docs/API_docs/methods/channels_toggleSignatures.md @@ -13,7 +13,7 @@ Toggle channel signatures | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Toggle channel signatures ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/docs/API_docs/methods/channels_updatePinnedMessage.md b/docs/API_docs/methods/channels_updatePinnedMessage.md index f8d10ece..aa2cc783 100644 --- a/docs/API_docs/methods/channels_updatePinnedMessage.md +++ b/docs/API_docs/methods/channels_updatePinnedMessage.md @@ -12,9 +12,9 @@ Set the pinned message of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Set the pinned message of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -81,3 +71,13 @@ Or, if you're into Lua: Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/docs/API_docs/methods/channels_updateUsername.md b/docs/API_docs/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/docs/API_docs/methods/channels_updateUsername.md +++ b/docs/API_docs/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/docs/API_docs/methods/contacts_block.md b/docs/API_docs/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/docs/API_docs/methods/contacts_block.md +++ b/docs/API_docs/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/docs/API_docs/methods/contacts_deleteContact.md b/docs/API_docs/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/docs/API_docs/methods/contacts_deleteContact.md +++ b/docs/API_docs/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/docs/API_docs/methods/contacts_deleteContacts.md b/docs/API_docs/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/docs/API_docs/methods/contacts_deleteContacts.md +++ b/docs/API_docs/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/contacts_getBlocked.md b/docs/API_docs/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/docs/API_docs/methods/contacts_getBlocked.md +++ b/docs/API_docs/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/docs/API_docs/methods/contacts_getContacts.md b/docs/API_docs/methods/contacts_getContacts.md index 589572dc..25085a19 100644 --- a/docs/API_docs/methods/contacts_getContacts.md +++ b/docs/API_docs/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|$ids is the list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`| +|hash|[int](../types/int.md) | Yes|$ids is the list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/docs/API_docs/methods/contacts_getTopPeers.md b/docs/API_docs/methods/contacts_getTopPeers.md index 4958e6b2..a8cd4c57 100644 --- a/docs/API_docs/methods/contacts_getTopPeers.md +++ b/docs/API_docs/methods/contacts_getTopPeers.md @@ -12,15 +12,15 @@ Get most used chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|correspondents|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch users?| -|bots\_pm|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch bots?| -|bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| -|phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?| -|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| -|channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| +|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?| +|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?| +|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?| +|phone\_calls|[Bool](../types/Bool.md) | Optional|Fetch phone calls?| +|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?| +|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| +|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|limit|[int](../types/int.md) | Yes|How many results to fetch| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| ### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) @@ -28,13 +28,6 @@ Get most used chats ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TYPES_EMPTY|The types field is empty| - - ### MadelineProto Example: @@ -87,3 +80,10 @@ Or, if you're into Lua: contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, phone_calls=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field is empty| + + diff --git a/docs/API_docs/methods/contacts_importCard.md b/docs/API_docs/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/docs/API_docs/methods/contacts_importCard.md +++ b/docs/API_docs/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/docs/API_docs/methods/contacts_importContacts.md b/docs/API_docs/methods/contacts_importContacts.md index ccc0eada..5b07237e 100644 --- a/docs/API_docs/methods/contacts_importContacts.md +++ b/docs/API_docs/methods/contacts_importContacts.md @@ -12,7 +12,7 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/docs/API_docs/methods/contacts_resetTopPeerRating.md b/docs/API_docs/methods/contacts_resetTopPeerRating.md index 4b5e96f1..15b07f96 100644 --- a/docs/API_docs/methods/contacts_resetTopPeerRating.md +++ b/docs/API_docs/methods/contacts_resetTopPeerRating.md @@ -12,7 +12,7 @@ Reset top peer rating for a certain category/peer | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| @@ -21,13 +21,6 @@ Reset top peer rating for a certain category/peer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/contacts_search.md b/docs/API_docs/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/docs/API_docs/methods/contacts_search.md +++ b/docs/API_docs/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/contacts_unblock.md b/docs/API_docs/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/docs/API_docs/methods/contacts_unblock.md +++ b/docs/API_docs/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/docs/API_docs/methods/help_getAppChangelog.md b/docs/API_docs/methods/help_getAppChangelog.md index eda473a6..183ebb8c 100644 --- a/docs/API_docs/methods/help_getAppChangelog.md +++ b/docs/API_docs/methods/help_getAppChangelog.md @@ -12,7 +12,7 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| +|prev\_app\_version|[string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/help_getCdnConfig.md b/docs/API_docs/methods/help_getCdnConfig.md index b98949ed..b7af5bb4 100644 --- a/docs/API_docs/methods/help_getCdnConfig.md +++ b/docs/API_docs/methods/help_getCdnConfig.md @@ -15,13 +15,6 @@ Get CDN configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: CdnConfig = help.getCdnConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/help_getConfig.md b/docs/API_docs/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/docs/API_docs/methods/help_getConfig.md +++ b/docs/API_docs/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/help_getRecentMeUrls.md b/docs/API_docs/methods/help_getRecentMeUrls.md index 29d2e21f..7a41f33c 100644 --- a/docs/API_docs/methods/help_getRecentMeUrls.md +++ b/docs/API_docs/methods/help_getRecentMeUrls.md @@ -12,7 +12,7 @@ Get recent t.me URLs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|referer|[CLICK ME string](../types/string.md) | Yes|Referrer| +|referer|[string](../types/string.md) | Yes|Referrer| ### Return type: [help\_RecentMeUrls](../types/help_RecentMeUrls.md) diff --git a/docs/API_docs/methods/help_saveAppLog.md b/docs/API_docs/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/docs/API_docs/methods/help_saveAppLog.md +++ b/docs/API_docs/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/help_setBotUpdatesStatus.md b/docs/API_docs/methods/help_setBotUpdatesStatus.md index a1a3ab1b..1766ee14 100644 --- a/docs/API_docs/methods/help_setBotUpdatesStatus.md +++ b/docs/API_docs/methods/help_setBotUpdatesStatus.md @@ -12,8 +12,8 @@ Set the update status of webhook | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| -|message|[CLICK ME string](../types/string.md) | Yes|Message| +|pending\_updates\_count|[int](../types/int.md) | Yes|Pending update count| +|message|[string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/initConnection.md b/docs/API_docs/methods/initConnection.md index c66aa8b1..2d195613 100644 --- a/docs/API_docs/methods/initConnection.md +++ b/docs/API_docs/methods/initConnection.md @@ -12,14 +12,14 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|system\_lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| -|lang\_pack|[CLICK ME string](../types/string.md) | Yes|Language pack to use| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|system\_lang\_code|[string](../types/string.md) | Yes|Language code| +|lang\_pack|[string](../types/string.md) | Yes|Language pack to use| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -27,14 +27,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -94,3 +86,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', system_lang_code='string', lang_pack='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/docs/API_docs/methods/invokeAfterMsg.md b/docs/API_docs/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/docs/API_docs/methods/invokeAfterMsg.md +++ b/docs/API_docs/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/docs/API_docs/methods/invokeAfterMsgs.md b/docs/API_docs/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/docs/API_docs/methods/invokeAfterMsgs.md +++ b/docs/API_docs/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/docs/API_docs/methods/invokeWithLayer.md b/docs/API_docs/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/docs/API_docs/methods/invokeWithLayer.md +++ b/docs/API_docs/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/docs/API_docs/methods/invokeWithoutUpdates.md b/docs/API_docs/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/docs/API_docs/methods/invokeWithoutUpdates.md +++ b/docs/API_docs/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/docs/API_docs/methods/langpack_getDifference.md b/docs/API_docs/methods/langpack_getDifference.md index 0a6512e4..1860cc49 100644 --- a/docs/API_docs/methods/langpack_getDifference.md +++ b/docs/API_docs/methods/langpack_getDifference.md @@ -12,7 +12,7 @@ Get language pack updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|from\_version|[CLICK ME int](../types/int.md) | Yes|Previous version| +|from\_version|[int](../types/int.md) | Yes|Previous version| ### Return type: [LangPackDifference](../types/LangPackDifference.md) @@ -20,13 +20,6 @@ Get language pack updates ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: LangPackDifference = langpack.getDifference({from_version=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/docs/API_docs/methods/langpack_getLangPack.md b/docs/API_docs/methods/langpack_getLangPack.md index 45a9ca47..7e64aec9 100644 --- a/docs/API_docs/methods/langpack_getLangPack.md +++ b/docs/API_docs/methods/langpack_getLangPack.md @@ -12,7 +12,7 @@ Get language pack | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [LangPackDifference](../types/LangPackDifference.md) @@ -20,13 +20,6 @@ Get language pack ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: LangPackDifference = langpack.getLangPack({lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/docs/API_docs/methods/langpack_getLanguages.md b/docs/API_docs/methods/langpack_getLanguages.md index b573a5eb..c4ea44ca 100644 --- a/docs/API_docs/methods/langpack_getLanguages.md +++ b/docs/API_docs/methods/langpack_getLanguages.md @@ -15,13 +15,6 @@ Get available languages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Vector_of_LangPackLanguage = langpack.getLanguages({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/docs/API_docs/methods/langpack_getStrings.md b/docs/API_docs/methods/langpack_getStrings.md index 841b02db..4953e1c0 100644 --- a/docs/API_docs/methods/langpack_getStrings.md +++ b/docs/API_docs/methods/langpack_getStrings.md @@ -12,8 +12,8 @@ Get language pack strings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| -|keys|Array of [CLICK ME string](../types/string.md) | Yes|Keys| +|lang\_code|[string](../types/string.md) | Yes|Language code| +|keys|Array of [string](../types/string.md) | Yes|Keys| ### Return type: [Vector\_of\_LangPackString](../types/LangPackString.md) @@ -21,13 +21,6 @@ Get language pack strings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Vector_of_LangPackString = langpack.getStrings({lang_code='string', keys={'string'}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/docs/API_docs/methods/messages_addChatUser.md b/docs/API_docs/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/docs/API_docs/methods/messages_addChatUser.md +++ b/docs/API_docs/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/docs/API_docs/methods/messages_checkChatInvite.md b/docs/API_docs/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/docs/API_docs/methods/messages_checkChatInvite.md +++ b/docs/API_docs/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/docs/API_docs/methods/messages_clearRecentStickers.md b/docs/API_docs/methods/messages_clearRecentStickers.md index 1d6ec8c9..72c4844b 100644 --- a/docs/API_docs/methods/messages_clearRecentStickers.md +++ b/docs/API_docs/methods/messages_clearRecentStickers.md @@ -12,7 +12,7 @@ Clear all recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_createChat.md b/docs/API_docs/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/docs/API_docs/methods/messages_createChat.md +++ b/docs/API_docs/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/docs/API_docs/methods/messages_deleteChatUser.md b/docs/API_docs/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/docs/API_docs/methods/messages_deleteChatUser.md +++ b/docs/API_docs/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/docs/API_docs/methods/messages_deleteHistory.md b/docs/API_docs/methods/messages_deleteHistory.md index 45e9890d..601d1876 100644 --- a/docs/API_docs/methods/messages_deleteHistory.md +++ b/docs/API_docs/methods/messages_deleteHistory.md @@ -12,9 +12,9 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|just\_clear|[CLICK ME Bool](../types/Bool.md) | Optional|Only clear it from your side| +|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,13 +22,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/messages_deleteMessages.md b/docs/API_docs/methods/messages_deleteMessages.md index c8670444..900e9d0e 100644 --- a/docs/API_docs/methods/messages_deleteMessages.md +++ b/docs/API_docs/methods/messages_deleteMessages.md @@ -12,8 +12,8 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|revoke|[CLICK ME Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,13 +21,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({revoke=Bool, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/docs/API_docs/methods/messages_editChatAdmin.md b/docs/API_docs/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/docs/API_docs/methods/messages_editChatAdmin.md +++ b/docs/API_docs/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/docs/API_docs/methods/messages_editChatPhoto.md b/docs/API_docs/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/docs/API_docs/methods/messages_editChatPhoto.md +++ b/docs/API_docs/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/docs/API_docs/methods/messages_editChatTitle.md b/docs/API_docs/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/docs/API_docs/methods/messages_editChatTitle.md +++ b/docs/API_docs/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/docs/API_docs/methods/messages_editInlineBotMessage.md b/docs/API_docs/methods/messages_editInlineBotMessage.md index 21a55e36..5a6b840e 100644 --- a/docs/API_docs/methods/messages_editInlineBotMessage.md +++ b/docs/API_docs/methods/messages_editInlineBotMessage.md @@ -12,14 +12,14 @@ Edit a sent inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional|Stop live location| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| ### Return type: [Bool](../types/Bool.md) @@ -27,14 +27,6 @@ Edit a sent inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| - - ### MadelineProto Example: @@ -124,3 +116,11 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/docs/API_docs/methods/messages_editMessage.md b/docs/API_docs/methods/messages_editMessage.md index e3178d97..7c85d566 100644 --- a/docs/API_docs/methods/messages_editMessage.md +++ b/docs/API_docs/methods/messages_editMessage.md @@ -12,15 +12,15 @@ Edit a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional|Stop live location| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| ### Return type: [Updates](../types/Updates.md) @@ -28,22 +28,6 @@ Edit a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -133,3 +117,19 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/docs/API_docs/methods/messages_exportChatInvite.md b/docs/API_docs/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/docs/API_docs/methods/messages_exportChatInvite.md +++ b/docs/API_docs/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/docs/API_docs/methods/messages_faveSticker.md b/docs/API_docs/methods/messages_faveSticker.md index ee1eb66a..8b1534ea 100644 --- a/docs/API_docs/methods/messages_faveSticker.md +++ b/docs/API_docs/methods/messages_faveSticker.md @@ -13,7 +13,7 @@ Add a sticker to favorites | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| -|unfave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove it from favorites?| +|unfave|[Bool](../types/Bool.md) | Yes|Remove it from favorites?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker to favorites ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.faveSticker({id=InputDocument, unfave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/docs/API_docs/methods/messages_forwardMessages.md b/docs/API_docs/methods/messages_forwardMessages.md index 2dbcfe21..e4a3d241 100644 --- a/docs/API_docs/methods/messages_forwardMessages.md +++ b/docs/API_docs/methods/messages_forwardMessages.md @@ -12,12 +12,12 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[CLICK ME Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|grouped|[CLICK ME Bool](../types/Bool.md) | Optional|Set to true if forwarding albums| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| +|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| +|grouped|[Bool](../types/Bool.md) | Optional|Set to true if forwarding albums| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -26,34 +26,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -111,3 +83,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, grouped=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/messages_getAllChats.md b/docs/API_docs/methods/messages_getAllChats.md index 513fc06f..c4851369 100644 --- a/docs/API_docs/methods/messages_getAllChats.md +++ b/docs/API_docs/methods/messages_getAllChats.md @@ -12,7 +12,7 @@ Get all chats (not supergroups or channels) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/docs/API_docs/methods/messages_getAllStickers.md b/docs/API_docs/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/docs/API_docs/methods/messages_getAllStickers.md +++ b/docs/API_docs/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/docs/API_docs/methods/messages_getArchivedStickers.md b/docs/API_docs/methods/messages_getArchivedStickers.md index ee36b542..dfd5c006 100644 --- a/docs/API_docs/methods/messages_getArchivedStickers.md +++ b/docs/API_docs/methods/messages_getArchivedStickers.md @@ -12,9 +12,9 @@ Get all archived stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| +|masks|[Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| +|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/docs/API_docs/methods/messages_getAttachedStickers.md b/docs/API_docs/methods/messages_getAttachedStickers.md index 9f8a66c5..8f51f38d 100644 --- a/docs/API_docs/methods/messages_getAttachedStickers.md +++ b/docs/API_docs/methods/messages_getAttachedStickers.md @@ -12,7 +12,7 @@ Get stickers attachable to images | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/docs/API_docs/methods/messages_getBotCallbackAnswer.md b/docs/API_docs/methods/messages_getBotCallbackAnswer.md index 0136227f..4b8887ad 100644 --- a/docs/API_docs/methods/messages_getBotCallbackAnswer.md +++ b/docs/API_docs/methods/messages_getBotCallbackAnswer.md @@ -12,10 +12,10 @@ Get the callback answer of a bot (after clicking a button) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|game|[Bool](../types/Bool.md) | Optional|Is this a game?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) @@ -23,17 +23,6 @@ Get the callback answer of a bot (after clicking a button) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|DATA_INVALID|Encrypted data invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: messages_BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/messages_getChats.md b/docs/API_docs/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/docs/API_docs/methods/messages_getChats.md +++ b/docs/API_docs/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/messages_getCommonChats.md b/docs/API_docs/methods/messages_getCommonChats.md index 15ed6713..6ffa0948 100644 --- a/docs/API_docs/methods/messages_getCommonChats.md +++ b/docs/API_docs/methods/messages_getCommonChats.md @@ -13,8 +13,8 @@ Get chats in common with a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -22,13 +22,6 @@ Get chats in common with a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_Chats = messages.getCommonChats({user_id=InputUser, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/docs/API_docs/methods/messages_getDialogs.md b/docs/API_docs/methods/messages_getDialogs.md index 53f9ac62..1035e8ce 100644 --- a/docs/API_docs/methods/messages_getDialogs.md +++ b/docs/API_docs/methods/messages_getDialogs.md @@ -12,11 +12,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|exclude\_pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -24,16 +24,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/messages_getDocumentByHash.md b/docs/API_docs/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/docs/API_docs/methods/messages_getDocumentByHash.md +++ b/docs/API_docs/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/docs/API_docs/methods/messages_getFavedStickers.md b/docs/API_docs/methods/messages_getFavedStickers.md index 8ef3e565..dea1e5ec 100644 --- a/docs/API_docs/methods/messages_getFavedStickers.md +++ b/docs/API_docs/methods/messages_getFavedStickers.md @@ -12,7 +12,7 @@ Get favorite stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/docs/API_docs/methods/messages_getFeaturedStickers.md b/docs/API_docs/methods/messages_getFeaturedStickers.md index 8e49e1ef..af7f69a0 100644 --- a/docs/API_docs/methods/messages_getFeaturedStickers.md +++ b/docs/API_docs/methods/messages_getFeaturedStickers.md @@ -12,7 +12,7 @@ Get featured stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/docs/API_docs/methods/messages_getGameHighScores.md b/docs/API_docs/methods/messages_getGameHighScores.md index 113e4647..af3f3915 100644 --- a/docs/API_docs/methods/messages_getGameHighScores.md +++ b/docs/API_docs/methods/messages_getGameHighScores.md @@ -13,7 +13,7 @@ Get high scores of a game | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -22,14 +22,6 @@ Get high scores of a game ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -79,3 +71,11 @@ Or, if you're into Lua: messages_HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/docs/API_docs/methods/messages_getHistory.md b/docs/API_docs/methods/messages_getHistory.md index 585a2b52..86a20101 100644 --- a/docs/API_docs/methods/messages_getHistory.md +++ b/docs/API_docs/methods/messages_getHistory.md @@ -13,13 +13,13 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|hash of old messages, $MadelineProto->gen_vector_hash($parsedMessageIds)| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +|hash|[int](../types/int.md) | Yes|hash of old messages, $MadelineProto->gen_vector_hash($parsedMessageIds)| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,18 +27,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -89,3 +77,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/messages_getInlineBotResults.md b/docs/API_docs/methods/messages_getInlineBotResults.md index 4d86caf5..207624a7 100644 --- a/docs/API_docs/methods/messages_getInlineBotResults.md +++ b/docs/API_docs/methods/messages_getInlineBotResults.md @@ -14,9 +14,9 @@ Call inline bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -24,16 +24,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/messages_getInlineGameHighScores.md b/docs/API_docs/methods/messages_getInlineGameHighScores.md index d5a80005..e03bc273 100644 --- a/docs/API_docs/methods/messages_getInlineGameHighScores.md +++ b/docs/API_docs/methods/messages_getInlineGameHighScores.md @@ -12,7 +12,7 @@ Get high scores of a game sent in an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -21,14 +21,6 @@ Get high scores of a game sent in an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/docs/API_docs/methods/messages_getMaskStickers.md b/docs/API_docs/methods/messages_getMaskStickers.md index 70e2e6d4..1fbd9346 100644 --- a/docs/API_docs/methods/messages_getMaskStickers.md +++ b/docs/API_docs/methods/messages_getMaskStickers.md @@ -12,7 +12,7 @@ Get masks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/docs/API_docs/methods/messages_getMessageEditData.md b/docs/API_docs/methods/messages_getMessageEditData.md index 34f8534f..00c63d28 100644 --- a/docs/API_docs/methods/messages_getMessageEditData.md +++ b/docs/API_docs/methods/messages_getMessageEditData.md @@ -13,7 +13,7 @@ Check if about to edit a message or a media caption | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) @@ -21,14 +21,6 @@ Check if about to edit a message or a media caption ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/docs/API_docs/methods/messages_getMessagesViews.md b/docs/API_docs/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/docs/API_docs/methods/messages_getMessagesViews.md +++ b/docs/API_docs/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/messages_getPeerDialogs.md b/docs/API_docs/methods/messages_getPeerDialogs.md index 063b6e7d..000e8eb6 100644 --- a/docs/API_docs/methods/messages_getPeerDialogs.md +++ b/docs/API_docs/methods/messages_getPeerDialogs.md @@ -20,14 +20,6 @@ Get dialog info of peers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: messages_PeerDialogs = messages.getPeerDialogs({peers={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/messages_getPeerSettings.md b/docs/API_docs/methods/messages_getPeerSettings.md index a18126f0..5a3e9349 100644 --- a/docs/API_docs/methods/messages_getPeerSettings.md +++ b/docs/API_docs/methods/messages_getPeerSettings.md @@ -20,14 +20,6 @@ Get the settings of apeer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: PeerSettings = messages.getPeerSettings({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/messages_getRecentLocations.md b/docs/API_docs/methods/messages_getRecentLocations.md index a1bad267..ab3fb8e4 100644 --- a/docs/API_docs/methods/messages_getRecentLocations.md +++ b/docs/API_docs/methods/messages_getRecentLocations.md @@ -13,7 +13,7 @@ Get recent locations | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to search locations| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/docs/API_docs/methods/messages_getRecentStickers.md b/docs/API_docs/methods/messages_getRecentStickers.md index 0c5ae0c6..629a2bda 100644 --- a/docs/API_docs/methods/messages_getRecentStickers.md +++ b/docs/API_docs/methods/messages_getRecentStickers.md @@ -12,8 +12,8 @@ Get recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/docs/API_docs/methods/messages_getSavedGifs.md b/docs/API_docs/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/docs/API_docs/methods/messages_getSavedGifs.md +++ b/docs/API_docs/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/docs/API_docs/methods/messages_getStickerSet.md b/docs/API_docs/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/docs/API_docs/methods/messages_getStickerSet.md +++ b/docs/API_docs/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/docs/API_docs/methods/messages_getStickers.md b/docs/API_docs/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/docs/API_docs/methods/messages_getStickers.md +++ b/docs/API_docs/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/docs/API_docs/methods/messages_getUnreadMentions.md b/docs/API_docs/methods/messages_getUnreadMentions.md index b8d7b5a5..6abe55c6 100644 --- a/docs/API_docs/methods/messages_getUnreadMentions.md +++ b/docs/API_docs/methods/messages_getUnreadMentions.md @@ -13,11 +13,11 @@ Get unread mentions | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The offset| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|The additional offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|The minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The offset| +|add\_offset|[int](../types/int.md) | Yes|The additional offset| +|limit|[int](../types/int.md) | Yes|The number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|The minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -25,13 +25,6 @@ Get unread mentions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: messages_Messages = messages.getUnreadMentions({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/messages_getWebPage.md b/docs/API_docs/methods/messages_getWebPage.md index 19ca94b9..1b533ebd 100644 --- a/docs/API_docs/methods/messages_getWebPage.md +++ b/docs/API_docs/methods/messages_getWebPage.md @@ -12,8 +12,8 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|url|[CLICK ME string](../types/string.md) | Yes|URL| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|url|[string](../types/string.md) | Yes|URL| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) @@ -21,13 +21,6 @@ Get webpage preview ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|WC_CONVERT_URL_INVALID|WC convert URL invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: WebPage = messages.getWebPage({url='string', hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|WC_CONVERT_URL_INVALID|WC convert URL invalid| + + diff --git a/docs/API_docs/methods/messages_getWebPagePreview.md b/docs/API_docs/methods/messages_getWebPagePreview.md index f661733b..43e5e516 100644 --- a/docs/API_docs/methods/messages_getWebPagePreview.md +++ b/docs/API_docs/methods/messages_getWebPagePreview.md @@ -12,8 +12,8 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text| +|message|[string](../types/string.md) | Yes|Extract preview from this message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/docs/API_docs/methods/messages_hideReportSpam.md b/docs/API_docs/methods/messages_hideReportSpam.md index 30523f2a..0bf711ea 100644 --- a/docs/API_docs/methods/messages_hideReportSpam.md +++ b/docs/API_docs/methods/messages_hideReportSpam.md @@ -20,13 +20,6 @@ Hide report spam popup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.hideReportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/messages_importChatInvite.md b/docs/API_docs/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/docs/API_docs/methods/messages_importChatInvite.md +++ b/docs/API_docs/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/docs/API_docs/methods/messages_installStickerSet.md b/docs/API_docs/methods/messages_installStickerSet.md index 20f90b71..d6caf555 100644 --- a/docs/API_docs/methods/messages_installStickerSet.md +++ b/docs/API_docs/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/docs/API_docs/methods/messages_migrateChat.md b/docs/API_docs/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/docs/API_docs/methods/messages_migrateChat.md +++ b/docs/API_docs/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/docs/API_docs/methods/messages_readEncryptedHistory.md b/docs/API_docs/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/docs/API_docs/methods/messages_readEncryptedHistory.md +++ b/docs/API_docs/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/docs/API_docs/methods/messages_readFeaturedStickers.md b/docs/API_docs/methods/messages_readFeaturedStickers.md index 050371da..3b01171b 100644 --- a/docs/API_docs/methods/messages_readFeaturedStickers.md +++ b/docs/API_docs/methods/messages_readFeaturedStickers.md @@ -12,7 +12,7 @@ Mark new featured stickers as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| +|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_readHistory.md b/docs/API_docs/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/docs/API_docs/methods/messages_readHistory.md +++ b/docs/API_docs/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/messages_readMessageContents.md b/docs/API_docs/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/docs/API_docs/methods/messages_readMessageContents.md +++ b/docs/API_docs/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/docs/API_docs/methods/messages_receivedMessages.md b/docs/API_docs/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/docs/API_docs/methods/messages_receivedMessages.md +++ b/docs/API_docs/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/docs/API_docs/methods/messages_reorderPinnedDialogs.md b/docs/API_docs/methods/messages_reorderPinnedDialogs.md index 94d3b2d4..232117e8 100644 --- a/docs/API_docs/methods/messages_reorderPinnedDialogs.md +++ b/docs/API_docs/methods/messages_reorderPinnedDialogs.md @@ -12,7 +12,7 @@ Reorder pinned dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|force|[Bool](../types/Bool.md) | Optional|Force reordering| |order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| @@ -21,13 +21,6 @@ Reorder pinned dialogs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.reorderPinnedDialogs({force=Bool, order={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/messages_reorderStickerSets.md b/docs/API_docs/methods/messages_reorderStickerSets.md index 66f5e682..6a71da86 100644 --- a/docs/API_docs/methods/messages_reorderStickerSets.md +++ b/docs/API_docs/methods/messages_reorderStickerSets.md @@ -12,8 +12,8 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_reportEncryptedSpam.md b/docs/API_docs/methods/messages_reportEncryptedSpam.md index cd03c35c..988e0101 100644 --- a/docs/API_docs/methods/messages_reportEncryptedSpam.md +++ b/docs/API_docs/methods/messages_reportEncryptedSpam.md @@ -20,13 +20,6 @@ Report for spam a secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportEncryptedSpam({peer=InputEncryptedChat, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/docs/API_docs/methods/messages_reportSpam.md b/docs/API_docs/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/docs/API_docs/methods/messages_reportSpam.md +++ b/docs/API_docs/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/messages_saveDraft.md b/docs/API_docs/methods/messages_saveDraft.md index 59b33b03..60d72c1e 100644 --- a/docs/API_docs/methods/messages_saveDraft.md +++ b/docs/API_docs/methods/messages_saveDraft.md @@ -12,11 +12,11 @@ Save a message draft | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,13 +25,6 @@ Save a message draft ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -104,3 +97,10 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/messages_saveGif.md b/docs/API_docs/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/docs/API_docs/methods/messages_saveGif.md +++ b/docs/API_docs/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/docs/API_docs/methods/messages_saveRecentSticker.md b/docs/API_docs/methods/messages_saveRecentSticker.md index 55757080..d2418881 100644 --- a/docs/API_docs/methods/messages_saveRecentSticker.md +++ b/docs/API_docs/methods/messages_saveRecentSticker.md @@ -12,9 +12,9 @@ Add a sticker to recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Add a sticker to recent stickers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.saveRecentSticker({attached=Bool, id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/docs/API_docs/methods/messages_search.md b/docs/API_docs/methods/messages_search.md index 9253828a..96e0463e 100644 --- a/docs/API_docs/methods/messages_search.md +++ b/docs/API_docs/methods/messages_search.md @@ -13,16 +13,16 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| +|q|[string](../types/string.md) | Yes|What to search| |from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|Offset | -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message id to return| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset\_id|[int](../types/int.md) | Yes|Offset | +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of results to return| +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|min\_id|[int](../types/int.md) | Yes|Minumum message id to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -30,19 +30,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -99,3 +86,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', from_id=InputUser, filter=MessagesFilter, min_date=int, max_date=int, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/docs/API_docs/methods/messages_searchGifs.md b/docs/API_docs/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/docs/API_docs/methods/messages_searchGifs.md +++ b/docs/API_docs/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/docs/API_docs/methods/messages_searchGlobal.md b/docs/API_docs/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/docs/API_docs/methods/messages_searchGlobal.md +++ b/docs/API_docs/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/docs/API_docs/methods/messages_sendEncrypted.md b/docs/API_docs/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/docs/API_docs/methods/messages_sendEncrypted.md +++ b/docs/API_docs/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/docs/API_docs/methods/messages_sendEncryptedFile.md b/docs/API_docs/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/docs/API_docs/methods/messages_sendEncryptedFile.md +++ b/docs/API_docs/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/docs/API_docs/methods/messages_sendEncryptedService.md b/docs/API_docs/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/docs/API_docs/methods/messages_sendEncryptedService.md +++ b/docs/API_docs/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/docs/API_docs/methods/messages_sendInlineBotResult.md b/docs/API_docs/methods/messages_sendInlineBotResult.md index 758aa97f..d1f9fbd0 100644 --- a/docs/API_docs/methods/messages_sendInlineBotResult.md +++ b/docs/API_docs/methods/messages_sendInlineBotResult.md @@ -12,13 +12,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -26,18 +26,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/docs/API_docs/methods/messages_sendMedia.md b/docs/API_docs/methods/messages_sendMedia.md index 19ce2e32..7852be52 100644 --- a/docs/API_docs/methods/messages_sendMedia.md +++ b/docs/API_docs/methods/messages_sendMedia.md @@ -12,15 +12,15 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|message|[CLICK ME string](../types/string.md) | Yes|The caption| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text| +|message|[string](../types/string.md) | Yes|The caption| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,34 +29,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -144,3 +116,31 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/messages_sendMessage.md b/docs/API_docs/methods/messages_sendMessage.md index 83dc6c8b..ba76f230 100644 --- a/docs/API_docs/methods/messages_sendMessage.md +++ b/docs/API_docs/methods/messages_sendMessage.md @@ -12,15 +12,15 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,33 +29,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -143,3 +116,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/API_docs/methods/messages_sendMultiMedia.md b/docs/API_docs/methods/messages_sendMultiMedia.md index 4831ff6f..77fa2031 100644 --- a/docs/API_docs/methods/messages_sendMultiMedia.md +++ b/docs/API_docs/methods/messages_sendMultiMedia.md @@ -12,12 +12,12 @@ Send an album | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notification?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notification?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the album| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|multi\_media|Array of [CLICK ME InputSingleMedia](../types/InputSingleMedia.md) | Yes|The album| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|multi\_media|Array of [InputSingleMedia](../types/InputSingleMedia.md) | Yes|The album| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_sendScreenshotNotification.md b/docs/API_docs/methods/messages_sendScreenshotNotification.md index e823fd52..9db86b56 100644 --- a/docs/API_docs/methods/messages_sendScreenshotNotification.md +++ b/docs/API_docs/methods/messages_sendScreenshotNotification.md @@ -13,7 +13,7 @@ Send screenshot notification | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Send screenshot notification ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = messages.sendScreenshotNotification({peer=InputPeer, reply_to_msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/messages_setBotCallbackAnswer.md b/docs/API_docs/methods/messages_setBotCallbackAnswer.md index e221ccca..34c7bb16 100644 --- a/docs/API_docs/methods/messages_setBotCallbackAnswer.md +++ b/docs/API_docs/methods/messages_setBotCallbackAnswer.md @@ -12,11 +12,11 @@ Bots only: set the callback answer (after a button was clicked) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|message|[CLICK ME string](../types/string.md) | Optional|The message| -|url|[CLICK ME string](../types/string.md) | Optional|The URL| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| +|url|[string](../types/string.md) | Optional|The URL| +|cache\_time|[int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) @@ -24,13 +24,6 @@ Bots only: set the callback answer (after a button was clicked) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -90,3 +83,10 @@ Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/docs/API_docs/methods/messages_setBotPrecheckoutResults.md b/docs/API_docs/methods/messages_setBotPrecheckoutResults.md index 7e3fc3c2..f631bf0c 100644 --- a/docs/API_docs/methods/messages_setBotPrecheckoutResults.md +++ b/docs/API_docs/methods/messages_setBotPrecheckoutResults.md @@ -12,9 +12,9 @@ Bots only: set precheckout results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| +|success|[Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set precheckout results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ERROR_TEXT_EMPTY|The provided error message is empty| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotPrecheckoutResults({success=Bool, query_id=long, error='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ERROR_TEXT_EMPTY|The provided error message is empty| + + diff --git a/docs/API_docs/methods/messages_setBotShippingResults.md b/docs/API_docs/methods/messages_setBotShippingResults.md index 3d9f0ae2..915cfebf 100644 --- a/docs/API_docs/methods/messages_setBotShippingResults.md +++ b/docs/API_docs/methods/messages_setBotShippingResults.md @@ -12,9 +12,9 @@ Bots only: set shipping results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set shipping results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotShippingResults({query_id=long, error='string', shipping_options={ShippingOption}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/docs/API_docs/methods/messages_setEncryptedTyping.md b/docs/API_docs/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/docs/API_docs/methods/messages_setEncryptedTyping.md +++ b/docs/API_docs/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/docs/API_docs/methods/messages_setGameScore.md b/docs/API_docs/methods/messages_setGameScore.md index 90594a1d..c3d5a2c7 100644 --- a/docs/API_docs/methods/messages_setGameScore.md +++ b/docs/API_docs/methods/messages_setGameScore.md @@ -12,12 +12,12 @@ Set the game score | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) @@ -25,14 +25,6 @@ Set the game score ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: Updates = messages.setGameScore({edit_message=Bool, force=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/docs/API_docs/methods/messages_setInlineBotResults.md b/docs/API_docs/methods/messages_setInlineBotResults.md index d4ba6e65..e46598e2 100644 --- a/docs/API_docs/methods/messages_setInlineBotResults.md +++ b/docs/API_docs/methods/messages_setInlineBotResults.md @@ -12,13 +12,13 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) @@ -26,23 +26,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -100,3 +83,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/docs/API_docs/methods/messages_setInlineGameScore.md b/docs/API_docs/methods/messages_setInlineGameScore.md index 2b7326f3..d33da5ef 100644 --- a/docs/API_docs/methods/messages_setInlineGameScore.md +++ b/docs/API_docs/methods/messages_setInlineGameScore.md @@ -12,11 +12,11 @@ Set the game score of an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) @@ -24,14 +24,6 @@ Set the game score of an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -85,3 +77,11 @@ Or, if you're into Lua: Bool = messages.setInlineGameScore({edit_message=Bool, force=Bool, id=InputBotInlineMessageID, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/docs/API_docs/methods/messages_setTyping.md b/docs/API_docs/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/docs/API_docs/methods/messages_setTyping.md +++ b/docs/API_docs/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/docs/API_docs/methods/messages_startBot.md b/docs/API_docs/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/docs/API_docs/methods/messages_startBot.md +++ b/docs/API_docs/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/docs/API_docs/methods/messages_toggleChatAdmins.md b/docs/API_docs/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/docs/API_docs/methods/messages_toggleChatAdmins.md +++ b/docs/API_docs/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/docs/API_docs/methods/messages_toggleDialogPin.md b/docs/API_docs/methods/messages_toggleDialogPin.md index 14332533..6c57ce0a 100644 --- a/docs/API_docs/methods/messages_toggleDialogPin.md +++ b/docs/API_docs/methods/messages_toggleDialogPin.md @@ -12,7 +12,7 @@ Pin or unpin dialog | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| @@ -21,13 +21,6 @@ Pin or unpin dialog ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.toggleDialogPin({pinned=Bool, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/messages_uninstallStickerSet.md b/docs/API_docs/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/docs/API_docs/methods/messages_uninstallStickerSet.md +++ b/docs/API_docs/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/docs/API_docs/methods/messages_uploadMedia.md b/docs/API_docs/methods/messages_uploadMedia.md index c09da017..4d511a15 100644 --- a/docs/API_docs/methods/messages_uploadMedia.md +++ b/docs/API_docs/methods/messages_uploadMedia.md @@ -21,15 +21,6 @@ Upload a file without sending it to anyone ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|MEDIA_INVALID|Media invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: MessageMedia = messages.uploadMedia({peer=InputPeer, media=InputMedia, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|MEDIA_INVALID|Media invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/docs/API_docs/methods/payments_clearSavedInfo.md b/docs/API_docs/methods/payments_clearSavedInfo.md index 8b83266f..117db209 100644 --- a/docs/API_docs/methods/payments_clearSavedInfo.md +++ b/docs/API_docs/methods/payments_clearSavedInfo.md @@ -12,8 +12,8 @@ Clear saved payments info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| +|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/payments_getPaymentForm.md b/docs/API_docs/methods/payments_getPaymentForm.md index 3bdb9ff2..f68aa039 100644 --- a/docs/API_docs/methods/payments_getPaymentForm.md +++ b/docs/API_docs/methods/payments_getPaymentForm.md @@ -12,7 +12,7 @@ Get payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|msg\_id|[int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) @@ -20,13 +20,6 @@ Get payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentForm = payments.getPaymentForm({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/docs/API_docs/methods/payments_getPaymentReceipt.md b/docs/API_docs/methods/payments_getPaymentReceipt.md index a881aeb7..13073925 100644 --- a/docs/API_docs/methods/payments_getPaymentReceipt.md +++ b/docs/API_docs/methods/payments_getPaymentReceipt.md @@ -12,7 +12,7 @@ Get payment receipt | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|msg\_id|[int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) @@ -20,13 +20,6 @@ Get payment receipt ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentReceipt = payments.getPaymentReceipt({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/docs/API_docs/methods/payments_sendPaymentForm.md b/docs/API_docs/methods/payments_sendPaymentForm.md index 79758b56..678b749b 100644 --- a/docs/API_docs/methods/payments_sendPaymentForm.md +++ b/docs/API_docs/methods/payments_sendPaymentForm.md @@ -12,10 +12,10 @@ Bots only: send payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +|msg\_id|[int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) @@ -23,13 +23,6 @@ Bots only: send payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: payments_PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/docs/API_docs/methods/payments_validateRequestedInfo.md b/docs/API_docs/methods/payments_validateRequestedInfo.md index d473f97c..df6a9ba9 100644 --- a/docs/API_docs/methods/payments_validateRequestedInfo.md +++ b/docs/API_docs/methods/payments_validateRequestedInfo.md @@ -12,9 +12,9 @@ Validate requested payment info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +|save|[Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) @@ -22,13 +22,6 @@ Validate requested payment info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: payments_ValidatedRequestedInfo = payments.validateRequestedInfo({save=Bool, msg_id=int, info=PaymentRequestedInfo, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/docs/API_docs/methods/phone_receivedCall.md b/docs/API_docs/methods/phone_receivedCall.md index 17095622..6141a0ab 100644 --- a/docs/API_docs/methods/phone_receivedCall.md +++ b/docs/API_docs/methods/phone_receivedCall.md @@ -12,7 +12,7 @@ Notify server that you received a call (server will refuse all incoming calls un | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| ### Return type: [Bool](../types/Bool.md) @@ -20,14 +20,6 @@ Notify server that you received a call (server will refuse all incoming calls un ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_ALREADY_DECLINED|The call was already declined| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = phone.receivedCall({peer=InputPhoneCall, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_ALREADY_DECLINED|The call was already declined| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/docs/API_docs/methods/phone_saveCallDebug.md b/docs/API_docs/methods/phone_saveCallDebug.md index 0ff049a8..9f3daa18 100644 --- a/docs/API_docs/methods/phone_saveCallDebug.md +++ b/docs/API_docs/methods/phone_saveCallDebug.md @@ -12,8 +12,8 @@ Save call debugging info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Debugging info| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| +|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Save call debugging info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| -|DATA_JSON_INVALID|The provided JSON data is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = phone.saveCallDebug({peer=InputPhoneCall, debug=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| +|DATA_JSON_INVALID|The provided JSON data is invalid| + + diff --git a/docs/API_docs/methods/phone_setCallRating.md b/docs/API_docs/methods/phone_setCallRating.md index d0aab7e0..d9833492 100644 --- a/docs/API_docs/methods/phone_setCallRating.md +++ b/docs/API_docs/methods/phone_setCallRating.md @@ -12,9 +12,9 @@ Set phone call rating | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[CLICK ME int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[CLICK ME string](../types/string.md) | Yes|An optional comment| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| +|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| +|comment|[string](../types/string.md) | Yes|An optional comment| ### Return type: [Updates](../types/Updates.md) @@ -22,13 +22,6 @@ Set phone call rating ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Updates = phone.setCallRating({peer=InputPhoneCall, rating=int, comment='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/docs/API_docs/methods/photos_getUserPhotos.md b/docs/API_docs/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/docs/API_docs/methods/photos_getUserPhotos.md +++ b/docs/API_docs/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/docs/API_docs/methods/photos_uploadProfilePhoto.md b/docs/API_docs/methods/photos_uploadProfilePhoto.md index c7ec3063..0c994ffe 100644 --- a/docs/API_docs/methods/photos_uploadProfilePhoto.md +++ b/docs/API_docs/methods/photos_uploadProfilePhoto.md @@ -20,16 +20,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -66,3 +56,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/docs/API_docs/methods/stickers_addStickerToSet.md b/docs/API_docs/methods/stickers_addStickerToSet.md index 7c4191d8..6e1d680c 100644 --- a/docs/API_docs/methods/stickers_addStickerToSet.md +++ b/docs/API_docs/methods/stickers_addStickerToSet.md @@ -12,8 +12,8 @@ Add sticker to stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -21,14 +21,6 @@ Add sticker to stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.addStickerToSet({stickerset=InputStickerSet, sticker=InputStickerSetItem, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/docs/API_docs/methods/stickers_changeStickerPosition.md b/docs/API_docs/methods/stickers_changeStickerPosition.md index d25129c5..6e8e2505 100644 --- a/docs/API_docs/methods/stickers_changeStickerPosition.md +++ b/docs/API_docs/methods/stickers_changeStickerPosition.md @@ -13,7 +13,7 @@ Change sticker position in photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[CLICK ME int](../types/int.md) | Yes|New position| +|position|[int](../types/int.md) | Yes|New position| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -21,14 +21,6 @@ Change sticker position in photo ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKER_INVALID|The provided sticker is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.changeStickerPosition({sticker=InputDocument, position=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/docs/API_docs/methods/stickers_createStickerSet.md b/docs/API_docs/methods/stickers_createStickerSet.md index 95775849..371033ca 100644 --- a/docs/API_docs/methods/stickers_createStickerSet.md +++ b/docs/API_docs/methods/stickers_createStickerSet.md @@ -12,11 +12,11 @@ Create stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Masks?| +|masks|[Bool](../types/Bool.md) | Optional|Masks?| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[CLICK ME string](../types/string.md) | Yes|The stickerset title| -|short\_name|[CLICK ME string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +|title|[string](../types/string.md) | Yes|The stickerset title| +|short\_name|[string](../types/string.md) | Yes|The stickerset short name| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -24,21 +24,6 @@ Create stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|PACK_SHORT_NAME_INVALID|Short pack name invalid| -|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| -|PEER_ID_INVALID|The provided peer id is invalid| -|STICKER_EMOJI_INVALID|Sticker emoji invalid| -|STICKER_FILE_INVALID|Sticker file invalid| -|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| -|STICKERS_EMPTY|No sticker provided| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -92,3 +77,18 @@ Or, if you're into Lua: messages_StickerSet = stickers.createStickerSet({masks=Bool, user_id=InputUser, title='string', short_name='string', stickers={InputStickerSetItem}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|PACK_SHORT_NAME_INVALID|Short pack name invalid| +|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| +|PEER_ID_INVALID|The provided peer id is invalid| +|STICKER_EMOJI_INVALID|Sticker emoji invalid| +|STICKER_FILE_INVALID|Sticker file invalid| +|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| +|STICKERS_EMPTY|No sticker provided| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/docs/API_docs/methods/stickers_removeStickerFromSet.md b/docs/API_docs/methods/stickers_removeStickerFromSet.md index 73ed78d5..5e3a4291 100644 --- a/docs/API_docs/methods/stickers_removeStickerFromSet.md +++ b/docs/API_docs/methods/stickers_removeStickerFromSet.md @@ -20,14 +20,6 @@ Remove sticker from stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKER_INVALID|The provided sticker is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.removeStickerFromSet({sticker=InputDocument, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/docs/API_docs/methods/upload_getWebFile.md b/docs/API_docs/methods/upload_getWebFile.md index 11634633..f869519a 100644 --- a/docs/API_docs/methods/upload_getWebFile.md +++ b/docs/API_docs/methods/upload_getWebFile.md @@ -12,9 +12,9 @@ Download a file through telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[int](../types/int.md) | Yes|The offset in bytes| +|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) @@ -22,13 +22,6 @@ Download a file through telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LOCATION_INVALID|The provided location is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: upload_WebFile = upload.getWebFile({location=InputWebFileLocation, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LOCATION_INVALID|The provided location is invalid| + + diff --git a/docs/API_docs/methods/users_getUsers.md b/docs/API_docs/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/docs/API_docs/methods/users_getUsers.md +++ b/docs/API_docs/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/docs/MTProto_docs/methods/destroy_session.md b/docs/MTProto_docs/methods/destroy_session.md index b74fbd11..c4187ce0 100644 --- a/docs/MTProto_docs/methods/destroy_session.md +++ b/docs/MTProto_docs/methods/destroy_session.md @@ -12,7 +12,7 @@ Destroy the current MTProto session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|session\_id|[CLICK ME long](../types/long.md) | Yes|The session to destroy| +|session\_id|[long](../types/long.md) | Yes|The session to destroy| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/docs/MTProto_docs/methods/get_future_salts.md b/docs/MTProto_docs/methods/get_future_salts.md index e8451015..7f5fc18c 100644 --- a/docs/MTProto_docs/methods/get_future_salts.md +++ b/docs/MTProto_docs/methods/get_future_salts.md @@ -12,7 +12,7 @@ Get future salts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|num|[CLICK ME int](../types/int.md) | Yes|How many salts should be fetched| +|num|[int](../types/int.md) | Yes|How many salts should be fetched| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/docs/MTProto_docs/methods/http_wait.md b/docs/MTProto_docs/methods/http_wait.md index 9b5ccad3..9a6f2900 100644 --- a/docs/MTProto_docs/methods/http_wait.md +++ b/docs/MTProto_docs/methods/http_wait.md @@ -12,9 +12,9 @@ Makes the server send messages waiting in the buffer | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_delay|[CLICK ME int](../types/int.md) | Yes|Denotes the maximum number of milliseconds that has elapsed between the first message for this session and the transmission of an HTTP response| -|wait\_after|[CLICK ME int](../types/int.md) | Yes|after the receipt of the latest message for a particular session, the server waits another wait_after milliseconds in case there are more messages. If there are no additional messages, the result is transmitted (a container with all the messages).| -|max\_wait|[CLICK ME int](../types/int.md) | Yes|If more messages appear, the wait_after timer is reset.| +|max\_delay|[int](../types/int.md) | Yes|Denotes the maximum number of milliseconds that has elapsed between the first message for this session and the transmission of an HTTP response| +|wait\_after|[int](../types/int.md) | Yes|after the receipt of the latest message for a particular session, the server waits another wait_after milliseconds in case there are more messages. If there are no additional messages, the result is transmitted (a container with all the messages).| +|max\_wait|[int](../types/int.md) | Yes|If more messages appear, the wait_after timer is reset.| ### Return type: [HttpWait](../types/HttpWait.md) diff --git a/docs/MTProto_docs/methods/ping.md b/docs/MTProto_docs/methods/ping.md index f987ae89..daf1cc65 100644 --- a/docs/MTProto_docs/methods/ping.md +++ b/docs/MTProto_docs/methods/ping.md @@ -12,7 +12,7 @@ pings the server | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| ### Return type: [Pong](../types/Pong.md) diff --git a/docs/MTProto_docs/methods/ping_delay_disconnect.md b/docs/MTProto_docs/methods/ping_delay_disconnect.md index 5b1c115d..66cc3704 100644 --- a/docs/MTProto_docs/methods/ping_delay_disconnect.md +++ b/docs/MTProto_docs/methods/ping_delay_disconnect.md @@ -12,8 +12,8 @@ Pings the server and causes disconection if the same method is not called within | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[CLICK ME int](../types/int.md) | Yes|Disconection delay| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| +|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| ### Return type: [Pong](../types/Pong.md) diff --git a/docs/MTProto_docs/methods/req_DH_params.md b/docs/MTProto_docs/methods/req_DH_params.md index 62595b76..951eed7f 100644 --- a/docs/MTProto_docs/methods/req_DH_params.md +++ b/docs/MTProto_docs/methods/req_DH_params.md @@ -12,12 +12,12 @@ Requests Diffie-hellman parameters for key exchange | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[CLICK ME bytes](../types/bytes.md) | Yes|Factorized p from pq| -|q|[CLICK ME bytes](../types/bytes.md) | Yes|Factorized q from pq| -|public\_key\_fingerprint|[CLICK ME long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[CLICK ME bytes](../types/bytes.md) | Yes|Encrypted key exchange message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|p|[bytes](../types/bytes.md) | Yes|Factorized p from pq| +|q|[bytes](../types/bytes.md) | Yes|Factorized q from pq| +|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| +|encrypted\_data|[bytes](../types/bytes.md) | Yes|Encrypted key exchange message| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/docs/MTProto_docs/methods/req_pq.md b/docs/MTProto_docs/methods/req_pq.md index 0873d9a2..d273a0b9 100644 --- a/docs/MTProto_docs/methods/req_pq.md +++ b/docs/MTProto_docs/methods/req_pq.md @@ -12,7 +12,7 @@ Requests PQ for factorization | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/docs/MTProto_docs/methods/req_pq_multi.md b/docs/MTProto_docs/methods/req_pq_multi.md index 39ccf270..2d247f76 100644 --- a/docs/MTProto_docs/methods/req_pq_multi.md +++ b/docs/MTProto_docs/methods/req_pq_multi.md @@ -12,7 +12,7 @@ Requests PQ for factorization (new version) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/docs/MTProto_docs/methods/rpc_drop_answer.md b/docs/MTProto_docs/methods/rpc_drop_answer.md index 27f98bca..34b355f3 100644 --- a/docs/MTProto_docs/methods/rpc_drop_answer.md +++ b/docs/MTProto_docs/methods/rpc_drop_answer.md @@ -12,7 +12,7 @@ Do not send answer to provided request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|req\_msg\_id|[CLICK ME long](../types/long.md) | Yes|The message ID of the request| +|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/docs/MTProto_docs/methods/set_client_DH_params.md b/docs/MTProto_docs/methods/set_client_DH_params.md index 25d89872..a09217cd 100644 --- a/docs/MTProto_docs/methods/set_client_DH_params.md +++ b/docs/MTProto_docs/methods/set_client_DH_params.md @@ -12,9 +12,9 @@ Sets client diffie-hellman parameters | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[CLICK ME bytes](../types/bytes.md) | Yes|Encrypted key exchange message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|encrypted\_data|[bytes](../types/bytes.md) | Yes|Encrypted key exchange message| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/docs/TD_docs/methods/acceptCall.md b/docs/TD_docs/methods/acceptCall.md index 2bc708be..0e327ce5 100644 --- a/docs/TD_docs/methods/acceptCall.md +++ b/docs/TD_docs/methods/acceptCall.md @@ -15,8 +15,8 @@ Accepts incoming call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|call\_id|[CLICK ME int](../types/int.md) | Yes|Call identifier| -|protocol|[CLICK ME callProtocol](../constructors/callProtocol.md) | Yes|Description of supported by the client call protocols| +|call\_id|[int](../types/int.md) | Yes|Call identifier| +|protocol|[callProtocol](../constructors/callProtocol.md) | Yes|Description of supported by the client call protocols| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addChatMember.md b/docs/TD_docs/methods/addChatMember.md index c7852600..e5d9997d 100644 --- a/docs/TD_docs/methods/addChatMember.md +++ b/docs/TD_docs/methods/addChatMember.md @@ -15,9 +15,9 @@ Adds new member to chat. Members can't be added to private or secret chats. Memb | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|user\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the user to add| -|forward\_limit|[CLICK ME int](../types/int.md) | Yes|Number of previous messages from chat to forward to new member, ignored for channel chats. Can't be greater than 300| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|user\_id|[int](../types/int.md) | Yes|Identifier of the user to add| +|forward\_limit|[int](../types/int.md) | Yes|Number of previous messages from chat to forward to new member, ignored for channel chats. Can't be greater than 300| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addChatMembers.md b/docs/TD_docs/methods/addChatMembers.md index 1231539e..ef061253 100644 --- a/docs/TD_docs/methods/addChatMembers.md +++ b/docs/TD_docs/methods/addChatMembers.md @@ -15,8 +15,8 @@ Adds many new members to the chat. Currently, available only for channels. Can't | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|user\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Identifiers of the users to add| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|user\_ids|Array of [int](../types/int.md) | Yes|Identifiers of the users to add| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addFavoriteSticker.md b/docs/TD_docs/methods/addFavoriteSticker.md index bd6dc659..7663d22e 100644 --- a/docs/TD_docs/methods/addFavoriteSticker.md +++ b/docs/TD_docs/methods/addFavoriteSticker.md @@ -15,7 +15,7 @@ Adds new sticker to the list of favorite stickers. New sticker is added to the b | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sticker|[CLICK ME InputFile](../types/InputFile.md) | Yes|Sticker file to add| +|sticker|[InputFile](../types/InputFile.md) | Yes|Sticker file to add| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addNetworkStatistics.md b/docs/TD_docs/methods/addNetworkStatistics.md index 00371a36..9bc24ddb 100644 --- a/docs/TD_docs/methods/addNetworkStatistics.md +++ b/docs/TD_docs/methods/addNetworkStatistics.md @@ -15,7 +15,7 @@ Adds specified data to data usage statistics. Can be called before authorization | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|entry|[CLICK ME NetworkStatisticsEntry](../types/NetworkStatisticsEntry.md) | Yes|Network statistics entry with a data to add to statistics| +|entry|[NetworkStatisticsEntry](../types/NetworkStatisticsEntry.md) | Yes|Network statistics entry with a data to add to statistics| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addRecentSticker.md b/docs/TD_docs/methods/addRecentSticker.md index 036b669b..6abb0ca8 100644 --- a/docs/TD_docs/methods/addRecentSticker.md +++ b/docs/TD_docs/methods/addRecentSticker.md @@ -15,8 +15,8 @@ Manually adds new sticker to the list of recently used stickers. New sticker is | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|is\_attached|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true to add the sticker to the list of stickers recently attached to photo or video files, pass false to add the sticker to the list of recently sent stickers| -|sticker|[CLICK ME InputFile](../types/InputFile.md) | Yes|Sticker file to add| +|is\_attached|[Bool](../types/Bool.md) | Yes|Pass true to add the sticker to the list of stickers recently attached to photo or video files, pass false to add the sticker to the list of recently sent stickers| +|sticker|[InputFile](../types/InputFile.md) | Yes|Sticker file to add| ### Return type: [Stickers](../types/Stickers.md) diff --git a/docs/TD_docs/methods/addRecentlyFoundChat.md b/docs/TD_docs/methods/addRecentlyFoundChat.md index 2cbdb860..e305058c 100644 --- a/docs/TD_docs/methods/addRecentlyFoundChat.md +++ b/docs/TD_docs/methods/addRecentlyFoundChat.md @@ -15,7 +15,7 @@ Adds chat to the list of recently found chats. The chat is added to the beginnin | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the chat to add| +|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat to add| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addSavedAnimation.md b/docs/TD_docs/methods/addSavedAnimation.md index 94c68214..f626fa18 100644 --- a/docs/TD_docs/methods/addSavedAnimation.md +++ b/docs/TD_docs/methods/addSavedAnimation.md @@ -15,7 +15,7 @@ Manually adds new animation to the list of saved animations. New animation is ad | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|animation|[CLICK ME InputFile](../types/InputFile.md) | Yes|Animation file to add. Only known to server animations (i. e. successfully sent via message) can be added to the list| +|animation|[InputFile](../types/InputFile.md) | Yes|Animation file to add. Only known to server animations (i. e. successfully sent via message) can be added to the list| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addStickerToSet.md b/docs/TD_docs/methods/addStickerToSet.md index 3d8060d6..e322aca6 100644 --- a/docs/TD_docs/methods/addStickerToSet.md +++ b/docs/TD_docs/methods/addStickerToSet.md @@ -15,9 +15,9 @@ Bots only. Adds new sticker to a set. Returns the sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_id|[CLICK ME int](../types/int.md) | Yes|Sticker set owner| -|name|[CLICK ME string](../types/string.md) | Yes|Sticker set name| -|sticker|[CLICK ME inputSticker](../constructors/inputSticker.md) | Yes|Sticker to add to the set| +|user\_id|[int](../types/int.md) | Yes|Sticker set owner| +|name|[string](../types/string.md) | Yes|Sticker set name| +|sticker|[inputSticker](../constructors/inputSticker.md) | Yes|Sticker to add to the set| ### Return type: [StickerSet](../types/StickerSet.md) diff --git a/docs/TD_docs/methods/answerCallbackQuery.md b/docs/TD_docs/methods/answerCallbackQuery.md index e1428be2..8eebe561 100644 --- a/docs/TD_docs/methods/answerCallbackQuery.md +++ b/docs/TD_docs/methods/answerCallbackQuery.md @@ -15,11 +15,11 @@ Bots only. Sets result of a callback query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|callback\_query\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of the callback query| -|text|[CLICK ME string](../types/string.md) | Yes|Text of the answer| -|show\_alert|[CLICK ME Bool](../types/Bool.md) | Yes|If true, an alert should be shown to the user instead of a toast| -|url|[CLICK ME string](../types/string.md) | Yes|Url to be opened| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Allowed time to cache result of the query in seconds| +|callback\_query\_id|[int64](../constructors/int64.md) | Yes|Identifier of the callback query| +|text|[string](../types/string.md) | Yes|Text of the answer| +|show\_alert|[Bool](../types/Bool.md) | Yes|If true, an alert should be shown to the user instead of a toast| +|url|[string](../types/string.md) | Yes|Url to be opened| +|cache\_time|[int](../types/int.md) | Yes|Allowed time to cache result of the query in seconds| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/answerCustomQuery.md b/docs/TD_docs/methods/answerCustomQuery.md index 8718c10d..3d0a0a39 100644 --- a/docs/TD_docs/methods/answerCustomQuery.md +++ b/docs/TD_docs/methods/answerCustomQuery.md @@ -15,8 +15,8 @@ Bots only. Answers a custom query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|custom\_query\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of a custom query| -|data|[CLICK ME string](../types/string.md) | Yes|JSON-serialized answer to the query| +|custom\_query\_id|[int64](../constructors/int64.md) | Yes|Identifier of a custom query| +|data|[string](../types/string.md) | Yes|JSON-serialized answer to the query| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/answerInlineQuery.md b/docs/TD_docs/methods/answerInlineQuery.md index 3c98b409..cae03e9f 100644 --- a/docs/TD_docs/methods/answerInlineQuery.md +++ b/docs/TD_docs/methods/answerInlineQuery.md @@ -15,13 +15,13 @@ Bots only. Sets result of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|inline\_query\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of the inline query| -|is\_personal|[CLICK ME Bool](../types/Bool.md) | Yes|Does result of the query can be cached only for specified user| -|results|Array of [CLICK ME InputInlineQueryResult](../types/InputInlineQueryResult.md) | Yes|Results of the query| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Allowed time to cache results of the query in seconds| -|next\_offset|[CLICK ME string](../types/string.md) | Yes|Offset for the next inline query, pass empty string if there is no more results| -|switch\_pm\_text|[CLICK ME string](../types/string.md) | Yes|If non-empty, this text should be shown on the button, which opens private chat with the bot and sends bot start message with parameter switch_pm_parameter| -|switch\_pm\_parameter|[CLICK ME string](../types/string.md) | Yes|Parameter for the bot start message| +|inline\_query\_id|[int64](../constructors/int64.md) | Yes|Identifier of the inline query| +|is\_personal|[Bool](../types/Bool.md) | Yes|Does result of the query can be cached only for specified user| +|results|Array of [InputInlineQueryResult](../types/InputInlineQueryResult.md) | Yes|Results of the query| +|cache\_time|[int](../types/int.md) | Yes|Allowed time to cache results of the query in seconds| +|next\_offset|[string](../types/string.md) | Yes|Offset for the next inline query, pass empty string if there is no more results| +|switch\_pm\_text|[string](../types/string.md) | Yes|If non-empty, this text should be shown on the button, which opens private chat with the bot and sends bot start message with parameter switch_pm_parameter| +|switch\_pm\_parameter|[string](../types/string.md) | Yes|Parameter for the bot start message| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/answerPreCheckoutQuery.md b/docs/TD_docs/methods/answerPreCheckoutQuery.md index fb9756e3..5e4cdb2a 100644 --- a/docs/TD_docs/methods/answerPreCheckoutQuery.md +++ b/docs/TD_docs/methods/answerPreCheckoutQuery.md @@ -15,8 +15,8 @@ Bots only. Sets result of a pre checkout query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pre\_checkout\_query\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of the pre-checkout query| -|error\_message|[CLICK ME string](../types/string.md) | Yes|Error message, empty on success| +|pre\_checkout\_query\_id|[int64](../constructors/int64.md) | Yes|Identifier of the pre-checkout query| +|error\_message|[string](../types/string.md) | Yes|Error message, empty on success| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/answerShippingQuery.md b/docs/TD_docs/methods/answerShippingQuery.md index 333a55ee..9b560b43 100644 --- a/docs/TD_docs/methods/answerShippingQuery.md +++ b/docs/TD_docs/methods/answerShippingQuery.md @@ -15,9 +15,9 @@ Bots only. Sets result of a shipping query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|shipping\_query\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of the shipping query| -|shipping\_options|Array of [CLICK ME shippingOption](../constructors/shippingOption.md) | Yes|Available shipping options| -|error\_message|[CLICK ME string](../types/string.md) | Yes|Error message, empty on success| +|shipping\_query\_id|[int64](../constructors/int64.md) | Yes|Identifier of the shipping query| +|shipping\_options|Array of [shippingOption](../constructors/shippingOption.md) | Yes|Available shipping options| +|error\_message|[string](../types/string.md) | Yes|Error message, empty on success| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/blockUser.md b/docs/TD_docs/methods/blockUser.md index 428577af..8ff6ca82 100644 --- a/docs/TD_docs/methods/blockUser.md +++ b/docs/TD_docs/methods/blockUser.md @@ -15,7 +15,7 @@ Adds user to black list | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifier| +|user\_id|[int](../types/int.md) | Yes|User identifier| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/cancelDownloadFile.md b/docs/TD_docs/methods/cancelDownloadFile.md index b7113eb4..fb9c5fe0 100644 --- a/docs/TD_docs/methods/cancelDownloadFile.md +++ b/docs/TD_docs/methods/cancelDownloadFile.md @@ -15,7 +15,7 @@ Stops file downloading. If file is already downloaded, does nothing | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|file\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of file to cancel download| +|file\_id|[int](../types/int.md) | Yes|Identifier of file to cancel download| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/cancelUploadFile.md b/docs/TD_docs/methods/cancelUploadFile.md index 7f68b68b..06cec86f 100644 --- a/docs/TD_docs/methods/cancelUploadFile.md +++ b/docs/TD_docs/methods/cancelUploadFile.md @@ -15,7 +15,7 @@ Stops file uploading. Works only for files uploaded using uploadFile. For other | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|file\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of file to cancel upload| +|file\_id|[int](../types/int.md) | Yes|Identifier of file to cancel upload| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeAbout.md b/docs/TD_docs/methods/changeAbout.md index d1635ddc..d73bd51c 100644 --- a/docs/TD_docs/methods/changeAbout.md +++ b/docs/TD_docs/methods/changeAbout.md @@ -15,7 +15,7 @@ Changes about information of logged in user | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|about|[CLICK ME string](../types/string.md) | Yes|New value of userFull.about, 0-70 characters without line feeds| +|about|[string](../types/string.md) | Yes|New value of userFull.about, 0-70 characters without line feeds| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeAccountTtl.md b/docs/TD_docs/methods/changeAccountTtl.md index be4c4029..e98e53fd 100644 --- a/docs/TD_docs/methods/changeAccountTtl.md +++ b/docs/TD_docs/methods/changeAccountTtl.md @@ -15,7 +15,7 @@ Changes period of inactivity, after which the account of currently logged in use | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME accountTtl](../constructors/accountTtl.md) | Yes|New account TTL| +|ttl|[accountTtl](../constructors/accountTtl.md) | Yes|New account TTL| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChannelDescription.md b/docs/TD_docs/methods/changeChannelDescription.md index 39e57def..03e05755 100644 --- a/docs/TD_docs/methods/changeChannelDescription.md +++ b/docs/TD_docs/methods/changeChannelDescription.md @@ -15,8 +15,8 @@ Changes information about the channel. Needs appropriate rights in the channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the channel| -|description|[CLICK ME string](../types/string.md) | Yes|New channel description, 0-255 characters| +|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| +|description|[string](../types/string.md) | Yes|New channel description, 0-255 characters| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChannelUsername.md b/docs/TD_docs/methods/changeChannelUsername.md index 35136969..ff891e79 100644 --- a/docs/TD_docs/methods/changeChannelUsername.md +++ b/docs/TD_docs/methods/changeChannelUsername.md @@ -15,8 +15,8 @@ Changes username of the channel. Needs creator privileges in the channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the channel| -|username|[CLICK ME string](../types/string.md) | Yes|New value of username. Use empty string to remove username| +|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| +|username|[string](../types/string.md) | Yes|New value of username. Use empty string to remove username| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChatDraftMessage.md b/docs/TD_docs/methods/changeChatDraftMessage.md index e7dfde7c..07d0eb8d 100644 --- a/docs/TD_docs/methods/changeChatDraftMessage.md +++ b/docs/TD_docs/methods/changeChatDraftMessage.md @@ -15,8 +15,8 @@ Changes chat draft message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|draft\_message|[CLICK ME draftMessage](../constructors/draftMessage.md) | Yes|New draft message, nullable| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|draft\_message|[draftMessage](../constructors/draftMessage.md) | Yes|New draft message, nullable| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChatMemberStatus.md b/docs/TD_docs/methods/changeChatMemberStatus.md index eb03283e..69b729af 100644 --- a/docs/TD_docs/methods/changeChatMemberStatus.md +++ b/docs/TD_docs/methods/changeChatMemberStatus.md @@ -15,9 +15,9 @@ Changes status of the chat member, need appropriate privileges. This function is | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|user\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the user to edit status| -|status|[CLICK ME ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|New status of the member in the chat| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|user\_id|[int](../types/int.md) | Yes|Identifier of the user to edit status| +|status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|New status of the member in the chat| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChatPhoto.md b/docs/TD_docs/methods/changeChatPhoto.md index 32347353..48604f70 100644 --- a/docs/TD_docs/methods/changeChatPhoto.md +++ b/docs/TD_docs/methods/changeChatPhoto.md @@ -15,8 +15,8 @@ Changes chat photo. Works only for group and channel chats. Requires administrat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|photo|[CLICK ME InputFile](../types/InputFile.md) | Yes|New chat photo. You can use zero InputFileId to delete chat photo. Files accessible only by HTTP URL are not acceptable| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|photo|[InputFile](../types/InputFile.md) | Yes|New chat photo. You can use zero InputFileId to delete chat photo. Files accessible only by HTTP URL are not acceptable| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChatReportSpamState.md b/docs/TD_docs/methods/changeChatReportSpamState.md index 13e752cf..9840af65 100644 --- a/docs/TD_docs/methods/changeChatReportSpamState.md +++ b/docs/TD_docs/methods/changeChatReportSpamState.md @@ -15,8 +15,8 @@ Reports chat as a spam chat or as not a spam chat. Can be used only if ChatRepor | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|is\_spam\_chat|[CLICK ME Bool](../types/Bool.md) | Yes|If true, chat will be reported as a spam chat, otherwise it will be marked as not a spam chat| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|is\_spam\_chat|[Bool](../types/Bool.md) | Yes|If true, chat will be reported as a spam chat, otherwise it will be marked as not a spam chat| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChatTitle.md b/docs/TD_docs/methods/changeChatTitle.md index 03970879..3a5ec699 100644 --- a/docs/TD_docs/methods/changeChatTitle.md +++ b/docs/TD_docs/methods/changeChatTitle.md @@ -15,8 +15,8 @@ Changes chat title. Works only for group and channel chats. Requires administrat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|title|[CLICK ME string](../types/string.md) | Yes|New title of the chat, 1-255 characters| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|title|[string](../types/string.md) | Yes|New title of the chat, 1-255 characters| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeName.md b/docs/TD_docs/methods/changeName.md index 03522f1e..e0981adc 100644 --- a/docs/TD_docs/methods/changeName.md +++ b/docs/TD_docs/methods/changeName.md @@ -15,8 +15,8 @@ Changes first and last names of logged in user. If something changes, updateUser | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Yes|New value of user first name, 1-255 characters| -|last\_name|[CLICK ME string](../types/string.md) | Yes|New value of optional user last name, 0-255 characters| +|first\_name|[string](../types/string.md) | Yes|New value of user first name, 1-255 characters| +|last\_name|[string](../types/string.md) | Yes|New value of optional user last name, 0-255 characters| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changePhoneNumber.md b/docs/TD_docs/methods/changePhoneNumber.md index 8912ddec..2dea3a85 100644 --- a/docs/TD_docs/methods/changePhoneNumber.md +++ b/docs/TD_docs/methods/changePhoneNumber.md @@ -15,9 +15,9 @@ Changes user's phone number and sends authentication code to the new user's phon | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New user's phone number in any reasonable format| -|allow\_flash\_call|[CLICK ME Bool](../types/Bool.md) | Yes|Pass True, if code can be sent via flash call to the specified phone number| -|is\_current\_phone\_number|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true, if the phone number is used on the current device. Ignored if allow_flash_call is False| +|phone\_number|[string](../types/string.md) | Yes|New user's phone number in any reasonable format| +|allow\_flash\_call|[Bool](../types/Bool.md) | Yes|Pass True, if code can be sent via flash call to the specified phone number| +|is\_current\_phone\_number|[Bool](../types/Bool.md) | Yes|Pass true, if the phone number is used on the current device. Ignored if allow_flash_call is False| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/changeStickerSet.md b/docs/TD_docs/methods/changeStickerSet.md index a7853dc3..0f2c101d 100644 --- a/docs/TD_docs/methods/changeStickerSet.md +++ b/docs/TD_docs/methods/changeStickerSet.md @@ -15,9 +15,9 @@ Installs/uninstalls or enables/archives sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|set\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of the sticker set| -|is\_installed|[CLICK ME Bool](../types/Bool.md) | Yes|New value of is_installed| -|is\_archived|[CLICK ME Bool](../types/Bool.md) | Yes|New value of is_archived. A sticker set can't be installed and archived simultaneously| +|set\_id|[int64](../constructors/int64.md) | Yes|Identifier of the sticker set| +|is\_installed|[Bool](../types/Bool.md) | Yes|New value of is_installed| +|is\_archived|[Bool](../types/Bool.md) | Yes|New value of is_archived. A sticker set can't be installed and archived simultaneously| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeUsername.md b/docs/TD_docs/methods/changeUsername.md index 710836fa..ac193251 100644 --- a/docs/TD_docs/methods/changeUsername.md +++ b/docs/TD_docs/methods/changeUsername.md @@ -15,7 +15,7 @@ Changes username of logged in user. If something changes, updateUser will be sen | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|New value of username. Use empty string to remove username| +|username|[string](../types/string.md) | Yes|New value of username. Use empty string to remove username| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/checkAuthBotToken.md b/docs/TD_docs/methods/checkAuthBotToken.md index a08082db..5cf252b3 100644 --- a/docs/TD_docs/methods/checkAuthBotToken.md +++ b/docs/TD_docs/methods/checkAuthBotToken.md @@ -15,7 +15,7 @@ Check bot's authentication token to log in as a bot. Works only when getAuthStat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token|[CLICK ME string](../types/string.md) | Yes|Bot token| +|token|[string](../types/string.md) | Yes|Bot token| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/checkAuthCode.md b/docs/TD_docs/methods/checkAuthCode.md index e15f4981..1fbb2abc 100644 --- a/docs/TD_docs/methods/checkAuthCode.md +++ b/docs/TD_docs/methods/checkAuthCode.md @@ -15,9 +15,9 @@ Checks authentication code. Works only when getAuthState returns authStateWaitCo | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|Verification code from SMS, Telegram message, phone call or flash call| -|first\_name|[CLICK ME string](../types/string.md) | Yes|User first name, if user is yet not registered, 1-255 characters| -|last\_name|[CLICK ME string](../types/string.md) | Yes|Optional user last name, if user is yet not registered, 0-255 characters| +|code|[string](../types/string.md) | Yes|Verification code from SMS, Telegram message, phone call or flash call| +|first\_name|[string](../types/string.md) | Yes|User first name, if user is yet not registered, 1-255 characters| +|last\_name|[string](../types/string.md) | Yes|Optional user last name, if user is yet not registered, 0-255 characters| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/checkAuthPassword.md b/docs/TD_docs/methods/checkAuthPassword.md index 01ce1786..6fd051d7 100644 --- a/docs/TD_docs/methods/checkAuthPassword.md +++ b/docs/TD_docs/methods/checkAuthPassword.md @@ -15,7 +15,7 @@ Checks password for correctness. Works only when getAuthState returns authStateW | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|password|[CLICK ME string](../types/string.md) | Yes|Password to check| +|password|[string](../types/string.md) | Yes|Password to check| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/checkChangePhoneNumberCode.md b/docs/TD_docs/methods/checkChangePhoneNumberCode.md index d9b2103c..99cdb972 100644 --- a/docs/TD_docs/methods/checkChangePhoneNumberCode.md +++ b/docs/TD_docs/methods/checkChangePhoneNumberCode.md @@ -15,7 +15,7 @@ Checks authentication code sent to change user's phone number. Returns authState | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|Verification code from SMS, phone call or flash call| +|code|[string](../types/string.md) | Yes|Verification code from SMS, phone call or flash call| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/checkChatInviteLink.md b/docs/TD_docs/methods/checkChatInviteLink.md index d2dab6ed..b38327cc 100644 --- a/docs/TD_docs/methods/checkChatInviteLink.md +++ b/docs/TD_docs/methods/checkChatInviteLink.md @@ -15,7 +15,7 @@ Checks chat invite link for validness and returns information about the correspo | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|invite\_link|[CLICK ME string](../types/string.md) | Yes|Invite link to check. Should begin with "https: t.me/joinchat/", "https: telegram.me/joinchat/" or "https: telegram.dog/joinchat/"| +|invite\_link|[string](../types/string.md) | Yes|Invite link to check. Should begin with "https: t.me/joinchat/", "https: telegram.me/joinchat/" or "https: telegram.dog/joinchat/"| ### Return type: [ChatInviteLinkInfo](../types/ChatInviteLinkInfo.md) diff --git a/docs/TD_docs/methods/clearRecentStickers.md b/docs/TD_docs/methods/clearRecentStickers.md index f382e5e9..3532e1ea 100644 --- a/docs/TD_docs/methods/clearRecentStickers.md +++ b/docs/TD_docs/methods/clearRecentStickers.md @@ -15,7 +15,7 @@ Clears list of recently used stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|is\_attached|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true to clear list of stickers recently attached to photo or video files, pass false to clear the list of recently sent stickers| +|is\_attached|[Bool](../types/Bool.md) | Yes|Pass true to clear list of stickers recently attached to photo or video files, pass false to clear the list of recently sent stickers| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/closeChat.md b/docs/TD_docs/methods/closeChat.md index 458dede1..e76dc1cd 100644 --- a/docs/TD_docs/methods/closeChat.md +++ b/docs/TD_docs/methods/closeChat.md @@ -15,7 +15,7 @@ Chat is closed by the user. Many useful activities depends on chat being opened | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/closeSecretChat.md b/docs/TD_docs/methods/closeSecretChat.md index fe163e41..75984ed7 100644 --- a/docs/TD_docs/methods/closeSecretChat.md +++ b/docs/TD_docs/methods/closeSecretChat.md @@ -15,7 +15,7 @@ Closes secret chat, effectively transfering its state to "Closed" | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|secret\_chat\_id|[CLICK ME int](../types/int.md) | Yes|Secret chat identifier| +|secret\_chat\_id|[int](../types/int.md) | Yes|Secret chat identifier| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/createCall.md b/docs/TD_docs/methods/createCall.md index 767d15b3..88e3c7eb 100644 --- a/docs/TD_docs/methods/createCall.md +++ b/docs/TD_docs/methods/createCall.md @@ -15,8 +15,8 @@ Creates new call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of user to call| -|protocol|[CLICK ME callProtocol](../constructors/callProtocol.md) | Yes|Description of supported by the client call protocols| +|user\_id|[int](../types/int.md) | Yes|Identifier of user to call| +|protocol|[callProtocol](../constructors/callProtocol.md) | Yes|Description of supported by the client call protocols| ### Return type: [CallId](../types/CallId.md) diff --git a/docs/TD_docs/methods/createChannelChat.md b/docs/TD_docs/methods/createChannelChat.md index 823380c7..3d160f73 100644 --- a/docs/TD_docs/methods/createChannelChat.md +++ b/docs/TD_docs/methods/createChannelChat.md @@ -15,7 +15,7 @@ Returns existing chat corresponding to the known channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel\_id|[CLICK ME int](../types/int.md) | Yes|Channel identifier| +|channel\_id|[int](../types/int.md) | Yes|Channel identifier| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createGroupChat.md b/docs/TD_docs/methods/createGroupChat.md index d6c1fb14..aec5b4c8 100644 --- a/docs/TD_docs/methods/createGroupChat.md +++ b/docs/TD_docs/methods/createGroupChat.md @@ -15,7 +15,7 @@ Returns existing chat corresponding to the known group | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|group\_id|[CLICK ME int](../types/int.md) | Yes|Group identifier| +|group\_id|[int](../types/int.md) | Yes|Group identifier| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createNewChannelChat.md b/docs/TD_docs/methods/createNewChannelChat.md index bc855193..c9df33c0 100644 --- a/docs/TD_docs/methods/createNewChannelChat.md +++ b/docs/TD_docs/methods/createNewChannelChat.md @@ -15,9 +15,9 @@ Creates new channel chat and send corresponding messageChannelChatCreate, return | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|title|[CLICK ME string](../types/string.md) | Yes|Title of new channel chat, 1-255 characters| -|is\_supergroup|[CLICK ME Bool](../types/Bool.md) | Yes|True, if supergroup chat should be created| -|description|[CLICK ME string](../types/string.md) | Yes|Channel description, 0-255 characters| +|title|[string](../types/string.md) | Yes|Title of new channel chat, 1-255 characters| +|is\_supergroup|[Bool](../types/Bool.md) | Yes|True, if supergroup chat should be created| +|description|[string](../types/string.md) | Yes|Channel description, 0-255 characters| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createNewGroupChat.md b/docs/TD_docs/methods/createNewGroupChat.md index 2d0bbf72..f72d2817 100644 --- a/docs/TD_docs/methods/createNewGroupChat.md +++ b/docs/TD_docs/methods/createNewGroupChat.md @@ -15,8 +15,8 @@ Creates new group chat and send corresponding messageGroupChatCreate, returns cr | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Identifiers of users to add to the group| -|title|[CLICK ME string](../types/string.md) | Yes|Title of new group chat, 1-255 characters| +|user\_ids|Array of [int](../types/int.md) | Yes|Identifiers of users to add to the group| +|title|[string](../types/string.md) | Yes|Title of new group chat, 1-255 characters| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createNewSecretChat.md b/docs/TD_docs/methods/createNewSecretChat.md index c650522c..1540f5f4 100644 --- a/docs/TD_docs/methods/createNewSecretChat.md +++ b/docs/TD_docs/methods/createNewSecretChat.md @@ -15,7 +15,7 @@ Creates new secret chat, returns created chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of a user to create secret chat with| +|user\_id|[int](../types/int.md) | Yes|Identifier of a user to create secret chat with| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createNewStickerSet.md b/docs/TD_docs/methods/createNewStickerSet.md index 42ad7306..df9ca5be 100644 --- a/docs/TD_docs/methods/createNewStickerSet.md +++ b/docs/TD_docs/methods/createNewStickerSet.md @@ -15,11 +15,11 @@ Bots only. Creates new sticker set. Returns created sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_id|[CLICK ME int](../types/int.md) | Yes|Sticker set owner| -|title|[CLICK ME string](../types/string.md) | Yes|Sticker set title, 1-64 characters| -|name|[CLICK ME string](../types/string.md) | Yes|Sticker set name. Can contain only english letters, digits and underscores. Should end on *"_by_"*. ** is case insensitive, 1-64 characters| -|is\_masks|[CLICK ME Bool](../types/Bool.md) | Yes|True, is stickers are masks| -|stickers|Array of [CLICK ME inputSticker](../constructors/inputSticker.md) | Yes|List of stickers to add to the set| +|user\_id|[int](../types/int.md) | Yes|Sticker set owner| +|title|[string](../types/string.md) | Yes|Sticker set title, 1-64 characters| +|name|[string](../types/string.md) | Yes|Sticker set name. Can contain only english letters, digits and underscores. Should end on *"_by_"*. ** is case insensitive, 1-64 characters| +|is\_masks|[Bool](../types/Bool.md) | Yes|True, is stickers are masks| +|stickers|Array of [inputSticker](../constructors/inputSticker.md) | Yes|List of stickers to add to the set| ### Return type: [StickerSet](../types/StickerSet.md) diff --git a/docs/TD_docs/methods/createPrivateChat.md b/docs/TD_docs/methods/createPrivateChat.md index fcc795ce..3124ab2b 100644 --- a/docs/TD_docs/methods/createPrivateChat.md +++ b/docs/TD_docs/methods/createPrivateChat.md @@ -15,7 +15,7 @@ Returns existing chat corresponding to the given user | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifier| +|user\_id|[int](../types/int.md) | Yes|User identifier| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createSecretChat.md b/docs/TD_docs/methods/createSecretChat.md index 036124c4..09e48ad2 100644 --- a/docs/TD_docs/methods/createSecretChat.md +++ b/docs/TD_docs/methods/createSecretChat.md @@ -15,7 +15,7 @@ Returns existing chat corresponding to the known secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|secret\_chat\_id|[CLICK ME int](../types/int.md) | Yes|SecretChat identifier| +|secret\_chat\_id|[int](../types/int.md) | Yes|SecretChat identifier| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createTemporaryPassword.md b/docs/TD_docs/methods/createTemporaryPassword.md index 6602dbd6..0aec1c6d 100644 --- a/docs/TD_docs/methods/createTemporaryPassword.md +++ b/docs/TD_docs/methods/createTemporaryPassword.md @@ -15,8 +15,8 @@ Creates new temporary password for payments processing | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|password|[CLICK ME string](../types/string.md) | Yes|Persistent user password| -|valid\_for|[CLICK ME int](../types/int.md) | Yes|Time before temporary password will expire, seconds. Should be between 60 and 86400| +|password|[string](../types/string.md) | Yes|Persistent user password| +|valid\_for|[int](../types/int.md) | Yes|Time before temporary password will expire, seconds. Should be between 60 and 86400| ### Return type: [TemporaryPasswordState](../types/TemporaryPasswordState.md) diff --git a/docs/TD_docs/methods/debugCall.md b/docs/TD_docs/methods/debugCall.md index 45f92349..0c0bb1db 100644 --- a/docs/TD_docs/methods/debugCall.md +++ b/docs/TD_docs/methods/debugCall.md @@ -15,8 +15,8 @@ Sends call debug information | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|call\_id|[CLICK ME int](../types/int.md) | Yes|Call identifier| -|debug|[CLICK ME string](../types/string.md) | Yes|Debug information in application specific format| +|call\_id|[int](../types/int.md) | Yes|Call identifier| +|debug|[string](../types/string.md) | Yes|Debug information in application specific format| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteAccount.md b/docs/TD_docs/methods/deleteAccount.md index 2f79b129..a97ce6c9 100644 --- a/docs/TD_docs/methods/deleteAccount.md +++ b/docs/TD_docs/methods/deleteAccount.md @@ -15,7 +15,7 @@ Deletes the account of currently logged in user, deleting from the server all in | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Optional reason of account deletion| +|reason|[string](../types/string.md) | Yes|Optional reason of account deletion| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteChannel.md b/docs/TD_docs/methods/deleteChannel.md index 231b6a67..67c3aaf8 100644 --- a/docs/TD_docs/methods/deleteChannel.md +++ b/docs/TD_docs/methods/deleteChannel.md @@ -15,7 +15,7 @@ Deletes channel along with all messages in corresponding chat. Releases channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the channel| +|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteChatHistory.md b/docs/TD_docs/methods/deleteChatHistory.md index d5bfdf46..f85c5e19 100644 --- a/docs/TD_docs/methods/deleteChatHistory.md +++ b/docs/TD_docs/methods/deleteChatHistory.md @@ -15,8 +15,8 @@ Deletes all messages in the chat. Can't be used for channel chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|remove\_from\_chat\_list|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true, if chat should be removed from the chat list| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|remove\_from\_chat\_list|[Bool](../types/Bool.md) | Yes|Pass true, if chat should be removed from the chat list| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteChatReplyMarkup.md b/docs/TD_docs/methods/deleteChatReplyMarkup.md index 177ec5e2..a956dbc0 100644 --- a/docs/TD_docs/methods/deleteChatReplyMarkup.md +++ b/docs/TD_docs/methods/deleteChatReplyMarkup.md @@ -15,8 +15,8 @@ Deletes default reply markup from chat. This method needs to be called after one | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Message identifier of used keyboard| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier of used keyboard| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteContacts.md b/docs/TD_docs/methods/deleteContacts.md index 47f12044..33caae03 100644 --- a/docs/TD_docs/methods/deleteContacts.md +++ b/docs/TD_docs/methods/deleteContacts.md @@ -15,7 +15,7 @@ Deletes users from contacts list | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Identifiers of users to be deleted| +|user\_ids|Array of [int](../types/int.md) | Yes|Identifiers of users to be deleted| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteFavoriteSticker.md b/docs/TD_docs/methods/deleteFavoriteSticker.md index e8c51b39..030906a0 100644 --- a/docs/TD_docs/methods/deleteFavoriteSticker.md +++ b/docs/TD_docs/methods/deleteFavoriteSticker.md @@ -15,7 +15,7 @@ Removes a sticker from the list of favorite stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sticker|[CLICK ME InputFile](../types/InputFile.md) | Yes|Sticker file to delete from the list| +|sticker|[InputFile](../types/InputFile.md) | Yes|Sticker file to delete from the list| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteFile.md b/docs/TD_docs/methods/deleteFile.md index 5563e27e..569be98a 100644 --- a/docs/TD_docs/methods/deleteFile.md +++ b/docs/TD_docs/methods/deleteFile.md @@ -15,7 +15,7 @@ Deletes a file from TDLib file cache | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|file\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the file to delete| +|file\_id|[int](../types/int.md) | Yes|Identifier of the file to delete| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteMessages.md b/docs/TD_docs/methods/deleteMessages.md index d1da04ed..37e3791d 100644 --- a/docs/TD_docs/methods/deleteMessages.md +++ b/docs/TD_docs/methods/deleteMessages.md @@ -15,9 +15,9 @@ Deletes messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|message\_ids|Array of [CLICK ME int53](../types/int53.md) | Yes|Identifiers of messages to delete| -|revoke|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true to try to delete sent messages for all chat members (may fail if messages are too old). Is always true for Channels and SecretChats| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of messages to delete| +|revoke|[Bool](../types/Bool.md) | Yes|Pass true to try to delete sent messages for all chat members (may fail if messages are too old). Is always true for Channels and SecretChats| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteMessagesFromUser.md b/docs/TD_docs/methods/deleteMessagesFromUser.md index bb518f00..a1332293 100644 --- a/docs/TD_docs/methods/deleteMessagesFromUser.md +++ b/docs/TD_docs/methods/deleteMessagesFromUser.md @@ -15,8 +15,8 @@ Deletes all messages in the chat sent by the specified user. Works only in super | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|user\_id|[int](../types/int.md) | Yes|User identifier| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteProfilePhoto.md b/docs/TD_docs/methods/deleteProfilePhoto.md index 6ff24162..65d86fef 100644 --- a/docs/TD_docs/methods/deleteProfilePhoto.md +++ b/docs/TD_docs/methods/deleteProfilePhoto.md @@ -15,7 +15,7 @@ Deletes profile photo. If something changes, updateUser will be sent | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|profile\_photo\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of profile photo to delete| +|profile\_photo\_id|[int64](../constructors/int64.md) | Yes|Identifier of profile photo to delete| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteRecentHashtag.md b/docs/TD_docs/methods/deleteRecentHashtag.md index 60d03d51..5dd47cf8 100644 --- a/docs/TD_docs/methods/deleteRecentHashtag.md +++ b/docs/TD_docs/methods/deleteRecentHashtag.md @@ -15,7 +15,7 @@ Deletes a hashtag from the list of recently used hashtags | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hashtag|[CLICK ME string](../types/string.md) | Yes|The hashtag to delete| +|hashtag|[string](../types/string.md) | Yes|The hashtag to delete| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteRecentSticker.md b/docs/TD_docs/methods/deleteRecentSticker.md index 595e312c..92b1121f 100644 --- a/docs/TD_docs/methods/deleteRecentSticker.md +++ b/docs/TD_docs/methods/deleteRecentSticker.md @@ -15,8 +15,8 @@ Removes a sticker from the list of recently used stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|is\_attached|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true to remove the sticker from the list of stickers recently attached to photo or video files, pass false to remove the sticker from the list of recently sent stickers| -|sticker|[CLICK ME InputFile](../types/InputFile.md) | Yes|Sticker file to delete| +|is\_attached|[Bool](../types/Bool.md) | Yes|Pass true to remove the sticker from the list of stickers recently attached to photo or video files, pass false to remove the sticker from the list of recently sent stickers| +|sticker|[InputFile](../types/InputFile.md) | Yes|Sticker file to delete| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteRecentlyFoundChat.md b/docs/TD_docs/methods/deleteRecentlyFoundChat.md index 2179ff59..0c9e1203 100644 --- a/docs/TD_docs/methods/deleteRecentlyFoundChat.md +++ b/docs/TD_docs/methods/deleteRecentlyFoundChat.md @@ -15,7 +15,7 @@ Deletes chat from the list of recently found chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the chat to delete| +|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat to delete| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteSavedAnimation.md b/docs/TD_docs/methods/deleteSavedAnimation.md index 3e5f68fb..72c5d77b 100644 --- a/docs/TD_docs/methods/deleteSavedAnimation.md +++ b/docs/TD_docs/methods/deleteSavedAnimation.md @@ -15,7 +15,7 @@ Removes an animation from the list of saved animations | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|animation|[CLICK ME InputFile](../types/InputFile.md) | Yes|Animation file to delete| +|animation|[InputFile](../types/InputFile.md) | Yes|Animation file to delete| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteStickerFromSet.md b/docs/TD_docs/methods/deleteStickerFromSet.md index 4eae037a..c1283cba 100644 --- a/docs/TD_docs/methods/deleteStickerFromSet.md +++ b/docs/TD_docs/methods/deleteStickerFromSet.md @@ -15,7 +15,7 @@ Bots only. Deletes a sticker from the set it belongs to. Sticker set should be c | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sticker|[CLICK ME InputFile](../types/InputFile.md) | Yes|The sticker| +|sticker|[InputFile](../types/InputFile.md) | Yes|The sticker| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteTopChat.md b/docs/TD_docs/methods/deleteTopChat.md index 0c9f2dd6..05b4e380 100644 --- a/docs/TD_docs/methods/deleteTopChat.md +++ b/docs/TD_docs/methods/deleteTopChat.md @@ -15,8 +15,8 @@ Delete a chat from a list of frequently used chats. Supported only if chat info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopChatCategory](../types/TopChatCategory.md) | Yes|Category of frequently used chats| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| +|category|[TopChatCategory](../types/TopChatCategory.md) | Yes|Category of frequently used chats| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/discardCall.md b/docs/TD_docs/methods/discardCall.md index b07b15d9..0d9a9418 100644 --- a/docs/TD_docs/methods/discardCall.md +++ b/docs/TD_docs/methods/discardCall.md @@ -15,10 +15,10 @@ Discards a call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|call\_id|[CLICK ME int](../types/int.md) | Yes|Call identifier| -|is\_disconnected|[CLICK ME Bool](../types/Bool.md) | Yes|True, if users was disconnected| -|duration|[CLICK ME int](../types/int.md) | Yes|Call duration in seconds| -|connection\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of a connection used during the call| +|call\_id|[int](../types/int.md) | Yes|Call identifier| +|is\_disconnected|[Bool](../types/Bool.md) | Yes|True, if users was disconnected| +|duration|[int](../types/int.md) | Yes|Call duration in seconds| +|connection\_id|[int64](../constructors/int64.md) | Yes|Identifier of a connection used during the call| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/downloadFile.md b/docs/TD_docs/methods/downloadFile.md index 9d79a96b..2f18bede 100644 --- a/docs/TD_docs/methods/downloadFile.md +++ b/docs/TD_docs/methods/downloadFile.md @@ -15,8 +15,8 @@ Asynchronously downloads file from cloud. Updates updateFile will notify about d | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|file\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of file to download| -|priority|[CLICK ME int](../types/int.md) | Yes|Priority of download, 1-32. The higher priority, the earlier file will be downloaded. If priorities of two files are equal then the last one for which downloadFile is called will be downloaded first| +|file\_id|[int](../types/int.md) | Yes|Identifier of file to download| +|priority|[int](../types/int.md) | Yes|Priority of download, 1-32. The higher priority, the earlier file will be downloaded. If priorities of two files are equal then the last one for which downloadFile is called will be downloaded first| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/editInlineMessageCaption.md b/docs/TD_docs/methods/editInlineMessageCaption.md index 3fdf0928..049f40dc 100644 --- a/docs/TD_docs/methods/editInlineMessageCaption.md +++ b/docs/TD_docs/methods/editInlineMessageCaption.md @@ -15,9 +15,9 @@ Bots only. Edits caption of an inline message content sent via bot | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|inline\_message\_id|[CLICK ME string](../types/string.md) | Yes|Inline message identifier| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup| -|caption|[CLICK ME string](../types/string.md) | Yes|New message content caption, 0-200 characters| +|inline\_message\_id|[string](../types/string.md) | Yes|Inline message identifier| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup| +|caption|[string](../types/string.md) | Yes|New message content caption, 0-200 characters| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/editInlineMessageReplyMarkup.md b/docs/TD_docs/methods/editInlineMessageReplyMarkup.md index af491457..b568f45c 100644 --- a/docs/TD_docs/methods/editInlineMessageReplyMarkup.md +++ b/docs/TD_docs/methods/editInlineMessageReplyMarkup.md @@ -15,8 +15,8 @@ Bots only. Edits reply markup of an inline message sent via bot | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|inline\_message\_id|[CLICK ME string](../types/string.md) | Yes|Inline message identifier| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup| +|inline\_message\_id|[string](../types/string.md) | Yes|Inline message identifier| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/editInlineMessageText.md b/docs/TD_docs/methods/editInlineMessageText.md index 3460277f..085b072a 100644 --- a/docs/TD_docs/methods/editInlineMessageText.md +++ b/docs/TD_docs/methods/editInlineMessageText.md @@ -15,9 +15,9 @@ Bots only. Edits text of an inline text or game message sent via bot | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|inline\_message\_id|[CLICK ME string](../types/string.md) | Yes|Inline message identifier| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup| -|input\_message\_content|[CLICK ME InputMessageContent](../types/InputMessageContent.md) | Yes|New text content of the message. Should be of type InputMessageText| +|inline\_message\_id|[string](../types/string.md) | Yes|Inline message identifier| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup| +|input\_message\_content|[InputMessageContent](../types/InputMessageContent.md) | Yes|New text content of the message. Should be of type InputMessageText| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/editMessageCaption.md b/docs/TD_docs/methods/editMessageCaption.md index d004cdea..43001928 100644 --- a/docs/TD_docs/methods/editMessageCaption.md +++ b/docs/TD_docs/methods/editMessageCaption.md @@ -15,10 +15,10 @@ Edits message content caption. Non-bots can edit message in a limited period of | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat the message belongs to| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Yes|Bots only. New message reply markup| -|caption|[CLICK ME string](../types/string.md) | Yes|New message content caption, 0-200 characters| +|chat\_id|[int53](../types/int53.md) | Yes|Chat the message belongs to| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|Bots only. New message reply markup| +|caption|[string](../types/string.md) | Yes|New message content caption, 0-200 characters| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/editMessageReplyMarkup.md b/docs/TD_docs/methods/editMessageReplyMarkup.md index 6fc6decf..eae11a1b 100644 --- a/docs/TD_docs/methods/editMessageReplyMarkup.md +++ b/docs/TD_docs/methods/editMessageReplyMarkup.md @@ -15,9 +15,9 @@ Bots only. Edits message reply markup. Returns edited message after edit is comp | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat the message belongs to| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup| +|chat\_id|[int53](../types/int53.md) | Yes|Chat the message belongs to| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/editMessageText.md b/docs/TD_docs/methods/editMessageText.md index 5795551c..a08bd109 100644 --- a/docs/TD_docs/methods/editMessageText.md +++ b/docs/TD_docs/methods/editMessageText.md @@ -15,10 +15,10 @@ Edits text of text or game message. Non-bots can edit message in a limited perio | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat the message belongs to| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Yes|Bots only. New message reply markup| -|input\_message\_content|[CLICK ME InputMessageContent](../types/InputMessageContent.md) | Yes|New text content of the message. Should be of type InputMessageText| +|chat\_id|[int53](../types/int53.md) | Yes|Chat the message belongs to| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|Bots only. New message reply markup| +|input\_message\_content|[InputMessageContent](../types/InputMessageContent.md) | Yes|New text content of the message. Should be of type InputMessageText| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/exportChatInviteLink.md b/docs/TD_docs/methods/exportChatInviteLink.md index 673afaee..161f777b 100644 --- a/docs/TD_docs/methods/exportChatInviteLink.md +++ b/docs/TD_docs/methods/exportChatInviteLink.md @@ -15,7 +15,7 @@ Generates new chat invite link, previously generated link is revoked. Available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| ### Return type: [ChatInviteLink](../types/ChatInviteLink.md) diff --git a/docs/TD_docs/methods/finishFileGeneration.md b/docs/TD_docs/methods/finishFileGeneration.md index 7625f7d0..ca2cec2a 100644 --- a/docs/TD_docs/methods/finishFileGeneration.md +++ b/docs/TD_docs/methods/finishFileGeneration.md @@ -15,7 +15,7 @@ Finishes file generation | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|generation\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of the generation process| +|generation\_id|[int64](../constructors/int64.md) | Yes|Identifier of the generation process| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/forwardMessages.md b/docs/TD_docs/methods/forwardMessages.md index c193b705..27e12908 100644 --- a/docs/TD_docs/methods/forwardMessages.md +++ b/docs/TD_docs/methods/forwardMessages.md @@ -15,11 +15,11 @@ Forwards previously sent messages. Returns forwarded messages in the same order | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of a chat to forward messages| -|from\_chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of a chat to forward from| -|message\_ids|Array of [CLICK ME int53](../types/int53.md) | Yes|Identifiers of messages to forward| -|disable\_notification|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true, to disable notification about the message, doesn't works if messages are forwarded to secret chat| -|from\_background|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true, if the message is sent from background| +|chat\_id|[int53](../types/int53.md) | Yes|Identifier of a chat to forward messages| +|from\_chat\_id|[int53](../types/int53.md) | Yes|Identifier of a chat to forward from| +|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of messages to forward| +|disable\_notification|[Bool](../types/Bool.md) | Yes|Pass true, to disable notification about the message, doesn't works if messages are forwarded to secret chat| +|from\_background|[Bool](../types/Bool.md) | Yes|Pass true, if the message is sent from background| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/getArchivedStickerSets.md b/docs/TD_docs/methods/getArchivedStickerSets.md index 96626dd7..1cd320bb 100644 --- a/docs/TD_docs/methods/getArchivedStickerSets.md +++ b/docs/TD_docs/methods/getArchivedStickerSets.md @@ -15,9 +15,9 @@ Returns list of archived sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|is\_masks|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true to return mask stickers sets, pass false to return ordinary sticker sets| -|offset\_sticker\_set\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of the sticker set from which return the result| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of sticker sets to return| +|is\_masks|[Bool](../types/Bool.md) | Yes|Pass true to return mask stickers sets, pass false to return ordinary sticker sets| +|offset\_sticker\_set\_id|[int64](../constructors/int64.md) | Yes|Identifier of the sticker set from which return the result| +|limit|[int](../types/int.md) | Yes|Maximum number of sticker sets to return| ### Return type: [StickerSets](../types/StickerSets.md) diff --git a/docs/TD_docs/methods/getAttachedStickerSets.md b/docs/TD_docs/methods/getAttachedStickerSets.md index 56cb4d2e..3073381a 100644 --- a/docs/TD_docs/methods/getAttachedStickerSets.md +++ b/docs/TD_docs/methods/getAttachedStickerSets.md @@ -15,7 +15,7 @@ Returns list of sticker sets attached to a file, currently only photos and video | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|file\_id|[CLICK ME int](../types/int.md) | Yes|File identifier| +|file\_id|[int](../types/int.md) | Yes|File identifier| ### Return type: [StickerSets](../types/StickerSets.md) diff --git a/docs/TD_docs/methods/getBlockedUsers.md b/docs/TD_docs/methods/getBlockedUsers.md index 6e3a3866..dd5d0bf3 100644 --- a/docs/TD_docs/methods/getBlockedUsers.md +++ b/docs/TD_docs/methods/getBlockedUsers.md @@ -15,8 +15,8 @@ Returns users blocked by the current user | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Number of users to skip in result, must be non-negative| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of users to return, can't be greater than 100| +|offset|[int](../types/int.md) | Yes|Number of users to skip in result, must be non-negative| +|limit|[int](../types/int.md) | Yes|Maximum number of users to return, can't be greater than 100| ### Return type: [Users](../types/Users.md) diff --git a/docs/TD_docs/methods/getCallbackQueryAnswer.md b/docs/TD_docs/methods/getCallbackQueryAnswer.md index ba74ed22..3afd6906 100644 --- a/docs/TD_docs/methods/getCallbackQueryAnswer.md +++ b/docs/TD_docs/methods/getCallbackQueryAnswer.md @@ -15,9 +15,9 @@ Sends callback query to a bot and returns answer to it. Returns error with code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the chat with a message| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the message, from which the query is originated| -|payload|[CLICK ME CallbackQueryPayload](../types/CallbackQueryPayload.md) | Yes|Query payload| +|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat with a message| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message, from which the query is originated| +|payload|[CallbackQueryPayload](../types/CallbackQueryPayload.md) | Yes|Query payload| ### Return type: [CallbackQueryAnswer](../types/CallbackQueryAnswer.md) diff --git a/docs/TD_docs/methods/getChannel.md b/docs/TD_docs/methods/getChannel.md index 49fee925..5fa71fb5 100644 --- a/docs/TD_docs/methods/getChannel.md +++ b/docs/TD_docs/methods/getChannel.md @@ -15,7 +15,7 @@ Returns information about a channel by its identifier, offline request if curren | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel\_id|[CLICK ME int](../types/int.md) | Yes|Channel identifier| +|channel\_id|[int](../types/int.md) | Yes|Channel identifier| ### Return type: [Channel](../types/Channel.md) diff --git a/docs/TD_docs/methods/getChannelFull.md b/docs/TD_docs/methods/getChannelFull.md index 798bbcaa..9f0c5cca 100644 --- a/docs/TD_docs/methods/getChannelFull.md +++ b/docs/TD_docs/methods/getChannelFull.md @@ -15,7 +15,7 @@ Returns full information about a channel by its identifier, cached for at most 1 | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel\_id|[CLICK ME int](../types/int.md) | Yes|Channel identifier| +|channel\_id|[int](../types/int.md) | Yes|Channel identifier| ### Return type: [ChannelFull](../types/ChannelFull.md) diff --git a/docs/TD_docs/methods/getChannelMembers.md b/docs/TD_docs/methods/getChannelMembers.md index 18021a96..5f03c21b 100644 --- a/docs/TD_docs/methods/getChannelMembers.md +++ b/docs/TD_docs/methods/getChannelMembers.md @@ -15,10 +15,10 @@ Returns information about channel members or banned users. Can be used only if c | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the channel| -|filter|[CLICK ME ChannelMembersFilter](../types/ChannelMembersFilter.md) | Yes|Kind of channel users to return, defaults to channelMembersRecent| -|offset|[CLICK ME int](../types/int.md) | Yes|Number of channel users to skip| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of users be returned, can't be greater than 200| +|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| +|filter|[ChannelMembersFilter](../types/ChannelMembersFilter.md) | Yes|Kind of channel users to return, defaults to channelMembersRecent| +|offset|[int](../types/int.md) | Yes|Number of channel users to skip| +|limit|[int](../types/int.md) | Yes|Maximum number of users be returned, can't be greater than 200| ### Return type: [ChatMembers](../types/ChatMembers.md) diff --git a/docs/TD_docs/methods/getChat.md b/docs/TD_docs/methods/getChat.md index 398bbf7a..74871e0f 100644 --- a/docs/TD_docs/methods/getChat.md +++ b/docs/TD_docs/methods/getChat.md @@ -15,7 +15,7 @@ Returns information about a chat by its identifier, offline request if current u | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/getChatEventLog.md b/docs/TD_docs/methods/getChatEventLog.md index 38684283..2ac9e568 100644 --- a/docs/TD_docs/methods/getChatEventLog.md +++ b/docs/TD_docs/methods/getChatEventLog.md @@ -15,12 +15,12 @@ Returns list of service actions taken by chat members and administrators in the | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|query|[CLICK ME string](../types/string.md) | Yes|Search query to filter events| -|from\_event\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of an event from which to return result, you can use 0 to get results from the latest events| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of events to return, can't be greater than 100| -|filters|[CLICK ME chatEventLogFilters](../constructors/chatEventLogFilters.md) | Yes|Types of events to return, defaults to all| -|user\_ids|Array of [CLICK ME int](../types/int.md) | Yes|User identifiers, which events to return, defaults to all users| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|query|[string](../types/string.md) | Yes|Search query to filter events| +|from\_event\_id|[int64](../constructors/int64.md) | Yes|Identifier of an event from which to return result, you can use 0 to get results from the latest events| +|limit|[int](../types/int.md) | Yes|Maximum number of events to return, can't be greater than 100| +|filters|[chatEventLogFilters](../constructors/chatEventLogFilters.md) | Yes|Types of events to return, defaults to all| +|user\_ids|Array of [int](../types/int.md) | Yes|User identifiers, which events to return, defaults to all users| ### Return type: [ChatEvents](../types/ChatEvents.md) diff --git a/docs/TD_docs/methods/getChatHistory.md b/docs/TD_docs/methods/getChatHistory.md index 24b5b69f..16f8c99c 100644 --- a/docs/TD_docs/methods/getChatHistory.md +++ b/docs/TD_docs/methods/getChatHistory.md @@ -15,11 +15,11 @@ Returns messages in a chat. Returns result in reverse chronological order, i.e. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|from\_message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the message near which we need a history, you can use 0 to get results from the beginning, i.e. from oldest to newest| -|offset|[CLICK ME int](../types/int.md) | Yes|Specify 0 to get results exactly from from_message_id or negative offset to get specified message and some newer messages| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of messages to be returned, should be positive and can't be greater than 100. If offset is negative, limit must be greater than -offset. There may be less than limit messages returned even the end of the history is not reached| -|only\_local|[CLICK ME Bool](../types/Bool.md) | Yes|Return only locally available messages without sending network requests| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|from\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the message near which we need a history, you can use 0 to get results from the beginning, i.e. from oldest to newest| +|offset|[int](../types/int.md) | Yes|Specify 0 to get results exactly from from_message_id or negative offset to get specified message and some newer messages| +|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, should be positive and can't be greater than 100. If offset is negative, limit must be greater than -offset. There may be less than limit messages returned even the end of the history is not reached| +|only\_local|[Bool](../types/Bool.md) | Yes|Return only locally available messages without sending network requests| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/getChatMember.md b/docs/TD_docs/methods/getChatMember.md index f2ae3653..99b52331 100644 --- a/docs/TD_docs/methods/getChatMember.md +++ b/docs/TD_docs/methods/getChatMember.md @@ -15,8 +15,8 @@ Returns information about one participant of the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|user\_id|[int](../types/int.md) | Yes|User identifier| ### Return type: [ChatMember](../types/ChatMember.md) diff --git a/docs/TD_docs/methods/getChatReportSpamState.md b/docs/TD_docs/methods/getChatReportSpamState.md index 497621b2..788b47eb 100644 --- a/docs/TD_docs/methods/getChatReportSpamState.md +++ b/docs/TD_docs/methods/getChatReportSpamState.md @@ -15,7 +15,7 @@ Returns current chat report spam state | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| ### Return type: [ChatReportSpamState](../types/ChatReportSpamState.md) diff --git a/docs/TD_docs/methods/getChats.md b/docs/TD_docs/methods/getChats.md index e34f7029..01513190 100644 --- a/docs/TD_docs/methods/getChats.md +++ b/docs/TD_docs/methods/getChats.md @@ -15,9 +15,9 @@ Returns list of chats in the right order, chats are sorted by (order, chat_id) i | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset\_order|[CLICK ME int64](../constructors/int64.md) | Yes|Chat order to return chats from| -|offset\_chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier to return chats from| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of chats to be returned. There may be less than limit chats returned even the end of the list is not reached| +|offset\_order|[int64](../constructors/int64.md) | Yes|Chat order to return chats from| +|offset\_chat\_id|[int53](../types/int53.md) | Yes|Chat identifier to return chats from| +|limit|[int](../types/int.md) | Yes|Maximum number of chats to be returned. There may be less than limit chats returned even the end of the list is not reached| ### Return type: [Chats](../types/Chats.md) diff --git a/docs/TD_docs/methods/getCommonChats.md b/docs/TD_docs/methods/getCommonChats.md index 5dde2ef1..e9ed12e0 100644 --- a/docs/TD_docs/methods/getCommonChats.md +++ b/docs/TD_docs/methods/getCommonChats.md @@ -15,9 +15,9 @@ Returns list of common chats with an other given user. Chats are sorted by their | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifier| -|offset\_chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier to return chats from, use 0 for the first request| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of chats to be returned, up to 100| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|offset\_chat\_id|[int53](../types/int53.md) | Yes|Chat identifier to return chats from, use 0 for the first request| +|limit|[int](../types/int.md) | Yes|Maximum number of chats to be returned, up to 100| ### Return type: [Chats](../types/Chats.md) diff --git a/docs/TD_docs/methods/getFile.md b/docs/TD_docs/methods/getFile.md index 3aa164fe..596336e1 100644 --- a/docs/TD_docs/methods/getFile.md +++ b/docs/TD_docs/methods/getFile.md @@ -15,7 +15,7 @@ Returns information about a file, offline request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|file\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the file to get| +|file\_id|[int](../types/int.md) | Yes|Identifier of the file to get| ### Return type: [File](../types/File.md) diff --git a/docs/TD_docs/methods/getFileExtension.md b/docs/TD_docs/methods/getFileExtension.md index 7773e317..8b5c417f 100644 --- a/docs/TD_docs/methods/getFileExtension.md +++ b/docs/TD_docs/methods/getFileExtension.md @@ -15,7 +15,7 @@ Returns file's extension guessing only by its mime type. Returns empty string on | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|Mime type of the file| +|mime\_type|[string](../types/string.md) | Yes|Mime type of the file| ### Return type: [Text](../types/Text.md) diff --git a/docs/TD_docs/methods/getFileMimeType.md b/docs/TD_docs/methods/getFileMimeType.md index 7b3f1f34..2ec83637 100644 --- a/docs/TD_docs/methods/getFileMimeType.md +++ b/docs/TD_docs/methods/getFileMimeType.md @@ -15,7 +15,7 @@ Returns file's mime type guessing only by its extension. Returns empty string on | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|file\_name|[CLICK ME string](../types/string.md) | Yes|Name of the file or path to the file| +|file\_name|[string](../types/string.md) | Yes|Name of the file or path to the file| ### Return type: [Text](../types/Text.md) diff --git a/docs/TD_docs/methods/getFilePersistent.md b/docs/TD_docs/methods/getFilePersistent.md index 1f4368c1..6ae39ece 100644 --- a/docs/TD_docs/methods/getFilePersistent.md +++ b/docs/TD_docs/methods/getFilePersistent.md @@ -15,8 +15,8 @@ Returns information about a file by its persistent id, offline request. May be u | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|persistent\_file\_id|[CLICK ME string](../types/string.md) | Yes|Persistent identifier of the file to get| -|file\_type|[CLICK ME FileType](../types/FileType.md) | Yes|File type, if known| +|persistent\_file\_id|[string](../types/string.md) | Yes|Persistent identifier of the file to get| +|file\_type|[FileType](../types/FileType.md) | Yes|File type, if known| ### Return type: [File](../types/File.md) diff --git a/docs/TD_docs/methods/getGameHighScores.md b/docs/TD_docs/methods/getGameHighScores.md index 81960c76..0332e731 100644 --- a/docs/TD_docs/methods/getGameHighScores.md +++ b/docs/TD_docs/methods/getGameHighScores.md @@ -15,9 +15,9 @@ Bots only. Returns game high scores and some part of the score table around of t | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat a message with the game belongs to| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the message| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifie| +|chat\_id|[int53](../types/int53.md) | Yes|Chat a message with the game belongs to| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| +|user\_id|[int](../types/int.md) | Yes|User identifie| ### Return type: [GameHighScores](../types/GameHighScores.md) diff --git a/docs/TD_docs/methods/getGroup.md b/docs/TD_docs/methods/getGroup.md index ad23ef28..46fad255 100644 --- a/docs/TD_docs/methods/getGroup.md +++ b/docs/TD_docs/methods/getGroup.md @@ -15,7 +15,7 @@ Returns information about a group by its identifier, offline request if current | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|group\_id|[CLICK ME int](../types/int.md) | Yes|Group identifier| +|group\_id|[int](../types/int.md) | Yes|Group identifier| ### Return type: [Group](../types/Group.md) diff --git a/docs/TD_docs/methods/getGroupFull.md b/docs/TD_docs/methods/getGroupFull.md index 86e046c8..4506da11 100644 --- a/docs/TD_docs/methods/getGroupFull.md +++ b/docs/TD_docs/methods/getGroupFull.md @@ -15,7 +15,7 @@ Returns full information about a group by its identifier | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|group\_id|[CLICK ME int](../types/int.md) | Yes|Group identifier| +|group\_id|[int](../types/int.md) | Yes|Group identifier| ### Return type: [GroupFull](../types/GroupFull.md) diff --git a/docs/TD_docs/methods/getInlineGameHighScores.md b/docs/TD_docs/methods/getInlineGameHighScores.md index 33c0a5c3..a1419d6a 100644 --- a/docs/TD_docs/methods/getInlineGameHighScores.md +++ b/docs/TD_docs/methods/getInlineGameHighScores.md @@ -15,8 +15,8 @@ Bots only. Returns game high scores and some part of the score table around of t | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|inline\_message\_id|[CLICK ME string](../types/string.md) | Yes|Inline message identifier| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifier| +|inline\_message\_id|[string](../types/string.md) | Yes|Inline message identifier| +|user\_id|[int](../types/int.md) | Yes|User identifier| ### Return type: [GameHighScores](../types/GameHighScores.md) diff --git a/docs/TD_docs/methods/getInlineQueryResults.md b/docs/TD_docs/methods/getInlineQueryResults.md index 90f89df5..99ce5e83 100644 --- a/docs/TD_docs/methods/getInlineQueryResults.md +++ b/docs/TD_docs/methods/getInlineQueryResults.md @@ -15,11 +15,11 @@ Sends inline query to a bot and returns its results. Returns error with code 502 | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|bot\_user\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the bot send query to| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the chat, where the query is sent| -|user\_location|[CLICK ME location](../constructors/location.md) | Yes|User location, only if needed| -|query|[CLICK ME string](../types/string.md) | Yes|Text of the query| -|offset|[CLICK ME string](../types/string.md) | Yes|Offset of the first entry to return| +|bot\_user\_id|[int](../types/int.md) | Yes|Identifier of the bot send query to| +|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat, where the query is sent| +|user\_location|[location](../constructors/location.md) | Yes|User location, only if needed| +|query|[string](../types/string.md) | Yes|Text of the query| +|offset|[string](../types/string.md) | Yes|Offset of the first entry to return| ### Return type: [InlineQueryResults](../types/InlineQueryResults.md) diff --git a/docs/TD_docs/methods/getInstalledStickerSets.md b/docs/TD_docs/methods/getInstalledStickerSets.md index 1d181ffd..dd0ecb99 100644 --- a/docs/TD_docs/methods/getInstalledStickerSets.md +++ b/docs/TD_docs/methods/getInstalledStickerSets.md @@ -15,7 +15,7 @@ Returns list of installed sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|is\_masks|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true to return mask sticker sets, pass false to return ordinary sticker sets| +|is\_masks|[Bool](../types/Bool.md) | Yes|Pass true to return mask sticker sets, pass false to return ordinary sticker sets| ### Return type: [StickerSets](../types/StickerSets.md) diff --git a/docs/TD_docs/methods/getMessage.md b/docs/TD_docs/methods/getMessage.md index 9b7e92c8..0a00c9bd 100644 --- a/docs/TD_docs/methods/getMessage.md +++ b/docs/TD_docs/methods/getMessage.md @@ -15,8 +15,8 @@ Returns information about a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the chat, message belongs to| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the message to get| +|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat, message belongs to| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message to get| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/getMessages.md b/docs/TD_docs/methods/getMessages.md index ec89eab9..95845bc2 100644 --- a/docs/TD_docs/methods/getMessages.md +++ b/docs/TD_docs/methods/getMessages.md @@ -15,8 +15,8 @@ Returns information about messages. If message is not found, returns null on the | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the chat, messages belongs to| -|message\_ids|Array of [CLICK ME int53](../types/int53.md) | Yes|Identifiers of the messages to get| +|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat, messages belongs to| +|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of the messages to get| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/getNetworkStatistics.md b/docs/TD_docs/methods/getNetworkStatistics.md index 0bb996b4..7cbe32dd 100644 --- a/docs/TD_docs/methods/getNetworkStatistics.md +++ b/docs/TD_docs/methods/getNetworkStatistics.md @@ -15,7 +15,7 @@ Returns network data usage statistics. Can be called before authorization | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|only\_current|[CLICK ME Bool](../types/Bool.md) | Yes|If true, returns only data for the current library launch| +|only\_current|[Bool](../types/Bool.md) | Yes|If true, returns only data for the current library launch| ### Return type: [NetworkStatistics](../types/NetworkStatistics.md) diff --git a/docs/TD_docs/methods/getNotificationSettings.md b/docs/TD_docs/methods/getNotificationSettings.md index a1422314..2693724b 100644 --- a/docs/TD_docs/methods/getNotificationSettings.md +++ b/docs/TD_docs/methods/getNotificationSettings.md @@ -15,7 +15,7 @@ Returns notification settings for a given scope | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|scope|[CLICK ME NotificationSettingsScope](../types/NotificationSettingsScope.md) | Yes|Scope to return information about notification settings| +|scope|[NotificationSettingsScope](../types/NotificationSettingsScope.md) | Yes|Scope to return information about notification settings| ### Return type: [NotificationSettings](../types/NotificationSettings.md) diff --git a/docs/TD_docs/methods/getOption.md b/docs/TD_docs/methods/getOption.md index 3820d307..6b8d358d 100644 --- a/docs/TD_docs/methods/getOption.md +++ b/docs/TD_docs/methods/getOption.md @@ -15,7 +15,7 @@ Returns value of an option by its name. See list of available options on https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|name|[CLICK ME string](../types/string.md) | Yes|Name of the option| +|name|[string](../types/string.md) | Yes|Name of the option| ### Return type: [OptionValue](../types/OptionValue.md) diff --git a/docs/TD_docs/methods/getPaymentForm.md b/docs/TD_docs/methods/getPaymentForm.md index cb705312..40178332 100644 --- a/docs/TD_docs/methods/getPaymentForm.md +++ b/docs/TD_docs/methods/getPaymentForm.md @@ -15,8 +15,8 @@ Returns invoice payment form. The method should be called when user presses inli | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier of the Invoice message| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Message identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the Invoice message| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier| ### Return type: [PaymentForm](../types/PaymentForm.md) diff --git a/docs/TD_docs/methods/getPaymentReceipt.md b/docs/TD_docs/methods/getPaymentReceipt.md index 94abcef6..1558b90b 100644 --- a/docs/TD_docs/methods/getPaymentReceipt.md +++ b/docs/TD_docs/methods/getPaymentReceipt.md @@ -15,8 +15,8 @@ Returns information about successful payment | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier of the PaymentSuccessful message| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Message identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the PaymentSuccessful message| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier| ### Return type: [PaymentReceipt](../types/PaymentReceipt.md) diff --git a/docs/TD_docs/methods/getPrivacy.md b/docs/TD_docs/methods/getPrivacy.md index 1573b91b..357b71c0 100644 --- a/docs/TD_docs/methods/getPrivacy.md +++ b/docs/TD_docs/methods/getPrivacy.md @@ -15,7 +15,7 @@ Returns current privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME PrivacyKey](../types/PrivacyKey.md) | Yes|Privacy key| +|key|[PrivacyKey](../types/PrivacyKey.md) | Yes|Privacy key| ### Return type: [PrivacyRules](../types/PrivacyRules.md) diff --git a/docs/TD_docs/methods/getPublicMessageLink.md b/docs/TD_docs/methods/getPublicMessageLink.md index 039455ca..358202ac 100644 --- a/docs/TD_docs/methods/getPublicMessageLink.md +++ b/docs/TD_docs/methods/getPublicMessageLink.md @@ -15,8 +15,8 @@ Returns public HTTPS link to a message. Available only for messages in public ch | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the chat, message belongs to| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the message| +|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat, message belongs to| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| ### Return type: [PublicMessageLink](../types/PublicMessageLink.md) diff --git a/docs/TD_docs/methods/getRecentStickers.md b/docs/TD_docs/methods/getRecentStickers.md index 397927c3..8209eded 100644 --- a/docs/TD_docs/methods/getRecentStickers.md +++ b/docs/TD_docs/methods/getRecentStickers.md @@ -15,7 +15,7 @@ Returns list of recently used stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|is\_attached|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true to return stickers and masks recently attached to photo or video files, pass false to return recently sent stickers| +|is\_attached|[Bool](../types/Bool.md) | Yes|Pass true to return stickers and masks recently attached to photo or video files, pass false to return recently sent stickers| ### Return type: [Stickers](../types/Stickers.md) diff --git a/docs/TD_docs/methods/getRecoveryEmail.md b/docs/TD_docs/methods/getRecoveryEmail.md index 88a95384..8b040489 100644 --- a/docs/TD_docs/methods/getRecoveryEmail.md +++ b/docs/TD_docs/methods/getRecoveryEmail.md @@ -15,7 +15,7 @@ Returns set up recovery email. This method can be used to verify a password prov | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|password|[CLICK ME string](../types/string.md) | Yes|Current user password| +|password|[string](../types/string.md) | Yes|Current user password| ### Return type: [RecoveryEmail](../types/RecoveryEmail.md) diff --git a/docs/TD_docs/methods/getSecretChat.md b/docs/TD_docs/methods/getSecretChat.md index d91cd77f..1b00087f 100644 --- a/docs/TD_docs/methods/getSecretChat.md +++ b/docs/TD_docs/methods/getSecretChat.md @@ -15,7 +15,7 @@ Returns information about a secret chat by its identifier, offline request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|secret\_chat\_id|[CLICK ME int](../types/int.md) | Yes|Secret chat identifier| +|secret\_chat\_id|[int](../types/int.md) | Yes|Secret chat identifier| ### Return type: [SecretChat](../types/SecretChat.md) diff --git a/docs/TD_docs/methods/getStickerEmojis.md b/docs/TD_docs/methods/getStickerEmojis.md index 9188fc72..26f3991a 100644 --- a/docs/TD_docs/methods/getStickerEmojis.md +++ b/docs/TD_docs/methods/getStickerEmojis.md @@ -15,7 +15,7 @@ Returns emojis corresponding to a sticker | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sticker|[CLICK ME InputFile](../types/InputFile.md) | Yes|Sticker file identifier| +|sticker|[InputFile](../types/InputFile.md) | Yes|Sticker file identifier| ### Return type: [StickerEmojis](../types/StickerEmojis.md) diff --git a/docs/TD_docs/methods/getStickerSet.md b/docs/TD_docs/methods/getStickerSet.md index 53c04e3a..4f93c682 100644 --- a/docs/TD_docs/methods/getStickerSet.md +++ b/docs/TD_docs/methods/getStickerSet.md @@ -15,7 +15,7 @@ Returns information about sticker set by its identifier | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|set\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of the sticker set| +|set\_id|[int64](../constructors/int64.md) | Yes|Identifier of the sticker set| ### Return type: [StickerSet](../types/StickerSet.md) diff --git a/docs/TD_docs/methods/getStickers.md b/docs/TD_docs/methods/getStickers.md index 05cf91bc..c05fe05e 100644 --- a/docs/TD_docs/methods/getStickers.md +++ b/docs/TD_docs/methods/getStickers.md @@ -15,8 +15,8 @@ Returns stickers from installed ordinary sticker sets corresponding to the given | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoji|[CLICK ME string](../types/string.md) | Yes|String representation of emoji. If empty, returns all known stickers| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of stickers to return| +|emoji|[string](../types/string.md) | Yes|String representation of emoji. If empty, returns all known stickers| +|limit|[int](../types/int.md) | Yes|Maximum number of stickers to return| ### Return type: [Stickers](../types/Stickers.md) diff --git a/docs/TD_docs/methods/getStorageStatistics.md b/docs/TD_docs/methods/getStorageStatistics.md index b083b769..8a38f64c 100644 --- a/docs/TD_docs/methods/getStorageStatistics.md +++ b/docs/TD_docs/methods/getStorageStatistics.md @@ -15,7 +15,7 @@ Returns storage usage statistics | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of chats with biggest storage usage for which separate statistics should be returned. All other chats will be grouped in entries with chat_id == 0. If chat info database is not used, chat_limit is ignored and is always set to 0| +|chat\_limit|[int](../types/int.md) | Yes|Maximum number of chats with biggest storage usage for which separate statistics should be returned. All other chats will be grouped in entries with chat_id == 0. If chat info database is not used, chat_limit is ignored and is always set to 0| ### Return type: [StorageStatistics](../types/StorageStatistics.md) diff --git a/docs/TD_docs/methods/getTextEntities.md b/docs/TD_docs/methods/getTextEntities.md index 78d1cb6b..1ff63ba5 100644 --- a/docs/TD_docs/methods/getTextEntities.md +++ b/docs/TD_docs/methods/getTextEntities.md @@ -15,7 +15,7 @@ Returns all mentions, hashtags, bot commands, URLs and emails contained in the t | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|text|[CLICK ME string](../types/string.md) | Yes|Text to find entites in| +|text|[string](../types/string.md) | Yes|Text to find entites in| ### Return type: [TextEntities](../types/TextEntities.md) diff --git a/docs/TD_docs/methods/getTopChats.md b/docs/TD_docs/methods/getTopChats.md index 8238af13..ff7be40c 100644 --- a/docs/TD_docs/methods/getTopChats.md +++ b/docs/TD_docs/methods/getTopChats.md @@ -15,8 +15,8 @@ Returns a list of frequently used chats. Supported only if chat info database is | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopChatCategory](../types/TopChatCategory.md) | Yes|Category of chats to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of chats to be returned, at most 30| +|category|[TopChatCategory](../types/TopChatCategory.md) | Yes|Category of chats to return| +|limit|[int](../types/int.md) | Yes|Maximum number of chats to be returned, at most 30| ### Return type: [Chats](../types/Chats.md) diff --git a/docs/TD_docs/methods/getUser.md b/docs/TD_docs/methods/getUser.md index cea0057f..f9135ce2 100644 --- a/docs/TD_docs/methods/getUser.md +++ b/docs/TD_docs/methods/getUser.md @@ -15,7 +15,7 @@ Returns information about a user by its identifier, offline request if current u | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifier| +|user\_id|[int](../types/int.md) | Yes|User identifier| ### Return type: [User](../types/User.md) diff --git a/docs/TD_docs/methods/getUserFull.md b/docs/TD_docs/methods/getUserFull.md index e3848981..9ae075ba 100644 --- a/docs/TD_docs/methods/getUserFull.md +++ b/docs/TD_docs/methods/getUserFull.md @@ -15,7 +15,7 @@ Returns full information about a user by its identifier | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifier| +|user\_id|[int](../types/int.md) | Yes|User identifier| ### Return type: [UserFull](../types/UserFull.md) diff --git a/docs/TD_docs/methods/getUserProfilePhotos.md b/docs/TD_docs/methods/getUserProfilePhotos.md index 0627b245..fe16b0e9 100644 --- a/docs/TD_docs/methods/getUserProfilePhotos.md +++ b/docs/TD_docs/methods/getUserProfilePhotos.md @@ -15,9 +15,9 @@ Returns profile photos of the user. Result of this query may be outdated: some p | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifier| -|offset|[CLICK ME int](../types/int.md) | Yes|Photos to skip, must be non-negative| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of photos to be returned, can't be greater than 100| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|offset|[int](../types/int.md) | Yes|Photos to skip, must be non-negative| +|limit|[int](../types/int.md) | Yes|Maximum number of photos to be returned, can't be greater than 100| ### Return type: [UserProfilePhotos](../types/UserProfilePhotos.md) diff --git a/docs/TD_docs/methods/getWebPageInstantView.md b/docs/TD_docs/methods/getWebPageInstantView.md index e8847a05..1b8ee19d 100644 --- a/docs/TD_docs/methods/getWebPageInstantView.md +++ b/docs/TD_docs/methods/getWebPageInstantView.md @@ -15,8 +15,8 @@ Returns web page instant view if available. Returns error 404 if web page has no | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|url|[CLICK ME string](../types/string.md) | Yes|Web page URL| -|force\_full|[CLICK ME Bool](../types/Bool.md) | Yes|If true, full web page instant view will be returned| +|url|[string](../types/string.md) | Yes|Web page URL| +|force\_full|[Bool](../types/Bool.md) | Yes|If true, full web page instant view will be returned| ### Return type: [WebPageInstantView](../types/WebPageInstantView.md) diff --git a/docs/TD_docs/methods/getWebPagePreview.md b/docs/TD_docs/methods/getWebPagePreview.md index d54fa859..9dc48906 100644 --- a/docs/TD_docs/methods/getWebPagePreview.md +++ b/docs/TD_docs/methods/getWebPagePreview.md @@ -15,7 +15,7 @@ Returns web page preview by text of the message. Do not call this function to of | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message\_text|[CLICK ME string](../types/string.md) | Yes|Message text| +|message\_text|[string](../types/string.md) | Yes|Message text| ### Return type: [WebPage](../types/WebPage.md) diff --git a/docs/TD_docs/methods/importChatInviteLink.md b/docs/TD_docs/methods/importChatInviteLink.md index 140ad831..5350b54e 100644 --- a/docs/TD_docs/methods/importChatInviteLink.md +++ b/docs/TD_docs/methods/importChatInviteLink.md @@ -15,7 +15,7 @@ Imports chat invite link, adds current user to a chat if possible. Member will n | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|invite\_link|[CLICK ME string](../types/string.md) | Yes|Invite link to import. Should begin with "https: t.me/joinchat/", "https: telegram.me/joinchat/" or "https: telegram.dog/joinchat/"| +|invite\_link|[string](../types/string.md) | Yes|Invite link to import. Should begin with "https: t.me/joinchat/", "https: telegram.me/joinchat/" or "https: telegram.dog/joinchat/"| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/importContacts.md b/docs/TD_docs/methods/importContacts.md index 0e55801a..2a6e4887 100644 --- a/docs/TD_docs/methods/importContacts.md +++ b/docs/TD_docs/methods/importContacts.md @@ -15,7 +15,7 @@ Adds new contacts/edits existing contacts, contacts user identifiers are ignored | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME contact](../constructors/contact.md) | Yes|List of contacts to import/edit| +|contacts|Array of [contact](../constructors/contact.md) | Yes|List of contacts to import/edit| ### Return type: [ImportedContacts](../types/ImportedContacts.md) diff --git a/docs/TD_docs/methods/migrateGroupChatToChannelChat.md b/docs/TD_docs/methods/migrateGroupChatToChannelChat.md index 8a019851..87a25568 100644 --- a/docs/TD_docs/methods/migrateGroupChatToChannelChat.md +++ b/docs/TD_docs/methods/migrateGroupChatToChannelChat.md @@ -15,7 +15,7 @@ Creates new channel supergroup chat from existing group chat and send correspond | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Group chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Group chat identifier| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/openChat.md b/docs/TD_docs/methods/openChat.md index 4deb3350..dca732cb 100644 --- a/docs/TD_docs/methods/openChat.md +++ b/docs/TD_docs/methods/openChat.md @@ -15,7 +15,7 @@ Chat is opened by the user. Many useful activities depends on chat being opened | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/openMessageContent.md b/docs/TD_docs/methods/openMessageContent.md index 1865fb0a..266ebad5 100644 --- a/docs/TD_docs/methods/openMessageContent.md +++ b/docs/TD_docs/methods/openMessageContent.md @@ -15,8 +15,8 @@ Message content is opened, for example the user has opened a photo, a video, a d | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier of the message| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the message with opened content| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the message| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message with opened content| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/optimizeStorage.md b/docs/TD_docs/methods/optimizeStorage.md index 2d692a01..58e40e70 100644 --- a/docs/TD_docs/methods/optimizeStorage.md +++ b/docs/TD_docs/methods/optimizeStorage.md @@ -15,14 +15,14 @@ Optimizes storage usage, i.e. deletes some files and return new storage usage st | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|size|[CLICK ME int53](../types/int53.md) | Yes|Limit on total size of files after deletion. Pass -1 to use default limit| -|ttl|[CLICK ME int](../types/int.md) | Yes|Limit on time passed since last access time (or creation time on some filesystems) to a file. Pass -1 to use default limit| -|count|[CLICK ME int](../types/int.md) | Yes|Limit on total count of files after deletion. Pass -1 to use default limit| -|immunity\_delay|[CLICK ME int](../types/int.md) | Yes|Number of seconds after creation of a file, it can't be delited. Pass -1 to use default value| -|file\_types|Array of [CLICK ME FileType](../types/FileType.md) | Yes|If not empty, only files with given types are considered. By default, all types except thumbnails, profile photos, stickers and wallpapers are deleted| -|chat\_ids|Array of [CLICK ME int53](../types/int53.md) | Yes|If not empty, only files from the given chats are considered. Use 0 as chat identifier to delete files not belonging to any chat, for example profile photos| -|exclude\_chat\_ids|Array of [CLICK ME int53](../types/int53.md) | Yes|If not empty, files from the given chats are exluded. Use 0 as chat identifier to exclude all files not belonging to any chat, for example profile photos| -|chat\_limit|[CLICK ME int](../types/int.md) | Yes|Same as in getStorageStatistics. Affects only returned statistics| +|size|[int53](../types/int53.md) | Yes|Limit on total size of files after deletion. Pass -1 to use default limit| +|ttl|[int](../types/int.md) | Yes|Limit on time passed since last access time (or creation time on some filesystems) to a file. Pass -1 to use default limit| +|count|[int](../types/int.md) | Yes|Limit on total count of files after deletion. Pass -1 to use default limit| +|immunity\_delay|[int](../types/int.md) | Yes|Number of seconds after creation of a file, it can't be delited. Pass -1 to use default value| +|file\_types|Array of [FileType](../types/FileType.md) | Yes|If not empty, only files with given types are considered. By default, all types except thumbnails, profile photos, stickers and wallpapers are deleted| +|chat\_ids|Array of [int53](../types/int53.md) | Yes|If not empty, only files from the given chats are considered. Use 0 as chat identifier to delete files not belonging to any chat, for example profile photos| +|exclude\_chat\_ids|Array of [int53](../types/int53.md) | Yes|If not empty, files from the given chats are exluded. Use 0 as chat identifier to exclude all files not belonging to any chat, for example profile photos| +|chat\_limit|[int](../types/int.md) | Yes|Same as in getStorageStatistics. Affects only returned statistics| ### Return type: [StorageStatistics](../types/StorageStatistics.md) diff --git a/docs/TD_docs/methods/pinChannelMessage.md b/docs/TD_docs/methods/pinChannelMessage.md index 93593bed..d9b50f8c 100644 --- a/docs/TD_docs/methods/pinChannelMessage.md +++ b/docs/TD_docs/methods/pinChannelMessage.md @@ -15,9 +15,9 @@ Pins a message in a supergroup channel chat. Needs appropriate rights in the cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the channel| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the new pinned message| -|disable\_notification|[CLICK ME Bool](../types/Bool.md) | Yes|True, if there should be no notification about the pinned message| +|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the new pinned message| +|disable\_notification|[Bool](../types/Bool.md) | Yes|True, if there should be no notification about the pinned message| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/processDcUpdate.md b/docs/TD_docs/methods/processDcUpdate.md index 50935d01..f93761e8 100644 --- a/docs/TD_docs/methods/processDcUpdate.md +++ b/docs/TD_docs/methods/processDcUpdate.md @@ -15,8 +15,8 @@ Handles DC_UPDATE push service notification. Can be called before authorization | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|dc|[CLICK ME string](../types/string.md) | Yes|Value of 'dc' paramater of the notification| -|addr|[CLICK ME string](../types/string.md) | Yes|Value of 'addr' parameter of the notification| +|dc|[string](../types/string.md) | Yes|Value of 'dc' paramater of the notification| +|addr|[string](../types/string.md) | Yes|Value of 'addr' parameter of the notification| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/rateCall.md b/docs/TD_docs/methods/rateCall.md index f9b67fbc..13e66dc5 100644 --- a/docs/TD_docs/methods/rateCall.md +++ b/docs/TD_docs/methods/rateCall.md @@ -15,9 +15,9 @@ Sends call rating | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|call\_id|[CLICK ME int](../types/int.md) | Yes|Call identifier| -|rating|[CLICK ME int](../types/int.md) | Yes|Call rating, 1-5| -|comment|[CLICK ME string](../types/string.md) | Yes|Optional user comment if rating is less than 5| +|call\_id|[int](../types/int.md) | Yes|Call identifier| +|rating|[int](../types/int.md) | Yes|Call rating, 1-5| +|comment|[string](../types/string.md) | Yes|Optional user comment if rating is less than 5| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/recoverAuthPassword.md b/docs/TD_docs/methods/recoverAuthPassword.md index f0f97e50..c6b49b68 100644 --- a/docs/TD_docs/methods/recoverAuthPassword.md +++ b/docs/TD_docs/methods/recoverAuthPassword.md @@ -15,7 +15,7 @@ Recovers password with recovery code sent to email. Works only when getAuthState | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|recovery\_code|[CLICK ME string](../types/string.md) | Yes|Recovery code to check| +|recovery\_code|[string](../types/string.md) | Yes|Recovery code to check| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/recoverPassword.md b/docs/TD_docs/methods/recoverPassword.md index 1a3c0d82..35bbeba7 100644 --- a/docs/TD_docs/methods/recoverPassword.md +++ b/docs/TD_docs/methods/recoverPassword.md @@ -15,7 +15,7 @@ Recovers password with recovery code sent to email | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|recovery\_code|[CLICK ME string](../types/string.md) | Yes|Recovery code to check| +|recovery\_code|[string](../types/string.md) | Yes|Recovery code to check| ### Return type: [PasswordState](../types/PasswordState.md) diff --git a/docs/TD_docs/methods/registerDevice.md b/docs/TD_docs/methods/registerDevice.md index 9d2b21e4..5a500a3d 100644 --- a/docs/TD_docs/methods/registerDevice.md +++ b/docs/TD_docs/methods/registerDevice.md @@ -15,7 +15,7 @@ Registers current used device for receiving push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_token|[CLICK ME DeviceToken](../types/DeviceToken.md) | Yes|Device token| +|device\_token|[DeviceToken](../types/DeviceToken.md) | Yes|Device token| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/reorderInstalledStickerSets.md b/docs/TD_docs/methods/reorderInstalledStickerSets.md index 1bf58bbd..c347616d 100644 --- a/docs/TD_docs/methods/reorderInstalledStickerSets.md +++ b/docs/TD_docs/methods/reorderInstalledStickerSets.md @@ -15,8 +15,8 @@ Changes the order of installed sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|is\_masks|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true to change mask sticker sets order, pass false to change ordinary sticker sets order| -|sticker\_set\_ids|Array of [CLICK ME int64](../constructors/int64.md) | Yes|Identifiers of installed sticker sets in the new right order| +|is\_masks|[Bool](../types/Bool.md) | Yes|Pass true to change mask sticker sets order, pass false to change ordinary sticker sets order| +|sticker\_set\_ids|Array of [int64](../constructors/int64.md) | Yes|Identifiers of installed sticker sets in the new right order| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/reportChannelSpam.md b/docs/TD_docs/methods/reportChannelSpam.md index e6f17dd0..712ab778 100644 --- a/docs/TD_docs/methods/reportChannelSpam.md +++ b/docs/TD_docs/methods/reportChannelSpam.md @@ -15,9 +15,9 @@ Reports some supergroup channel messages from a user as spam messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel\_id|[CLICK ME int](../types/int.md) | Yes|Channel identifier| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifier| -|message\_ids|Array of [CLICK ME int53](../types/int53.md) | Yes|Identifiers of messages sent in the supergroup by the user, the list should be non-empty| +|channel\_id|[int](../types/int.md) | Yes|Channel identifier| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of messages sent in the supergroup by the user, the list should be non-empty| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/reportChat.md b/docs/TD_docs/methods/reportChat.md index 8cf3450a..acec9259 100644 --- a/docs/TD_docs/methods/reportChat.md +++ b/docs/TD_docs/methods/reportChat.md @@ -15,8 +15,8 @@ Reports chat to Telegram moderators. Can be used only for a channel chat or a pr | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|reason|[CLICK ME ChatReportReason](../types/ChatReportReason.md) | Yes|Reason, the chat is reported| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|reason|[ChatReportReason](../types/ChatReportReason.md) | Yes|Reason, the chat is reported| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/resetAuth.md b/docs/TD_docs/methods/resetAuth.md index 6643473c..e2b7928b 100644 --- a/docs/TD_docs/methods/resetAuth.md +++ b/docs/TD_docs/methods/resetAuth.md @@ -15,7 +15,7 @@ Logs out user. If force == false, begins to perform soft log out, returns authSt | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|force|[CLICK ME Bool](../types/Bool.md) | Yes|If true, just delete all local data. Session will remain in list of active sessions| +|force|[Bool](../types/Bool.md) | Yes|If true, just delete all local data. Session will remain in list of active sessions| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/searchCallMessages.md b/docs/TD_docs/methods/searchCallMessages.md index cc2a5ac2..9bee293c 100644 --- a/docs/TD_docs/methods/searchCallMessages.md +++ b/docs/TD_docs/methods/searchCallMessages.md @@ -15,9 +15,9 @@ Searches for call messages. Returns result in reverse chronological order, i. e. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|from\_message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the message from which to search, you can use 0 to get results from beginning| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of messages to be returned, can't be greater than 100. There may be less than limit messages returned even the end of the history is not reached filter| -|only\_missed|[CLICK ME Bool](../types/Bool.md) | Yes|If true, return only messages with missed calls| +|from\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the message from which to search, you can use 0 to get results from beginning| +|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, can't be greater than 100. There may be less than limit messages returned even the end of the history is not reached filter| +|only\_missed|[Bool](../types/Bool.md) | Yes|If true, return only messages with missed calls| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/searchChatMembers.md b/docs/TD_docs/methods/searchChatMembers.md index 539365da..1be33ab1 100644 --- a/docs/TD_docs/methods/searchChatMembers.md +++ b/docs/TD_docs/methods/searchChatMembers.md @@ -15,9 +15,9 @@ Searches for the specified query in the first name, last name and username among | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|query|[CLICK ME string](../types/string.md) | Yes|Query to search for| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of users to be returned| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|query|[string](../types/string.md) | Yes|Query to search for| +|limit|[int](../types/int.md) | Yes|Maximum number of users to be returned| ### Return type: [ChatMembers](../types/ChatMembers.md) diff --git a/docs/TD_docs/methods/searchChatMessages.md b/docs/TD_docs/methods/searchChatMessages.md index f26727ce..3686e795 100644 --- a/docs/TD_docs/methods/searchChatMessages.md +++ b/docs/TD_docs/methods/searchChatMessages.md @@ -15,13 +15,13 @@ Searches for messages with given words in the chat. Returns result in reverse ch | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier to search messages in| -|query|[CLICK ME string](../types/string.md) | Yes|Query to search for| -|sender\_user\_id|[CLICK ME int](../types/int.md) | Yes|If not 0, only messages sent by the specified user will be returned. Doesn't supported in secret chats| -|from\_message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the message from which we need a history, you can use 0 to get results from the beginning| -|offset|[CLICK ME int](../types/int.md) | Yes|Specify 0 to get results exactly from from_message_id or negative offset to get specified message and some newer messages| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of messages to be returned, should be positive and can't be greater than 100. If offset is negative, limit must be greater than -offset. There may be less than limit messages returned even the end of the history is not reached| -|filter|[CLICK ME SearchMessagesFilter](../types/SearchMessagesFilter.md) | Optional|Filter for content of the searched messages| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier to search messages in| +|query|[string](../types/string.md) | Yes|Query to search for| +|sender\_user\_id|[int](../types/int.md) | Yes|If not 0, only messages sent by the specified user will be returned. Doesn't supported in secret chats| +|from\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the message from which we need a history, you can use 0 to get results from the beginning| +|offset|[int](../types/int.md) | Yes|Specify 0 to get results exactly from from_message_id or negative offset to get specified message and some newer messages| +|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, should be positive and can't be greater than 100. If offset is negative, limit must be greater than -offset. There may be less than limit messages returned even the end of the history is not reached| +|filter|[SearchMessagesFilter](../types/SearchMessagesFilter.md) | Optional|Filter for content of the searched messages| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/searchChats.md b/docs/TD_docs/methods/searchChats.md index 12d2d53c..1fbbe420 100644 --- a/docs/TD_docs/methods/searchChats.md +++ b/docs/TD_docs/methods/searchChats.md @@ -15,8 +15,8 @@ Searches for specified query in the title and username of known chats, offline r | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME string](../types/string.md) | Yes|Query to search for, if query is empty, returns up to 20 recently found chats| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of chats to be returned| +|query|[string](../types/string.md) | Yes|Query to search for, if query is empty, returns up to 20 recently found chats| +|limit|[int](../types/int.md) | Yes|Maximum number of chats to be returned| ### Return type: [Chats](../types/Chats.md) diff --git a/docs/TD_docs/methods/searchContacts.md b/docs/TD_docs/methods/searchContacts.md index 4a3c8bc9..f8303cfa 100644 --- a/docs/TD_docs/methods/searchContacts.md +++ b/docs/TD_docs/methods/searchContacts.md @@ -15,8 +15,8 @@ Searches for specified query in the first name, last name and username of the kn | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME string](../types/string.md) | Yes|Query to search for, can be empty to return all contacts| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of users to be returned| +|query|[string](../types/string.md) | Yes|Query to search for, can be empty to return all contacts| +|limit|[int](../types/int.md) | Yes|Maximum number of users to be returned| ### Return type: [Users](../types/Users.md) diff --git a/docs/TD_docs/methods/searchHashtags.md b/docs/TD_docs/methods/searchHashtags.md index 1eef9231..683bc45b 100644 --- a/docs/TD_docs/methods/searchHashtags.md +++ b/docs/TD_docs/methods/searchHashtags.md @@ -15,8 +15,8 @@ Searches for recently used hashtags by their prefix | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|prefix|[CLICK ME string](../types/string.md) | Yes|Hashtag prefix to search for| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of hashtags to return| +|prefix|[string](../types/string.md) | Yes|Hashtag prefix to search for| +|limit|[int](../types/int.md) | Yes|Maximum number of hashtags to return| ### Return type: [Hashtags](../types/Hashtags.md) diff --git a/docs/TD_docs/methods/searchMessages.md b/docs/TD_docs/methods/searchMessages.md index e7f01abc..0bd212d5 100644 --- a/docs/TD_docs/methods/searchMessages.md +++ b/docs/TD_docs/methods/searchMessages.md @@ -15,11 +15,11 @@ Searches for messages in all chats except secret chats. Returns result in revers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME string](../types/string.md) | Yes|Query to search for| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|Date of the message to search from, you can use 0 or any date in the future to get results from the beginning| -|offset\_chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier of the last found message or 0 for the first request| -|offset\_message\_id|[CLICK ME int53](../types/int53.md) | Yes|Message identifier of the last found message or 0 for the first request| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of messages to be returned, at most 100| +|query|[string](../types/string.md) | Yes|Query to search for| +|offset\_date|[int](../types/int.md) | Yes|Date of the message to search from, you can use 0 or any date in the future to get results from the beginning| +|offset\_chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the last found message or 0 for the first request| +|offset\_message\_id|[int53](../types/int53.md) | Yes|Message identifier of the last found message or 0 for the first request| +|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, at most 100| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/searchPublicChat.md b/docs/TD_docs/methods/searchPublicChat.md index 1ee71698..9eb7526a 100644 --- a/docs/TD_docs/methods/searchPublicChat.md +++ b/docs/TD_docs/methods/searchPublicChat.md @@ -15,7 +15,7 @@ Searches public chat by its username. Currently only private and channel chats c | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|Username to be resolved| +|username|[string](../types/string.md) | Yes|Username to be resolved| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/searchPublicChats.md b/docs/TD_docs/methods/searchPublicChats.md index 63e48170..43929165 100644 --- a/docs/TD_docs/methods/searchPublicChats.md +++ b/docs/TD_docs/methods/searchPublicChats.md @@ -15,7 +15,7 @@ Searches public chats by prefix of their username. Currently only private and ch | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username\_prefix|[CLICK ME string](../types/string.md) | Yes|Prefix of the username to search| +|username\_prefix|[string](../types/string.md) | Yes|Prefix of the username to search| ### Return type: [Chats](../types/Chats.md) diff --git a/docs/TD_docs/methods/searchSecretMessages.md b/docs/TD_docs/methods/searchSecretMessages.md index c5558e46..0c262cd6 100644 --- a/docs/TD_docs/methods/searchSecretMessages.md +++ b/docs/TD_docs/methods/searchSecretMessages.md @@ -15,11 +15,11 @@ Searches for messages in secret chats. Returns result in reverse chronological o | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of a chat to search in. Specify 0 to search in all secret chats| -|query|[CLICK ME string](../types/string.md) | Yes|Query to search for. If empty, searchChatMessages should be used instead| -|from\_search\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier from the result of previous request, use 0 to get results from the beginning| -|limit|[CLICK ME int](../types/int.md) | Yes|Maximum number of messages to be returned, can't be greater than 100| -|filter|[CLICK ME SearchMessagesFilter](../types/SearchMessagesFilter.md) | Optional|Filter for content of searched messages| +|chat\_id|[int53](../types/int53.md) | Yes|Identifier of a chat to search in. Specify 0 to search in all secret chats| +|query|[string](../types/string.md) | Yes|Query to search for. If empty, searchChatMessages should be used instead| +|from\_search\_id|[int64](../constructors/int64.md) | Yes|Identifier from the result of previous request, use 0 to get results from the beginning| +|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, can't be greater than 100| +|filter|[SearchMessagesFilter](../types/SearchMessagesFilter.md) | Optional|Filter for content of searched messages| ### Return type: [FoundMessages](../types/FoundMessages.md) diff --git a/docs/TD_docs/methods/searchStickerSet.md b/docs/TD_docs/methods/searchStickerSet.md index 3055e552..18ca56ea 100644 --- a/docs/TD_docs/methods/searchStickerSet.md +++ b/docs/TD_docs/methods/searchStickerSet.md @@ -15,7 +15,7 @@ Searches sticker set by its short name | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|name|[CLICK ME string](../types/string.md) | Yes|Name of the sticker set| +|name|[string](../types/string.md) | Yes|Name of the sticker set| ### Return type: [StickerSet](../types/StickerSet.md) diff --git a/docs/TD_docs/methods/sendBotStartMessage.md b/docs/TD_docs/methods/sendBotStartMessage.md index cbbd1b24..c0664450 100644 --- a/docs/TD_docs/methods/sendBotStartMessage.md +++ b/docs/TD_docs/methods/sendBotStartMessage.md @@ -15,9 +15,9 @@ Invites bot to a chat (if it is not in the chat) and send /start to it. Bot can' | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|bot\_user\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the bot| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the chat| -|parameter|[CLICK ME string](../types/string.md) | Yes|Hidden parameter sent to bot for deep linking (https: api.telegram.org/bots#deep-linking)| +|bot\_user\_id|[int](../types/int.md) | Yes|Identifier of the bot| +|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat| +|parameter|[string](../types/string.md) | Yes|Hidden parameter sent to bot for deep linking (https: api.telegram.org/bots#deep-linking)| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/sendChatAction.md b/docs/TD_docs/methods/sendChatAction.md index 65183526..9dcb0c25 100644 --- a/docs/TD_docs/methods/sendChatAction.md +++ b/docs/TD_docs/methods/sendChatAction.md @@ -15,8 +15,8 @@ Sends notification about user activity in a chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|action|[CLICK ME ChatAction](../types/ChatAction.md) | Yes|Action description| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|action|[ChatAction](../types/ChatAction.md) | Yes|Action description| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/sendChatScreenshotTakenNotification.md b/docs/TD_docs/methods/sendChatScreenshotTakenNotification.md index b624b2a4..25b03427 100644 --- a/docs/TD_docs/methods/sendChatScreenshotTakenNotification.md +++ b/docs/TD_docs/methods/sendChatScreenshotTakenNotification.md @@ -15,7 +15,7 @@ Sends notification about screenshot taken in a chat. Works only in private and s | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/sendChatSetTtlMessage.md b/docs/TD_docs/methods/sendChatSetTtlMessage.md index 0a4fe658..933482c1 100644 --- a/docs/TD_docs/methods/sendChatSetTtlMessage.md +++ b/docs/TD_docs/methods/sendChatSetTtlMessage.md @@ -15,8 +15,8 @@ Changes current ttl setting in a secret chat and sends corresponding message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|ttl|[CLICK ME int](../types/int.md) | Yes|New value of ttl in seconds| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|ttl|[int](../types/int.md) | Yes|New value of ttl in seconds| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/sendCustomRequest.md b/docs/TD_docs/methods/sendCustomRequest.md index 2c553f3c..b7f88aab 100644 --- a/docs/TD_docs/methods/sendCustomRequest.md +++ b/docs/TD_docs/methods/sendCustomRequest.md @@ -15,8 +15,8 @@ Bots only. Sends custom request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|method|[CLICK ME string](../types/string.md) | Yes|Method name| -|parameters|[CLICK ME string](../types/string.md) | Yes|JSON-serialized method parameters| +|method|[string](../types/string.md) | Yes|Method name| +|parameters|[string](../types/string.md) | Yes|JSON-serialized method parameters| ### Return type: [CustomRequestResult](../types/CustomRequestResult.md) diff --git a/docs/TD_docs/methods/sendInlineQueryResultMessage.md b/docs/TD_docs/methods/sendInlineQueryResultMessage.md index 9ed525c6..b2edb7fd 100644 --- a/docs/TD_docs/methods/sendInlineQueryResultMessage.md +++ b/docs/TD_docs/methods/sendInlineQueryResultMessage.md @@ -15,12 +15,12 @@ Sends result of the inline query as a message. Returns sent message. Always clea | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat to send message| -|reply\_to\_message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of a message to reply to or 0| -|disable\_notification|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true, to disable notification about the message, doesn't works in secret chats| -|from\_background|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true, if the message is sent from background| -|query\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of the inline query| -|result\_id|[CLICK ME string](../types/string.md) | Yes|Identifier of the inline result| +|chat\_id|[int53](../types/int53.md) | Yes|Chat to send message| +|reply\_to\_message\_id|[int53](../types/int53.md) | Yes|Identifier of a message to reply to or 0| +|disable\_notification|[Bool](../types/Bool.md) | Yes|Pass true, to disable notification about the message, doesn't works in secret chats| +|from\_background|[Bool](../types/Bool.md) | Yes|Pass true, if the message is sent from background| +|query\_id|[int64](../constructors/int64.md) | Yes|Identifier of the inline query| +|result\_id|[string](../types/string.md) | Yes|Identifier of the inline result| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/sendMessage.md b/docs/TD_docs/methods/sendMessage.md index 7490b967..2c2eb42e 100644 --- a/docs/TD_docs/methods/sendMessage.md +++ b/docs/TD_docs/methods/sendMessage.md @@ -15,12 +15,12 @@ Sends a message. Returns sent message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat to send message| -|reply\_to\_message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of a message to reply to or 0| -|disable\_notification|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true, to disable notification about the message, doesn't works in secret chats| -|from\_background|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true, if the message is sent from background| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Yes|Bots only. Markup for replying to message| -|input\_message\_content|[CLICK ME InputMessageContent](../types/InputMessageContent.md) | Yes|Content of a message to send| +|chat\_id|[int53](../types/int53.md) | Yes|Chat to send message| +|reply\_to\_message\_id|[int53](../types/int53.md) | Yes|Identifier of a message to reply to or 0| +|disable\_notification|[Bool](../types/Bool.md) | Yes|Pass true, to disable notification about the message, doesn't works in secret chats| +|from\_background|[Bool](../types/Bool.md) | Yes|Pass true, if the message is sent from background| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|Bots only. Markup for replying to message| +|input\_message\_content|[InputMessageContent](../types/InputMessageContent.md) | Yes|Content of a message to send| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/sendPaymentForm.md b/docs/TD_docs/methods/sendPaymentForm.md index 093750ee..f775d47e 100644 --- a/docs/TD_docs/methods/sendPaymentForm.md +++ b/docs/TD_docs/methods/sendPaymentForm.md @@ -15,11 +15,11 @@ Sends filled payment form to the bot for the final verification | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier of the Invoice message| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Message identifier| -|order\_info\_id|[CLICK ME string](../types/string.md) | Yes|Identifier returned by ValidateOrderInfo or empty string| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Yes|Identifier of a chosen shipping option, if applicable| -|credentials|[CLICK ME InputCredentials](../types/InputCredentials.md) | Yes|Credentials choosed by user for payment| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the Invoice message| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier| +|order\_info\_id|[string](../types/string.md) | Yes|Identifier returned by ValidateOrderInfo or empty string| +|shipping\_option\_id|[string](../types/string.md) | Yes|Identifier of a chosen shipping option, if applicable| +|credentials|[InputCredentials](../types/InputCredentials.md) | Yes|Credentials choosed by user for payment| ### Return type: [PaymentResult](../types/PaymentResult.md) diff --git a/docs/TD_docs/methods/setAlarm.md b/docs/TD_docs/methods/setAlarm.md index 05f5434c..039e6850 100644 --- a/docs/TD_docs/methods/setAlarm.md +++ b/docs/TD_docs/methods/setAlarm.md @@ -15,7 +15,7 @@ Returns Ok after specified amount of the time passed. Can be called before autho | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|seconds|[CLICK ME double](../types/double.md) | Yes|Number of seconds before that function returns| +|seconds|[double](../types/double.md) | Yes|Number of seconds before that function returns| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setAuthPhoneNumber.md b/docs/TD_docs/methods/setAuthPhoneNumber.md index afbf4a74..0249f694 100644 --- a/docs/TD_docs/methods/setAuthPhoneNumber.md +++ b/docs/TD_docs/methods/setAuthPhoneNumber.md @@ -15,9 +15,9 @@ Sets user's phone number and sends authentication code to the user. Works only w | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|User's phone number in any reasonable format| -|allow\_flash\_call|[CLICK ME Bool](../types/Bool.md) | Yes|Pass True, if code can be sent via flash call to the specified phone number| -|is\_current\_phone\_number|[CLICK ME Bool](../types/Bool.md) | Yes|Pass true, if the phone number is used on the current device. Ignored if allow_flash_call is False| +|phone\_number|[string](../types/string.md) | Yes|User's phone number in any reasonable format| +|allow\_flash\_call|[Bool](../types/Bool.md) | Yes|Pass True, if code can be sent via flash call to the specified phone number| +|is\_current\_phone\_number|[Bool](../types/Bool.md) | Yes|Pass true, if the phone number is used on the current device. Ignored if allow_flash_call is False| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/setBotUpdatesStatus.md b/docs/TD_docs/methods/setBotUpdatesStatus.md index d13e6c0e..e4f4f107 100644 --- a/docs/TD_docs/methods/setBotUpdatesStatus.md +++ b/docs/TD_docs/methods/setBotUpdatesStatus.md @@ -15,8 +15,8 @@ Bots only. Informs server about number of pending bot updates if they aren't pro | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pending\_update\_count|[CLICK ME int](../types/int.md) | Yes|Number of pending updates| -|error\_message|[CLICK ME string](../types/string.md) | Yes|Last error's message| +|pending\_update\_count|[int](../types/int.md) | Yes|Number of pending updates| +|error\_message|[string](../types/string.md) | Yes|Last error's message| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setChannelStickerSet.md b/docs/TD_docs/methods/setChannelStickerSet.md index fe49adb1..d80abb21 100644 --- a/docs/TD_docs/methods/setChannelStickerSet.md +++ b/docs/TD_docs/methods/setChannelStickerSet.md @@ -15,8 +15,8 @@ Changes sticker set of the channel. Needs appropriate rights in the channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the channel| -|sticker\_set\_id|[CLICK ME int64](../constructors/int64.md) | Yes|New value of channel sticker set identifier. Use 0 to remove channel sticker set| +|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| +|sticker\_set\_id|[int64](../constructors/int64.md) | Yes|New value of channel sticker set identifier. Use 0 to remove channel sticker set| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setChatClientData.md b/docs/TD_docs/methods/setChatClientData.md index f215dadd..f2bd9293 100644 --- a/docs/TD_docs/methods/setChatClientData.md +++ b/docs/TD_docs/methods/setChatClientData.md @@ -15,8 +15,8 @@ Changes client data associated with a chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|client\_data|[CLICK ME string](../types/string.md) | Yes|New value of client_data| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|client\_data|[string](../types/string.md) | Yes|New value of client_data| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setFileGenerationProgress.md b/docs/TD_docs/methods/setFileGenerationProgress.md index 59d3acb8..247b7abd 100644 --- a/docs/TD_docs/methods/setFileGenerationProgress.md +++ b/docs/TD_docs/methods/setFileGenerationProgress.md @@ -15,9 +15,9 @@ Next part of a file was generated | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|generation\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Identifier of the generation process| -|size|[CLICK ME int](../types/int.md) | Yes|Full size of file in bytes, 0 if unknown.| -|local\_size|[CLICK ME int](../types/int.md) | Yes|Number of bytes already generated. Negative number means that generation has failed and should be terminated| +|generation\_id|[int64](../constructors/int64.md) | Yes|Identifier of the generation process| +|size|[int](../types/int.md) | Yes|Full size of file in bytes, 0 if unknown.| +|local\_size|[int](../types/int.md) | Yes|Number of bytes already generated. Negative number means that generation has failed and should be terminated| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setGameScore.md b/docs/TD_docs/methods/setGameScore.md index c4ab44c8..3f74e8a1 100644 --- a/docs/TD_docs/methods/setGameScore.md +++ b/docs/TD_docs/methods/setGameScore.md @@ -15,12 +15,12 @@ Bots only. Updates game score of the specified user in the game | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat a message with the game belongs to| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Identifier of the message| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Yes|True, if message should be edited| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifier| -|score|[CLICK ME int](../types/int.md) | Yes|New score| -|force|[CLICK ME Bool](../types/Bool.md) | Yes|Pass True to update the score even if it decreases. If score is 0, user will be deleted from the high scores table| +|chat\_id|[int53](../types/int53.md) | Yes|Chat a message with the game belongs to| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| +|edit\_message|[Bool](../types/Bool.md) | Yes|True, if message should be edited| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|score|[int](../types/int.md) | Yes|New score| +|force|[Bool](../types/Bool.md) | Yes|Pass True to update the score even if it decreases. If score is 0, user will be deleted from the high scores table| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/setInlineGameScore.md b/docs/TD_docs/methods/setInlineGameScore.md index c5be8813..1dc7e6ad 100644 --- a/docs/TD_docs/methods/setInlineGameScore.md +++ b/docs/TD_docs/methods/setInlineGameScore.md @@ -15,11 +15,11 @@ Bots only. Updates game score of the specified user in the game | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|inline\_message\_id|[CLICK ME string](../types/string.md) | Yes|Inline message identifier| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Yes|True, if message should be edited| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifier| -|score|[CLICK ME int](../types/int.md) | Yes|New score| -|force|[CLICK ME Bool](../types/Bool.md) | Yes|Pass True to update the score even if it decreases. If score is 0, user will be deleted from the high scores table| +|inline\_message\_id|[string](../types/string.md) | Yes|Inline message identifier| +|edit\_message|[Bool](../types/Bool.md) | Yes|True, if message should be edited| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|score|[int](../types/int.md) | Yes|New score| +|force|[Bool](../types/Bool.md) | Yes|Pass True to update the score even if it decreases. If score is 0, user will be deleted from the high scores table| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setNetworkType.md b/docs/TD_docs/methods/setNetworkType.md index 120c47c7..e14beee8 100644 --- a/docs/TD_docs/methods/setNetworkType.md +++ b/docs/TD_docs/methods/setNetworkType.md @@ -15,7 +15,7 @@ Sets current network type. Can be called before authorization. Call to this meth | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|type|[CLICK ME NetworkType](../types/NetworkType.md) | Yes|New network type, defaults to networkTypeNone| +|type|[NetworkType](../types/NetworkType.md) | Yes|New network type, defaults to networkTypeNone| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setNotificationSettings.md b/docs/TD_docs/methods/setNotificationSettings.md index 5c785921..844981cf 100644 --- a/docs/TD_docs/methods/setNotificationSettings.md +++ b/docs/TD_docs/methods/setNotificationSettings.md @@ -15,8 +15,8 @@ Changes notification settings for a given scope | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|scope|[CLICK ME NotificationSettingsScope](../types/NotificationSettingsScope.md) | Yes|Scope to change notification settings| -|notification\_settings|[CLICK ME notificationSettings](../constructors/notificationSettings.md) | Yes|New notification settings for given scope| +|scope|[NotificationSettingsScope](../types/NotificationSettingsScope.md) | Yes|Scope to change notification settings| +|notification\_settings|[notificationSettings](../constructors/notificationSettings.md) | Yes|New notification settings for given scope| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setOption.md b/docs/TD_docs/methods/setOption.md index 15115a99..7854da3d 100644 --- a/docs/TD_docs/methods/setOption.md +++ b/docs/TD_docs/methods/setOption.md @@ -15,8 +15,8 @@ Sets value of an option. See list of available options on https: core.telegram.o | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|name|[CLICK ME string](../types/string.md) | Yes|Name of the option| -|value|[CLICK ME OptionValue](../types/OptionValue.md) | Optional|New value of the option| +|name|[string](../types/string.md) | Yes|Name of the option| +|value|[OptionValue](../types/OptionValue.md) | Optional|New value of the option| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setPassword.md b/docs/TD_docs/methods/setPassword.md index 23b60360..db54c4e6 100644 --- a/docs/TD_docs/methods/setPassword.md +++ b/docs/TD_docs/methods/setPassword.md @@ -15,11 +15,11 @@ Changes user password. If new recovery email is specified, then error EMAIL_UNCO | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|old\_password|[CLICK ME string](../types/string.md) | Yes|Old user password| -|new\_password|[CLICK ME string](../types/string.md) | Yes|New user password, may be empty to remove the password| -|new\_hint|[CLICK ME string](../types/string.md) | Yes|New password hint, can be empty| -|set\_recovery\_email|[CLICK ME Bool](../types/Bool.md) | Yes|Pass True, if recovery email should be changed| -|new\_recovery\_email|[CLICK ME string](../types/string.md) | Yes|New recovery email, may be empty| +|old\_password|[string](../types/string.md) | Yes|Old user password| +|new\_password|[string](../types/string.md) | Yes|New user password, may be empty to remove the password| +|new\_hint|[string](../types/string.md) | Yes|New password hint, can be empty| +|set\_recovery\_email|[Bool](../types/Bool.md) | Yes|Pass True, if recovery email should be changed| +|new\_recovery\_email|[string](../types/string.md) | Yes|New recovery email, may be empty| ### Return type: [PasswordState](../types/PasswordState.md) diff --git a/docs/TD_docs/methods/setPinnedChats.md b/docs/TD_docs/methods/setPinnedChats.md index 48b494a3..5bece291 100644 --- a/docs/TD_docs/methods/setPinnedChats.md +++ b/docs/TD_docs/methods/setPinnedChats.md @@ -15,7 +15,7 @@ Changes list or order of pinned chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_ids|Array of [CLICK ME int53](../types/int53.md) | Yes|New list of pinned chats| +|chat\_ids|Array of [int53](../types/int53.md) | Yes|New list of pinned chats| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setPrivacy.md b/docs/TD_docs/methods/setPrivacy.md index 129fbdf7..ca8b13df 100644 --- a/docs/TD_docs/methods/setPrivacy.md +++ b/docs/TD_docs/methods/setPrivacy.md @@ -15,8 +15,8 @@ Changes privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME PrivacyKey](../types/PrivacyKey.md) | Yes|Privacy key| -|rules|[CLICK ME privacyRules](../constructors/privacyRules.md) | Yes|New privacy rules| +|key|[PrivacyKey](../types/PrivacyKey.md) | Yes|Privacy key| +|rules|[privacyRules](../constructors/privacyRules.md) | Yes|New privacy rules| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setProfilePhoto.md b/docs/TD_docs/methods/setProfilePhoto.md index c35fe96a..7d69836c 100644 --- a/docs/TD_docs/methods/setProfilePhoto.md +++ b/docs/TD_docs/methods/setProfilePhoto.md @@ -15,7 +15,7 @@ Uploads new profile photo for logged in user. If something changes, updateUser w | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|photo|[CLICK ME InputFile](../types/InputFile.md) | Yes|Profile photo to set. inputFileId and inputFilePersistentId may be unsupported| +|photo|[InputFile](../types/InputFile.md) | Yes|Profile photo to set. inputFileId and inputFilePersistentId may be unsupported| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setProxy.md b/docs/TD_docs/methods/setProxy.md index f538a668..6fde536c 100644 --- a/docs/TD_docs/methods/setProxy.md +++ b/docs/TD_docs/methods/setProxy.md @@ -15,7 +15,7 @@ Sets proxy server for network requests. Can be called before authorization | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|proxy|[CLICK ME Proxy](../types/Proxy.md) | Optional|The proxy to use. You can specify null to remove proxy server| +|proxy|[Proxy](../types/Proxy.md) | Optional|The proxy to use. You can specify null to remove proxy server| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setRecoveryEmail.md b/docs/TD_docs/methods/setRecoveryEmail.md index 7a9442c3..1c09cc44 100644 --- a/docs/TD_docs/methods/setRecoveryEmail.md +++ b/docs/TD_docs/methods/setRecoveryEmail.md @@ -15,8 +15,8 @@ Changes user recovery email. If new recovery email is specified, then error EMAI | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|password|[CLICK ME string](../types/string.md) | Yes|Current user password| -|new\_recovery\_email|[CLICK ME string](../types/string.md) | Yes|New recovery email| +|password|[string](../types/string.md) | Yes|Current user password| +|new\_recovery\_email|[string](../types/string.md) | Yes|New recovery email| ### Return type: [PasswordState](../types/PasswordState.md) diff --git a/docs/TD_docs/methods/setStickerPositionInSet.md b/docs/TD_docs/methods/setStickerPositionInSet.md index e1d704d6..3b6fff1c 100644 --- a/docs/TD_docs/methods/setStickerPositionInSet.md +++ b/docs/TD_docs/methods/setStickerPositionInSet.md @@ -15,8 +15,8 @@ Bots only. Changes position of a sticker in the set it belongs to. Sticker set s | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sticker|[CLICK ME InputFile](../types/InputFile.md) | Yes|The sticker| -|position|[CLICK ME int](../types/int.md) | Yes|New sticker position in the set, zero-based| +|sticker|[InputFile](../types/InputFile.md) | Yes|The sticker| +|position|[int](../types/int.md) | Yes|New sticker position in the set, zero-based| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/terminateSession.md b/docs/TD_docs/methods/terminateSession.md index bc0bc32f..5e9944f4 100644 --- a/docs/TD_docs/methods/terminateSession.md +++ b/docs/TD_docs/methods/terminateSession.md @@ -15,7 +15,7 @@ Terminates another session of logged in user | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|session\_id|[CLICK ME int64](../constructors/int64.md) | Yes|Session identifier| +|session\_id|[int64](../constructors/int64.md) | Yes|Session identifier| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/testCallBytes.md b/docs/TD_docs/methods/testCallBytes.md index 8beb5769..e3dd8558 100644 --- a/docs/TD_docs/methods/testCallBytes.md +++ b/docs/TD_docs/methods/testCallBytes.md @@ -15,7 +15,7 @@ Test request. Returns back received bytes | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|x|[CLICK ME bytes](../types/bytes.md) | Yes|Bytes to return| +|x|[bytes](../types/bytes.md) | Yes|Bytes to return| ### Return type: [TestBytes](../types/TestBytes.md) diff --git a/docs/TD_docs/methods/testCallString.md b/docs/TD_docs/methods/testCallString.md index f0f3eda9..4ff0c730 100644 --- a/docs/TD_docs/methods/testCallString.md +++ b/docs/TD_docs/methods/testCallString.md @@ -15,7 +15,7 @@ Test request. Returns back received string | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|x|[CLICK ME string](../types/string.md) | Yes|String to return| +|x|[string](../types/string.md) | Yes|String to return| ### Return type: [TestString](../types/TestString.md) diff --git a/docs/TD_docs/methods/testCallVectorInt.md b/docs/TD_docs/methods/testCallVectorInt.md index 515f5bd9..434dd9a8 100644 --- a/docs/TD_docs/methods/testCallVectorInt.md +++ b/docs/TD_docs/methods/testCallVectorInt.md @@ -15,7 +15,7 @@ Test request. Returns back received vector of numbers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|x|Array of [CLICK ME int](../types/int.md) | Yes|Vector of numbers to return| +|x|Array of [int](../types/int.md) | Yes|Vector of numbers to return| ### Return type: [TestVectorInt](../types/TestVectorInt.md) diff --git a/docs/TD_docs/methods/testCallVectorIntObject.md b/docs/TD_docs/methods/testCallVectorIntObject.md index 35d83fb1..5d7853af 100644 --- a/docs/TD_docs/methods/testCallVectorIntObject.md +++ b/docs/TD_docs/methods/testCallVectorIntObject.md @@ -15,7 +15,7 @@ Test request. Returns back received vector of objects containing a number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|x|Array of [CLICK ME testInt](../constructors/testInt.md) | Yes|Vector of objects to return| +|x|Array of [testInt](../constructors/testInt.md) | Yes|Vector of objects to return| ### Return type: [TestVectorIntObject](../types/TestVectorIntObject.md) diff --git a/docs/TD_docs/methods/testCallVectorString.md b/docs/TD_docs/methods/testCallVectorString.md index d7ba6d26..714ed50f 100644 --- a/docs/TD_docs/methods/testCallVectorString.md +++ b/docs/TD_docs/methods/testCallVectorString.md @@ -15,7 +15,7 @@ Test request. Returns back received vector of strings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|x|Array of [CLICK ME string](../types/string.md) | Yes|Vector of strings to return| +|x|Array of [string](../types/string.md) | Yes|Vector of strings to return| ### Return type: [TestVectorString](../types/TestVectorString.md) diff --git a/docs/TD_docs/methods/testCallVectorStringObject.md b/docs/TD_docs/methods/testCallVectorStringObject.md index 8a1ec728..d3ccedf7 100644 --- a/docs/TD_docs/methods/testCallVectorStringObject.md +++ b/docs/TD_docs/methods/testCallVectorStringObject.md @@ -15,7 +15,7 @@ Test request. Returns back received vector of objects containing a string | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|x|Array of [CLICK ME testString](../constructors/testString.md) | Yes|Vector of objects to return| +|x|Array of [testString](../constructors/testString.md) | Yes|Vector of objects to return| ### Return type: [TestVectorStringObject](../types/TestVectorStringObject.md) diff --git a/docs/TD_docs/methods/testSquareInt.md b/docs/TD_docs/methods/testSquareInt.md index 1a4ab278..1c54ae68 100644 --- a/docs/TD_docs/methods/testSquareInt.md +++ b/docs/TD_docs/methods/testSquareInt.md @@ -15,7 +15,7 @@ Test request. Returns squared received number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|x|[CLICK ME int](../types/int.md) | Yes|Number to square| +|x|[int](../types/int.md) | Yes|Number to square| ### Return type: [TestInt](../types/TestInt.md) diff --git a/docs/TD_docs/methods/toggleChannelInvites.md b/docs/TD_docs/methods/toggleChannelInvites.md index e9d98451..7988a079 100644 --- a/docs/TD_docs/methods/toggleChannelInvites.md +++ b/docs/TD_docs/methods/toggleChannelInvites.md @@ -15,8 +15,8 @@ Gives or revokes right to invite new members to all current members of the chann | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the channel| -|anyone\_can\_invite|[CLICK ME Bool](../types/Bool.md) | Yes|New value of anyone_can_invite| +|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| +|anyone\_can\_invite|[Bool](../types/Bool.md) | Yes|New value of anyone_can_invite| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/toggleChannelSignMessages.md b/docs/TD_docs/methods/toggleChannelSignMessages.md index 7d883c2f..cc2b599e 100644 --- a/docs/TD_docs/methods/toggleChannelSignMessages.md +++ b/docs/TD_docs/methods/toggleChannelSignMessages.md @@ -15,8 +15,8 @@ Enables or disables sender signature on sent messages in the channel. Needs appr | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the channel| -|sign\_messages|[CLICK ME Bool](../types/Bool.md) | Yes|New value of sign_messages| +|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| +|sign\_messages|[Bool](../types/Bool.md) | Yes|New value of sign_messages| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/toggleChatIsPinned.md b/docs/TD_docs/methods/toggleChatIsPinned.md index 70aab583..80ac3655 100644 --- a/docs/TD_docs/methods/toggleChatIsPinned.md +++ b/docs/TD_docs/methods/toggleChatIsPinned.md @@ -15,8 +15,8 @@ Changes chat pinned state. You can pin up to getOption("pinned_chat_count_max") | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|is\_pinned|[CLICK ME Bool](../types/Bool.md) | Yes|New value of is_pinned| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|is\_pinned|[Bool](../types/Bool.md) | Yes|New value of is_pinned| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/toggleGroupAdministrators.md b/docs/TD_docs/methods/toggleGroupAdministrators.md index 2e9ad3d8..0f3ca948 100644 --- a/docs/TD_docs/methods/toggleGroupAdministrators.md +++ b/docs/TD_docs/methods/toggleGroupAdministrators.md @@ -15,8 +15,8 @@ Gives or revokes all members of the group administrator rights. Needs creator pr | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|group\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the group| -|everyone\_is\_administrator|[CLICK ME Bool](../types/Bool.md) | Yes|New value of everyone_is_administrator| +|group\_id|[int](../types/int.md) | Yes|Identifier of the group| +|everyone\_is\_administrator|[Bool](../types/Bool.md) | Yes|New value of everyone_is_administrator| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/unblockUser.md b/docs/TD_docs/methods/unblockUser.md index 924b1efd..42138c63 100644 --- a/docs/TD_docs/methods/unblockUser.md +++ b/docs/TD_docs/methods/unblockUser.md @@ -15,7 +15,7 @@ Removes user from black list | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_id|[CLICK ME int](../types/int.md) | Yes|User identifier| +|user\_id|[int](../types/int.md) | Yes|User identifier| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/unpinChannelMessage.md b/docs/TD_docs/methods/unpinChannelMessage.md index 11637a82..0fabb70f 100644 --- a/docs/TD_docs/methods/unpinChannelMessage.md +++ b/docs/TD_docs/methods/unpinChannelMessage.md @@ -15,7 +15,7 @@ Removes pinned message in the supergroup channel. Needs appropriate rights in th | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel\_id|[CLICK ME int](../types/int.md) | Yes|Identifier of the channel| +|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/uploadFile.md b/docs/TD_docs/methods/uploadFile.md index e9562a18..8524e01d 100644 --- a/docs/TD_docs/methods/uploadFile.md +++ b/docs/TD_docs/methods/uploadFile.md @@ -15,9 +15,9 @@ Asynchronously uploads file to the cloud without sending it in a message. Update | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|file|[CLICK ME InputFile](../types/InputFile.md) | Yes|File to upload| -|file\_type|[CLICK ME FileType](../types/FileType.md) | Yes|File type| -|priority|[CLICK ME int](../types/int.md) | Yes|Priority of upload, 1-32. The higher priority, the earlier file will be uploaded. If priorities of two files are equal then the first one for which uploadFile is called will be uploaded first| +|file|[InputFile](../types/InputFile.md) | Yes|File to upload| +|file\_type|[FileType](../types/FileType.md) | Yes|File type| +|priority|[int](../types/int.md) | Yes|Priority of upload, 1-32. The higher priority, the earlier file will be uploaded. If priorities of two files are equal then the first one for which uploadFile is called will be uploaded first| ### Return type: [File](../types/File.md) diff --git a/docs/TD_docs/methods/uploadStickerFile.md b/docs/TD_docs/methods/uploadStickerFile.md index 2aebf81a..2b3f37c3 100644 --- a/docs/TD_docs/methods/uploadStickerFile.md +++ b/docs/TD_docs/methods/uploadStickerFile.md @@ -15,8 +15,8 @@ Bots only. Uploads a png image with a sticker. Returns uploaded file | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user\_id|[CLICK ME int](../types/int.md) | Yes|Sticker file owner| -|png\_sticker|[CLICK ME InputFile](../types/InputFile.md) | Yes|Png image with the sticker, must be up to 512 kilobytes in size and fit in 512x512 square| +|user\_id|[int](../types/int.md) | Yes|Sticker file owner| +|png\_sticker|[InputFile](../types/InputFile.md) | Yes|Png image with the sticker, must be up to 512 kilobytes in size and fit in 512x512 square| ### Return type: [File](../types/File.md) diff --git a/docs/TD_docs/methods/validateOrderInfo.md b/docs/TD_docs/methods/validateOrderInfo.md index afc22331..a900fe62 100644 --- a/docs/TD_docs/methods/validateOrderInfo.md +++ b/docs/TD_docs/methods/validateOrderInfo.md @@ -15,10 +15,10 @@ Validates order information provided by the user and returns available shipping | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier of the Invoice message| -|message\_id|[CLICK ME int53](../types/int53.md) | Yes|Message identifier| -|order\_info|[CLICK ME orderInfo](../constructors/orderInfo.md) | Yes|Order information, provided by the user| -|allow\_save|[CLICK ME Bool](../types/Bool.md) | Yes|True, if order information can be saved| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the Invoice message| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier| +|order\_info|[orderInfo](../constructors/orderInfo.md) | Yes|Order information, provided by the user| +|allow\_save|[Bool](../types/Bool.md) | Yes|True, if order information can be saved| ### Return type: [ValidatedOrderInfo](../types/ValidatedOrderInfo.md) diff --git a/docs/TD_docs/methods/viewMessages.md b/docs/TD_docs/methods/viewMessages.md index 7644cce7..b02cfda8 100644 --- a/docs/TD_docs/methods/viewMessages.md +++ b/docs/TD_docs/methods/viewMessages.md @@ -15,8 +15,8 @@ Messages are viewed by the user. Many useful activities depends on message being | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[CLICK ME int53](../types/int53.md) | Yes|Chat identifier| -|message\_ids|Array of [CLICK ME int53](../types/int53.md) | Yes|Identifiers of viewed messages| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of viewed messages| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/viewTrendingStickerSets.md b/docs/TD_docs/methods/viewTrendingStickerSets.md index 4f1df0b4..401b409c 100644 --- a/docs/TD_docs/methods/viewTrendingStickerSets.md +++ b/docs/TD_docs/methods/viewTrendingStickerSets.md @@ -15,7 +15,7 @@ Informs that some trending sticker sets are viewed by the user | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sticker\_set\_ids|Array of [CLICK ME int64](../constructors/int64.md) | Yes|Identifiers of viewed trending sticker sets| +|sticker\_set\_ids|Array of [int64](../constructors/int64.md) | Yes|Identifiers of viewed trending sticker sets| ### Return type: [Ok](../types/Ok.md) diff --git a/old_docs/API_docs_v18/methods/account_checkUsername.md b/old_docs/API_docs_v18/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v18/methods/account_checkUsername.md +++ b/old_docs/API_docs_v18/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v18/methods/account_getNotifySettings.md b/old_docs/API_docs_v18/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v18/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v18/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v18/methods/account_registerDevice.md b/old_docs/API_docs_v18/methods/account_registerDevice.md index 8dae7506..a69b58ff 100644 --- a/old_docs/API_docs_v18/methods/account_registerDevice.md +++ b/old_docs/API_docs_v18/methods/account_registerDevice.md @@ -12,13 +12,13 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [Bool](../types/Bool.md) @@ -26,13 +26,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -81,3 +74,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v18/methods/account_unregisterDevice.md b/old_docs/API_docs_v18/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v18/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v18/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v18/methods/account_updateNotifySettings.md b/old_docs/API_docs_v18/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v18/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v18/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v18/methods/account_updateProfile.md b/old_docs/API_docs_v18/methods/account_updateProfile.md index caea3391..67ceb92e 100644 --- a/old_docs/API_docs_v18/methods/account_updateProfile.md +++ b/old_docs/API_docs_v18/methods/account_updateProfile.md @@ -12,8 +12,8 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Yes|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Yes|The last name| +|first\_name|[string](../types/string.md) | Yes|The first name| +|last\_name|[string](../types/string.md) | Yes|The last name| ### Return type: [User](../types/User.md) @@ -21,14 +21,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v18/methods/account_updateStatus.md b/old_docs/API_docs_v18/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v18/methods/account_updateStatus.md +++ b/old_docs/API_docs_v18/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v18/methods/account_updateUsername.md b/old_docs/API_docs_v18/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v18/methods/account_updateUsername.md +++ b/old_docs/API_docs_v18/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v18/methods/auth_checkPhone.md b/old_docs/API_docs_v18/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v18/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v18/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v18/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v18/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v18/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v18/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v18/methods/auth_sendCall.md b/old_docs/API_docs_v18/methods/auth_sendCall.md index 5947cda7..2f56038d 100644 --- a/old_docs/API_docs_v18/methods/auth_sendCall.md +++ b/old_docs/API_docs_v18/methods/auth_sendCall.md @@ -12,8 +12,8 @@ Send verification phone call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/auth_sendInvites.md b/old_docs/API_docs_v18/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v18/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v18/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v18/methods/auth_sendSms.md b/old_docs/API_docs_v18/methods/auth_sendSms.md index 41340660..38be5985 100644 --- a/old_docs/API_docs_v18/methods/auth_sendSms.md +++ b/old_docs/API_docs_v18/methods/auth_sendSms.md @@ -12,8 +12,8 @@ Send SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code ash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/contacts_block.md b/old_docs/API_docs_v18/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v18/methods/contacts_block.md +++ b/old_docs/API_docs_v18/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v18/methods/contacts_deleteContact.md b/old_docs/API_docs_v18/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v18/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v18/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v18/methods/contacts_deleteContacts.md b/old_docs/API_docs_v18/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v18/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v18/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v18/methods/contacts_getBlocked.md b/old_docs/API_docs_v18/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v18/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v18/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v18/methods/contacts_getContacts.md b/old_docs/API_docs_v18/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v18/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v18/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v18/methods/contacts_getSuggested.md b/old_docs/API_docs_v18/methods/contacts_getSuggested.md index 1ce04bef..1dba94e1 100644 --- a/old_docs/API_docs_v18/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v18/methods/contacts_getSuggested.md @@ -12,7 +12,7 @@ Get suggested contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v18/methods/contacts_importCard.md b/old_docs/API_docs_v18/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v18/methods/contacts_importCard.md +++ b/old_docs/API_docs_v18/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v18/methods/contacts_importContacts.md b/old_docs/API_docs_v18/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v18/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v18/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v18/methods/contacts_search.md b/old_docs/API_docs_v18/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v18/methods/contacts_search.md +++ b/old_docs/API_docs_v18/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v18/methods/contacts_unblock.md b/old_docs/API_docs_v18/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v18/methods/contacts_unblock.md +++ b/old_docs/API_docs_v18/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v18/methods/help_getAppUpdate.md b/old_docs/API_docs_v18/methods/help_getAppUpdate.md index ad5b8228..ce84843d 100644 --- a/old_docs/API_docs_v18/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v18/methods/help_getAppUpdate.md @@ -12,10 +12,10 @@ Get info about app updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Langauge code| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v18/methods/help_getConfig.md b/old_docs/API_docs_v18/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v18/methods/help_getConfig.md +++ b/old_docs/API_docs_v18/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v18/methods/help_getInviteText.md b/old_docs/API_docs_v18/methods/help_getInviteText.md index ad6ac262..9b82d55d 100644 --- a/old_docs/API_docs_v18/methods/help_getInviteText.md +++ b/old_docs/API_docs_v18/methods/help_getInviteText.md @@ -12,7 +12,7 @@ Get invitation text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language| +|lang\_code|[string](../types/string.md) | Yes|Language| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v18/methods/help_saveAppLog.md b/old_docs/API_docs_v18/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v18/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v18/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/initConnection.md b/old_docs/API_docs_v18/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v18/methods/initConnection.md +++ b/old_docs/API_docs_v18/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v18/methods/invokeAfterMsg.md b/old_docs/API_docs_v18/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v18/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v18/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v18/methods/invokeAfterMsgs.md b/old_docs/API_docs_v18/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v18/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v18/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v18/methods/invokeWithLayer18.md b/old_docs/API_docs_v18/methods/invokeWithLayer18.md index b67eca68..cbf23ca1 100644 --- a/old_docs/API_docs_v18/methods/invokeWithLayer18.md +++ b/old_docs/API_docs_v18/methods/invokeWithLayer18.md @@ -12,7 +12,7 @@ Invoke this method with layer 18 | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The method call| +|query|[!X](../types/!X.md) | Yes|The method call| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v18/methods/messages_addChatUser.md b/old_docs/API_docs_v18/methods/messages_addChatUser.md index 08b745d1..f3a5af49 100644 --- a/old_docs/API_docs_v18/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v18/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: messages_StatedMessage = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v18/methods/messages_createChat.md b/old_docs/API_docs_v18/methods/messages_createChat.md index 8a34e1fe..c35ee0e5 100644 --- a/old_docs/API_docs_v18/methods/messages_createChat.md +++ b/old_docs/API_docs_v18/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_StatedMessage = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v18/methods/messages_deleteChatUser.md b/old_docs/API_docs_v18/methods/messages_deleteChatUser.md index 8e8cf06b..57dd600a 100644 --- a/old_docs/API_docs_v18/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v18/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_StatedMessage = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v18/methods/messages_deleteHistory.md b/old_docs/API_docs_v18/methods/messages_deleteHistory.md index 77b8987e..38baaad6 100644 --- a/old_docs/API_docs_v18/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v18/methods/messages_deleteHistory.md @@ -13,7 +13,7 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|offset|[int](../types/int.md) | Yes|Offset| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -21,13 +21,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v18/methods/messages_deleteMessages.md b/old_docs/API_docs_v18/methods/messages_deleteMessages.md index fc9f6af3..d929116e 100644 --- a/old_docs/API_docs_v18/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v18/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [Vector\_of\_int](../types/int.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: Vector_of_int = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v18/methods/messages_editChatPhoto.md b/old_docs/API_docs_v18/methods/messages_editChatPhoto.md index c2958508..bf47a919 100644 --- a/old_docs/API_docs_v18/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v18/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: messages_StatedMessage = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v18/methods/messages_editChatTitle.md b/old_docs/API_docs_v18/methods/messages_editChatTitle.md index d2acc30b..fa40ece7 100644 --- a/old_docs/API_docs_v18/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v18/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StatedMessage = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v18/methods/messages_forwardMessage.md b/old_docs/API_docs_v18/methods/messages_forwardMessage.md index 295eda7a..519ee255 100644 --- a/old_docs/API_docs_v18/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v18/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_StatedMessage = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v18/methods/messages_forwardMessages.md b/old_docs/API_docs_v18/methods/messages_forwardMessages.md index f1eb9dc5..bd4e9693 100644 --- a/old_docs/API_docs_v18/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v18/methods/messages_forwardMessages.md @@ -13,7 +13,7 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_StatedMessages](../types/messages_StatedMessages.md) @@ -21,34 +21,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -96,3 +68,31 @@ Or, if you're into Lua: messages_StatedMessages = messages.forwardMessages({peer=InputPeer, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v18/methods/messages_getChats.md b/old_docs/API_docs_v18/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v18/methods/messages_getChats.md +++ b/old_docs/API_docs_v18/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v18/methods/messages_getDialogs.md b/old_docs/API_docs_v18/methods/messages_getDialogs.md index c388f163..afc3e956 100644 --- a/old_docs/API_docs_v18/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v18/methods/messages_getDialogs.md @@ -12,9 +12,9 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of result to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum ID of result to return| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -22,16 +22,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v18/methods/messages_getHistory.md b/old_docs/API_docs_v18/methods/messages_getHistory.md index ba497c74..d5c01235 100644 --- a/old_docs/API_docs_v18/methods/messages_getHistory.md +++ b/old_docs/API_docs_v18/methods/messages_getHistory.md @@ -13,9 +13,9 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset|[CLICK ME int](../types/int.md) | Yes|Message ID offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| +|offset|[int](../types/int.md) | Yes|Message ID offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -23,18 +23,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -77,3 +65,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v18/methods/messages_getMessages.md b/old_docs/API_docs_v18/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v18/methods/messages_getMessages.md +++ b/old_docs/API_docs_v18/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v18/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v18/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v18/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v18/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v18/methods/messages_readHistory.md b/old_docs/API_docs_v18/methods/messages_readHistory.md index 9dc802ab..ce40eef4 100644 --- a/old_docs/API_docs_v18/methods/messages_readHistory.md +++ b/old_docs/API_docs_v18/methods/messages_readHistory.md @@ -13,9 +13,9 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|read\_contents|[CLICK ME Bool](../types/Bool.md) | Yes|Mark messages as read?| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +|offset|[int](../types/int.md) | Yes|Offset| +|read\_contents|[Bool](../types/Bool.md) | Yes|Mark messages as read?| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -23,14 +23,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_AffectedHistory = messages.readHistory({peer=InputPeer, max_id=int, offset=int, read_contents=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v18/methods/messages_readMessageContents.md b/old_docs/API_docs_v18/methods/messages_readMessageContents.md index 07e43643..543f94c4 100644 --- a/old_docs/API_docs_v18/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v18/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v18/methods/messages_receivedMessages.md b/old_docs/API_docs_v18/methods/messages_receivedMessages.md index aca67286..6498fc15 100644 --- a/old_docs/API_docs_v18/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v18/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v18/methods/messages_reportSpam.md b/old_docs/API_docs_v18/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v18/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v18/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v18/methods/messages_search.md b/old_docs/API_docs_v18/methods/messages_search.md index 735ddf47..63d58b40 100644 --- a/old_docs/API_docs_v18/methods/messages_search.md +++ b/old_docs/API_docs_v18/methods/messages_search.md @@ -13,13 +13,13 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,19 +27,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -90,3 +77,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v18/methods/messages_sendBroadcast.md b/old_docs/API_docs_v18/methods/messages_sendBroadcast.md index 341c3d8c..b3a7eadf 100644 --- a/old_docs/API_docs_v18/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v18/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v18/methods/messages_sendEncrypted.md b/old_docs/API_docs_v18/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v18/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v18/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v18/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v18/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v18/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v18/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v18/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v18/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v18/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v18/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v18/methods/messages_sendMedia.md b/old_docs/API_docs_v18/methods/messages_sendMedia.md index 9a67a6f9..8235ff79 100644 --- a/old_docs/API_docs_v18/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v18/methods/messages_sendMedia.md @@ -21,34 +21,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -96,3 +68,31 @@ Or, if you're into Lua: messages_StatedMessage = messages.sendMedia({peer=InputPeer, media=InputMedia, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v18/methods/messages_sendMessage.md b/old_docs/API_docs_v18/methods/messages_sendMessage.md index ad1ec5cd..c0421494 100644 --- a/old_docs/API_docs_v18/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v18/methods/messages_sendMessage.md @@ -13,7 +13,7 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [messages\_SentMessage](../types/messages_SentMessage.md) @@ -21,33 +21,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -101,3 +74,30 @@ messages_SentMessage = messages.sendMessage({peer=InputPeer, message='string', } If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentMessage](../types/messages_SentMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v18/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v18/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v18/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v18/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v18/methods/messages_setTyping.md b/old_docs/API_docs_v18/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v18/methods/messages_setTyping.md +++ b/old_docs/API_docs_v18/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v18/methods/photos_getUserPhotos.md b/old_docs/API_docs_v18/methods/photos_getUserPhotos.md index 071a8f98..7c2f0a96 100644 --- a/old_docs/API_docs_v18/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v18/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v18/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v18/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v18/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v18/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v18/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v18/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v18/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v18/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v18/methods/users_getUsers.md b/old_docs/API_docs_v18/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v18/methods/users_getUsers.md +++ b/old_docs/API_docs_v18/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v23/methods/account_changePhone.md b/old_docs/API_docs_v23/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v23/methods/account_changePhone.md +++ b/old_docs/API_docs_v23/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v23/methods/account_checkUsername.md b/old_docs/API_docs_v23/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v23/methods/account_checkUsername.md +++ b/old_docs/API_docs_v23/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v23/methods/account_deleteAccount.md b/old_docs/API_docs_v23/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v23/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v23/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/account_getNotifySettings.md b/old_docs/API_docs_v23/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v23/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v23/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v23/methods/account_getPrivacy.md b/old_docs/API_docs_v23/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v23/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v23/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v23/methods/account_registerDevice.md b/old_docs/API_docs_v23/methods/account_registerDevice.md index 8dae7506..a69b58ff 100644 --- a/old_docs/API_docs_v23/methods/account_registerDevice.md +++ b/old_docs/API_docs_v23/methods/account_registerDevice.md @@ -12,13 +12,13 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [Bool](../types/Bool.md) @@ -26,13 +26,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -81,3 +74,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v23/methods/account_reportPeer.md b/old_docs/API_docs_v23/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v23/methods/account_reportPeer.md +++ b/old_docs/API_docs_v23/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v23/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v23/methods/account_sendChangePhoneCode.md index 930e0f76..181e817f 100644 --- a/old_docs/API_docs_v23/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v23/methods/account_sendChangePhoneCode.md @@ -12,7 +12,7 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| +|phone\_number|[string](../types/string.md) | Yes|New phone number| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) @@ -20,13 +20,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_SentChangePhoneCode = account.sendChangePhoneCode({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v23/methods/account_setAccountTTL.md b/old_docs/API_docs_v23/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v23/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v23/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v23/methods/account_setPrivacy.md b/old_docs/API_docs_v23/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v23/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v23/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v23/methods/account_unregisterDevice.md b/old_docs/API_docs_v23/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v23/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v23/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v23/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v23/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v23/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v23/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/account_updateNotifySettings.md b/old_docs/API_docs_v23/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v23/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v23/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v23/methods/account_updateProfile.md b/old_docs/API_docs_v23/methods/account_updateProfile.md index caea3391..67ceb92e 100644 --- a/old_docs/API_docs_v23/methods/account_updateProfile.md +++ b/old_docs/API_docs_v23/methods/account_updateProfile.md @@ -12,8 +12,8 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Yes|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Yes|The last name| +|first\_name|[string](../types/string.md) | Yes|The first name| +|last\_name|[string](../types/string.md) | Yes|The last name| ### Return type: [User](../types/User.md) @@ -21,14 +21,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v23/methods/account_updateStatus.md b/old_docs/API_docs_v23/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v23/methods/account_updateStatus.md +++ b/old_docs/API_docs_v23/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v23/methods/account_updateUsername.md b/old_docs/API_docs_v23/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v23/methods/account_updateUsername.md +++ b/old_docs/API_docs_v23/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v23/methods/auth_checkPhone.md b/old_docs/API_docs_v23/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v23/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v23/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v23/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v23/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v23/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v23/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v23/methods/auth_sendCall.md b/old_docs/API_docs_v23/methods/auth_sendCall.md index 5947cda7..2f56038d 100644 --- a/old_docs/API_docs_v23/methods/auth_sendCall.md +++ b/old_docs/API_docs_v23/methods/auth_sendCall.md @@ -12,8 +12,8 @@ Send verification phone call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/auth_sendInvites.md b/old_docs/API_docs_v23/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v23/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v23/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v23/methods/auth_sendSms.md b/old_docs/API_docs_v23/methods/auth_sendSms.md index 41340660..38be5985 100644 --- a/old_docs/API_docs_v23/methods/auth_sendSms.md +++ b/old_docs/API_docs_v23/methods/auth_sendSms.md @@ -12,8 +12,8 @@ Send SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code ash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/contacts_block.md b/old_docs/API_docs_v23/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v23/methods/contacts_block.md +++ b/old_docs/API_docs_v23/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v23/methods/contacts_deleteContact.md b/old_docs/API_docs_v23/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v23/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v23/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v23/methods/contacts_deleteContacts.md b/old_docs/API_docs_v23/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v23/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v23/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v23/methods/contacts_getBlocked.md b/old_docs/API_docs_v23/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v23/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v23/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v23/methods/contacts_getContacts.md b/old_docs/API_docs_v23/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v23/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v23/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v23/methods/contacts_getSuggested.md b/old_docs/API_docs_v23/methods/contacts_getSuggested.md index 1ce04bef..1dba94e1 100644 --- a/old_docs/API_docs_v23/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v23/methods/contacts_getSuggested.md @@ -12,7 +12,7 @@ Get suggested contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v23/methods/contacts_importCard.md b/old_docs/API_docs_v23/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v23/methods/contacts_importCard.md +++ b/old_docs/API_docs_v23/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v23/methods/contacts_importContacts.md b/old_docs/API_docs_v23/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v23/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v23/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v23/methods/contacts_search.md b/old_docs/API_docs_v23/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v23/methods/contacts_search.md +++ b/old_docs/API_docs_v23/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v23/methods/contacts_unblock.md b/old_docs/API_docs_v23/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v23/methods/contacts_unblock.md +++ b/old_docs/API_docs_v23/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v23/methods/help_getAppUpdate.md b/old_docs/API_docs_v23/methods/help_getAppUpdate.md index ad5b8228..ce84843d 100644 --- a/old_docs/API_docs_v23/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v23/methods/help_getAppUpdate.md @@ -12,10 +12,10 @@ Get info about app updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Langauge code| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v23/methods/help_getConfig.md b/old_docs/API_docs_v23/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v23/methods/help_getConfig.md +++ b/old_docs/API_docs_v23/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v23/methods/help_getInviteText.md b/old_docs/API_docs_v23/methods/help_getInviteText.md index ad6ac262..9b82d55d 100644 --- a/old_docs/API_docs_v23/methods/help_getInviteText.md +++ b/old_docs/API_docs_v23/methods/help_getInviteText.md @@ -12,7 +12,7 @@ Get invitation text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language| +|lang\_code|[string](../types/string.md) | Yes|Language| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v23/methods/help_saveAppLog.md b/old_docs/API_docs_v23/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v23/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v23/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/initConnection.md b/old_docs/API_docs_v23/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v23/methods/initConnection.md +++ b/old_docs/API_docs_v23/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v23/methods/invokeAfterMsg.md b/old_docs/API_docs_v23/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v23/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v23/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v23/methods/invokeAfterMsgs.md b/old_docs/API_docs_v23/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v23/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v23/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v23/methods/invokeWithLayer.md b/old_docs/API_docs_v23/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v23/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v23/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v23/methods/messages_addChatUser.md b/old_docs/API_docs_v23/methods/messages_addChatUser.md index 08b745d1..f3a5af49 100644 --- a/old_docs/API_docs_v23/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v23/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: messages_StatedMessage = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v23/methods/messages_createChat.md b/old_docs/API_docs_v23/methods/messages_createChat.md index 8a34e1fe..c35ee0e5 100644 --- a/old_docs/API_docs_v23/methods/messages_createChat.md +++ b/old_docs/API_docs_v23/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_StatedMessage = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v23/methods/messages_deleteChatUser.md b/old_docs/API_docs_v23/methods/messages_deleteChatUser.md index 8e8cf06b..57dd600a 100644 --- a/old_docs/API_docs_v23/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v23/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_StatedMessage = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v23/methods/messages_deleteHistory.md b/old_docs/API_docs_v23/methods/messages_deleteHistory.md index 77b8987e..38baaad6 100644 --- a/old_docs/API_docs_v23/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v23/methods/messages_deleteHistory.md @@ -13,7 +13,7 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|offset|[int](../types/int.md) | Yes|Offset| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -21,13 +21,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v23/methods/messages_deleteMessages.md b/old_docs/API_docs_v23/methods/messages_deleteMessages.md index fc9f6af3..d929116e 100644 --- a/old_docs/API_docs_v23/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v23/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [Vector\_of\_int](../types/int.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: Vector_of_int = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v23/methods/messages_editChatPhoto.md b/old_docs/API_docs_v23/methods/messages_editChatPhoto.md index c2958508..bf47a919 100644 --- a/old_docs/API_docs_v23/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v23/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: messages_StatedMessage = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v23/methods/messages_editChatTitle.md b/old_docs/API_docs_v23/methods/messages_editChatTitle.md index d2acc30b..fa40ece7 100644 --- a/old_docs/API_docs_v23/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v23/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StatedMessage = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v23/methods/messages_forwardMessage.md b/old_docs/API_docs_v23/methods/messages_forwardMessage.md index 295eda7a..519ee255 100644 --- a/old_docs/API_docs_v23/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v23/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_StatedMessage = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v23/methods/messages_forwardMessages.md b/old_docs/API_docs_v23/methods/messages_forwardMessages.md index f1eb9dc5..bd4e9693 100644 --- a/old_docs/API_docs_v23/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v23/methods/messages_forwardMessages.md @@ -13,7 +13,7 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_StatedMessages](../types/messages_StatedMessages.md) @@ -21,34 +21,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -96,3 +68,31 @@ Or, if you're into Lua: messages_StatedMessages = messages.forwardMessages({peer=InputPeer, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v23/methods/messages_getAllStickers.md b/old_docs/API_docs_v23/methods/messages_getAllStickers.md index 322f9b0b..3a8a66d1 100644 --- a/old_docs/API_docs_v23/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v23/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|Previously fetched stickers| +|hash|[string](../types/string.md) | Yes|Previously fetched stickers| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v23/methods/messages_getChats.md b/old_docs/API_docs_v23/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v23/methods/messages_getChats.md +++ b/old_docs/API_docs_v23/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v23/methods/messages_getDialogs.md b/old_docs/API_docs_v23/methods/messages_getDialogs.md index c388f163..afc3e956 100644 --- a/old_docs/API_docs_v23/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v23/methods/messages_getDialogs.md @@ -12,9 +12,9 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of result to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum ID of result to return| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -22,16 +22,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v23/methods/messages_getHistory.md b/old_docs/API_docs_v23/methods/messages_getHistory.md index ba497c74..d5c01235 100644 --- a/old_docs/API_docs_v23/methods/messages_getHistory.md +++ b/old_docs/API_docs_v23/methods/messages_getHistory.md @@ -13,9 +13,9 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset|[CLICK ME int](../types/int.md) | Yes|Message ID offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| +|offset|[int](../types/int.md) | Yes|Message ID offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -23,18 +23,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -77,3 +65,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v23/methods/messages_getMessages.md b/old_docs/API_docs_v23/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v23/methods/messages_getMessages.md +++ b/old_docs/API_docs_v23/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v23/methods/messages_getStickers.md b/old_docs/API_docs_v23/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v23/methods/messages_getStickers.md +++ b/old_docs/API_docs_v23/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v23/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v23/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v23/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v23/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v23/methods/messages_readHistory.md b/old_docs/API_docs_v23/methods/messages_readHistory.md index 9dc802ab..ce40eef4 100644 --- a/old_docs/API_docs_v23/methods/messages_readHistory.md +++ b/old_docs/API_docs_v23/methods/messages_readHistory.md @@ -13,9 +13,9 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|read\_contents|[CLICK ME Bool](../types/Bool.md) | Yes|Mark messages as read?| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +|offset|[int](../types/int.md) | Yes|Offset| +|read\_contents|[Bool](../types/Bool.md) | Yes|Mark messages as read?| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -23,14 +23,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_AffectedHistory = messages.readHistory({peer=InputPeer, max_id=int, offset=int, read_contents=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v23/methods/messages_readMessageContents.md b/old_docs/API_docs_v23/methods/messages_readMessageContents.md index 07e43643..543f94c4 100644 --- a/old_docs/API_docs_v23/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v23/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v23/methods/messages_receivedMessages.md b/old_docs/API_docs_v23/methods/messages_receivedMessages.md index aca67286..6498fc15 100644 --- a/old_docs/API_docs_v23/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v23/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v23/methods/messages_reportSpam.md b/old_docs/API_docs_v23/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v23/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v23/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v23/methods/messages_search.md b/old_docs/API_docs_v23/methods/messages_search.md index 735ddf47..63d58b40 100644 --- a/old_docs/API_docs_v23/methods/messages_search.md +++ b/old_docs/API_docs_v23/methods/messages_search.md @@ -13,13 +13,13 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,19 +27,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -90,3 +77,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v23/methods/messages_sendBroadcast.md b/old_docs/API_docs_v23/methods/messages_sendBroadcast.md index 341c3d8c..b3a7eadf 100644 --- a/old_docs/API_docs_v23/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v23/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v23/methods/messages_sendEncrypted.md b/old_docs/API_docs_v23/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v23/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v23/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v23/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v23/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v23/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v23/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v23/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v23/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v23/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v23/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v23/methods/messages_sendMedia.md b/old_docs/API_docs_v23/methods/messages_sendMedia.md index 9a67a6f9..8235ff79 100644 --- a/old_docs/API_docs_v23/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v23/methods/messages_sendMedia.md @@ -21,34 +21,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -96,3 +68,31 @@ Or, if you're into Lua: messages_StatedMessage = messages.sendMedia({peer=InputPeer, media=InputMedia, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v23/methods/messages_sendMessage.md b/old_docs/API_docs_v23/methods/messages_sendMessage.md index ad1ec5cd..c0421494 100644 --- a/old_docs/API_docs_v23/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v23/methods/messages_sendMessage.md @@ -13,7 +13,7 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [messages\_SentMessage](../types/messages_SentMessage.md) @@ -21,33 +21,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -101,3 +74,30 @@ messages_SentMessage = messages.sendMessage({peer=InputPeer, message='string', } If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentMessage](../types/messages_SentMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v23/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v23/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v23/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v23/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v23/methods/messages_setTyping.md b/old_docs/API_docs_v23/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v23/methods/messages_setTyping.md +++ b/old_docs/API_docs_v23/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v23/methods/photos_getUserPhotos.md b/old_docs/API_docs_v23/methods/photos_getUserPhotos.md index 071a8f98..7c2f0a96 100644 --- a/old_docs/API_docs_v23/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v23/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v23/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v23/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v23/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v23/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v23/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v23/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v23/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v23/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v23/methods/users_getUsers.md b/old_docs/API_docs_v23/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v23/methods/users_getUsers.md +++ b/old_docs/API_docs_v23/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v25/methods/account_changePhone.md b/old_docs/API_docs_v25/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v25/methods/account_changePhone.md +++ b/old_docs/API_docs_v25/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v25/methods/account_checkUsername.md b/old_docs/API_docs_v25/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v25/methods/account_checkUsername.md +++ b/old_docs/API_docs_v25/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v25/methods/account_deleteAccount.md b/old_docs/API_docs_v25/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v25/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v25/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/account_getNotifySettings.md b/old_docs/API_docs_v25/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v25/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v25/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v25/methods/account_getPrivacy.md b/old_docs/API_docs_v25/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v25/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v25/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v25/methods/account_registerDevice.md b/old_docs/API_docs_v25/methods/account_registerDevice.md index 8dae7506..a69b58ff 100644 --- a/old_docs/API_docs_v25/methods/account_registerDevice.md +++ b/old_docs/API_docs_v25/methods/account_registerDevice.md @@ -12,13 +12,13 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [Bool](../types/Bool.md) @@ -26,13 +26,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -81,3 +74,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v25/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v25/methods/account_sendChangePhoneCode.md index 930e0f76..181e817f 100644 --- a/old_docs/API_docs_v25/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v25/methods/account_sendChangePhoneCode.md @@ -12,7 +12,7 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| +|phone\_number|[string](../types/string.md) | Yes|New phone number| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) @@ -20,13 +20,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_SentChangePhoneCode = account.sendChangePhoneCode({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v25/methods/account_setAccountTTL.md b/old_docs/API_docs_v25/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v25/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v25/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v25/methods/account_setPassword.md b/old_docs/API_docs_v25/methods/account_setPassword.md index 1848d875..aa79a2c1 100644 --- a/old_docs/API_docs_v25/methods/account_setPassword.md +++ b/old_docs/API_docs_v25/methods/account_setPassword.md @@ -12,10 +12,10 @@ Set 2FA password | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_salt|[CLICK ME bytes](../types/bytes.md) | Yes|New salt| -|new\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $new_salt.$new_password.$new_salt, true)`| -|hint|[CLICK ME string](../types/string.md) | Yes|Hint| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_salt|[bytes](../types/bytes.md) | Yes|New salt| +|new\_password\_hash|[bytes](../types/bytes.md) | Yes|`hash('sha256', $new_salt.$new_password.$new_salt, true)`| +|hint|[string](../types/string.md) | Yes|Hint| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/account_setPrivacy.md b/old_docs/API_docs_v25/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v25/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v25/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v25/methods/account_unregisterDevice.md b/old_docs/API_docs_v25/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v25/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v25/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v25/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v25/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v25/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v25/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/account_updateNotifySettings.md b/old_docs/API_docs_v25/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v25/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v25/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v25/methods/account_updateProfile.md b/old_docs/API_docs_v25/methods/account_updateProfile.md index caea3391..67ceb92e 100644 --- a/old_docs/API_docs_v25/methods/account_updateProfile.md +++ b/old_docs/API_docs_v25/methods/account_updateProfile.md @@ -12,8 +12,8 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Yes|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Yes|The last name| +|first\_name|[string](../types/string.md) | Yes|The first name| +|last\_name|[string](../types/string.md) | Yes|The last name| ### Return type: [User](../types/User.md) @@ -21,14 +21,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v25/methods/account_updateStatus.md b/old_docs/API_docs_v25/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v25/methods/account_updateStatus.md +++ b/old_docs/API_docs_v25/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v25/methods/account_updateUsername.md b/old_docs/API_docs_v25/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v25/methods/account_updateUsername.md +++ b/old_docs/API_docs_v25/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v25/methods/auth_checkPhone.md b/old_docs/API_docs_v25/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v25/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v25/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v25/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v25/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v25/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v25/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v25/methods/auth_sendCall.md b/old_docs/API_docs_v25/methods/auth_sendCall.md index 5947cda7..2f56038d 100644 --- a/old_docs/API_docs_v25/methods/auth_sendCall.md +++ b/old_docs/API_docs_v25/methods/auth_sendCall.md @@ -12,8 +12,8 @@ Send verification phone call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/auth_sendInvites.md b/old_docs/API_docs_v25/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v25/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v25/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v25/methods/auth_sendSms.md b/old_docs/API_docs_v25/methods/auth_sendSms.md index 41340660..38be5985 100644 --- a/old_docs/API_docs_v25/methods/auth_sendSms.md +++ b/old_docs/API_docs_v25/methods/auth_sendSms.md @@ -12,8 +12,8 @@ Send SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code ash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/contacts_block.md b/old_docs/API_docs_v25/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v25/methods/contacts_block.md +++ b/old_docs/API_docs_v25/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v25/methods/contacts_deleteContact.md b/old_docs/API_docs_v25/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v25/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v25/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v25/methods/contacts_deleteContacts.md b/old_docs/API_docs_v25/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v25/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v25/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v25/methods/contacts_getBlocked.md b/old_docs/API_docs_v25/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v25/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v25/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v25/methods/contacts_getContacts.md b/old_docs/API_docs_v25/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v25/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v25/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v25/methods/contacts_getSuggested.md b/old_docs/API_docs_v25/methods/contacts_getSuggested.md index 1ce04bef..1dba94e1 100644 --- a/old_docs/API_docs_v25/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v25/methods/contacts_getSuggested.md @@ -12,7 +12,7 @@ Get suggested contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v25/methods/contacts_importCard.md b/old_docs/API_docs_v25/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v25/methods/contacts_importCard.md +++ b/old_docs/API_docs_v25/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v25/methods/contacts_importContacts.md b/old_docs/API_docs_v25/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v25/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v25/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v25/methods/contacts_search.md b/old_docs/API_docs_v25/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v25/methods/contacts_search.md +++ b/old_docs/API_docs_v25/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v25/methods/contacts_unblock.md b/old_docs/API_docs_v25/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v25/methods/contacts_unblock.md +++ b/old_docs/API_docs_v25/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v25/methods/geochats_checkin.md b/old_docs/API_docs_v25/methods/geochats_checkin.md index 829f8e85..5b795614 100644 --- a/old_docs/API_docs_v25/methods/geochats_checkin.md +++ b/old_docs/API_docs_v25/methods/geochats_checkin.md @@ -12,7 +12,7 @@ Join a geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/geochats_createGeoChat.md b/old_docs/API_docs_v25/methods/geochats_createGeoChat.md index 6881f300..35a3b081 100644 --- a/old_docs/API_docs_v25/methods/geochats_createGeoChat.md +++ b/old_docs/API_docs_v25/methods/geochats_createGeoChat.md @@ -12,10 +12,10 @@ Create geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|title|[CLICK ME string](../types/string.md) | Yes|Geochat title| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geochat location| -|address|[CLICK ME string](../types/string.md) | Yes|Geochat address| -|venue|[CLICK ME string](../types/string.md) | Yes|Geochat venue | +|title|[string](../types/string.md) | Yes|Geochat title| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geochat location| +|address|[string](../types/string.md) | Yes|Geochat address| +|venue|[string](../types/string.md) | Yes|Geochat venue | ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/geochats_editChatPhoto.md b/old_docs/API_docs_v25/methods/geochats_editChatPhoto.md index 9d975f3f..57876bef 100644 --- a/old_docs/API_docs_v25/methods/geochats_editChatPhoto.md +++ b/old_docs/API_docs_v25/methods/geochats_editChatPhoto.md @@ -12,8 +12,8 @@ Edit geochat photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/geochats_editChatTitle.md b/old_docs/API_docs_v25/methods/geochats_editChatTitle.md index fe43e476..9e7a7bfc 100644 --- a/old_docs/API_docs_v25/methods/geochats_editChatTitle.md +++ b/old_docs/API_docs_v25/methods/geochats_editChatTitle.md @@ -12,9 +12,9 @@ Edit geochat title | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| -|address|[CLICK ME string](../types/string.md) | Yes|The new address| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|title|[string](../types/string.md) | Yes|The new title| +|address|[string](../types/string.md) | Yes|The new address| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/geochats_getFullChat.md b/old_docs/API_docs_v25/methods/geochats_getFullChat.md index 0ca442e0..a5c4bc9a 100644 --- a/old_docs/API_docs_v25/methods/geochats_getFullChat.md +++ b/old_docs/API_docs_v25/methods/geochats_getFullChat.md @@ -12,7 +12,7 @@ Get full info about a geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| ### Return type: [messages\_ChatFull](../types/messages_ChatFull.md) diff --git a/old_docs/API_docs_v25/methods/geochats_getHistory.md b/old_docs/API_docs_v25/methods/geochats_getHistory.md index e2727fda..6b47dd7a 100644 --- a/old_docs/API_docs_v25/methods/geochats_getHistory.md +++ b/old_docs/API_docs_v25/methods/geochats_getHistory.md @@ -12,10 +12,10 @@ Get geochat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v25/methods/geochats_getLocated.md b/old_docs/API_docs_v25/methods/geochats_getLocated.md index 9bcb9a66..63c6b0a7 100644 --- a/old_docs/API_docs_v25/methods/geochats_getLocated.md +++ b/old_docs/API_docs_v25/methods/geochats_getLocated.md @@ -12,9 +12,9 @@ Get nearby geochats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Current location| -|radius|[CLICK ME int](../types/int.md) | Yes|Radius| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Current location| +|radius|[int](../types/int.md) | Yes|Radius| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [geochats\_Located](../types/geochats_Located.md) diff --git a/old_docs/API_docs_v25/methods/geochats_getRecents.md b/old_docs/API_docs_v25/methods/geochats_getRecents.md index 6cd93cb6..0adff14f 100644 --- a/old_docs/API_docs_v25/methods/geochats_getRecents.md +++ b/old_docs/API_docs_v25/methods/geochats_getRecents.md @@ -12,8 +12,8 @@ Get recent geochats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|offset|[int](../types/int.md) | Yes|offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v25/methods/geochats_search.md b/old_docs/API_docs_v25/methods/geochats_search.md index 7bb91137..97853473 100644 --- a/old_docs/API_docs_v25/methods/geochats_search.md +++ b/old_docs/API_docs_v25/methods/geochats_search.md @@ -12,14 +12,14 @@ Search messages in geocha | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Search filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|q|[string](../types/string.md) | Yes|The search query| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Search filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date| +|max\_date|[int](../types/int.md) | Yes|Maximum date| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v25/methods/geochats_sendMedia.md b/old_docs/API_docs_v25/methods/geochats_sendMedia.md index cd50d19d..a018422d 100644 --- a/old_docs/API_docs_v25/methods/geochats_sendMedia.md +++ b/old_docs/API_docs_v25/methods/geochats_sendMedia.md @@ -12,7 +12,7 @@ Send media to geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v25/methods/geochats_sendMessage.md b/old_docs/API_docs_v25/methods/geochats_sendMessage.md index 23607283..b8fc2f9e 100644 --- a/old_docs/API_docs_v25/methods/geochats_sendMessage.md +++ b/old_docs/API_docs_v25/methods/geochats_sendMessage.md @@ -12,8 +12,8 @@ Send message to geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|message|[string](../types/string.md) | Yes|The message| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/geochats_setTyping.md b/old_docs/API_docs_v25/methods/geochats_setTyping.md index 1eb07800..9088ab4e 100644 --- a/old_docs/API_docs_v25/methods/geochats_setTyping.md +++ b/old_docs/API_docs_v25/methods/geochats_setTyping.md @@ -12,8 +12,8 @@ Send typing notification to geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Typing or not typing| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|typing|[Bool](../types/Bool.md) | Yes|Typing or not typing| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/help_getAppUpdate.md b/old_docs/API_docs_v25/methods/help_getAppUpdate.md index ad5b8228..ce84843d 100644 --- a/old_docs/API_docs_v25/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v25/methods/help_getAppUpdate.md @@ -12,10 +12,10 @@ Get info about app updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Langauge code| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v25/methods/help_getConfig.md b/old_docs/API_docs_v25/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v25/methods/help_getConfig.md +++ b/old_docs/API_docs_v25/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v25/methods/help_getInviteText.md b/old_docs/API_docs_v25/methods/help_getInviteText.md index ad6ac262..9b82d55d 100644 --- a/old_docs/API_docs_v25/methods/help_getInviteText.md +++ b/old_docs/API_docs_v25/methods/help_getInviteText.md @@ -12,7 +12,7 @@ Get invitation text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language| +|lang\_code|[string](../types/string.md) | Yes|Language| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v25/methods/help_saveAppLog.md b/old_docs/API_docs_v25/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v25/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v25/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/initConnection.md b/old_docs/API_docs_v25/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v25/methods/initConnection.md +++ b/old_docs/API_docs_v25/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v25/methods/invokeAfterMsg.md b/old_docs/API_docs_v25/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v25/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v25/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v25/methods/invokeAfterMsgs.md b/old_docs/API_docs_v25/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v25/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v25/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v25/methods/invokeWithLayer.md b/old_docs/API_docs_v25/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v25/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v25/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v25/methods/messages_addChatUser.md b/old_docs/API_docs_v25/methods/messages_addChatUser.md index 08b745d1..f3a5af49 100644 --- a/old_docs/API_docs_v25/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v25/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: messages_StatedMessage = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v25/methods/messages_createChat.md b/old_docs/API_docs_v25/methods/messages_createChat.md index 8a34e1fe..c35ee0e5 100644 --- a/old_docs/API_docs_v25/methods/messages_createChat.md +++ b/old_docs/API_docs_v25/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_StatedMessage = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v25/methods/messages_deleteChatUser.md b/old_docs/API_docs_v25/methods/messages_deleteChatUser.md index 8e8cf06b..57dd600a 100644 --- a/old_docs/API_docs_v25/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v25/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_StatedMessage = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v25/methods/messages_deleteHistory.md b/old_docs/API_docs_v25/methods/messages_deleteHistory.md index 77b8987e..38baaad6 100644 --- a/old_docs/API_docs_v25/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v25/methods/messages_deleteHistory.md @@ -13,7 +13,7 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|offset|[int](../types/int.md) | Yes|Offset| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -21,13 +21,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v25/methods/messages_deleteMessages.md b/old_docs/API_docs_v25/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v25/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v25/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v25/methods/messages_editChatPhoto.md b/old_docs/API_docs_v25/methods/messages_editChatPhoto.md index c2958508..bf47a919 100644 --- a/old_docs/API_docs_v25/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v25/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: messages_StatedMessage = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v25/methods/messages_editChatTitle.md b/old_docs/API_docs_v25/methods/messages_editChatTitle.md index d2acc30b..fa40ece7 100644 --- a/old_docs/API_docs_v25/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v25/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StatedMessage = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v25/methods/messages_forwardMessage.md b/old_docs/API_docs_v25/methods/messages_forwardMessage.md index 295eda7a..519ee255 100644 --- a/old_docs/API_docs_v25/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v25/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_StatedMessage = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v25/methods/messages_forwardMessages.md b/old_docs/API_docs_v25/methods/messages_forwardMessages.md index f1eb9dc5..bd4e9693 100644 --- a/old_docs/API_docs_v25/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v25/methods/messages_forwardMessages.md @@ -13,7 +13,7 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_StatedMessages](../types/messages_StatedMessages.md) @@ -21,34 +21,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -96,3 +68,31 @@ Or, if you're into Lua: messages_StatedMessages = messages.forwardMessages({peer=InputPeer, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v25/methods/messages_getAllStickers.md b/old_docs/API_docs_v25/methods/messages_getAllStickers.md index 322f9b0b..3a8a66d1 100644 --- a/old_docs/API_docs_v25/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v25/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|Previously fetched stickers| +|hash|[string](../types/string.md) | Yes|Previously fetched stickers| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v25/methods/messages_getChats.md b/old_docs/API_docs_v25/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v25/methods/messages_getChats.md +++ b/old_docs/API_docs_v25/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v25/methods/messages_getDialogs.md b/old_docs/API_docs_v25/methods/messages_getDialogs.md index c388f163..afc3e956 100644 --- a/old_docs/API_docs_v25/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v25/methods/messages_getDialogs.md @@ -12,9 +12,9 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of result to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum ID of result to return| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -22,16 +22,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v25/methods/messages_getHistory.md b/old_docs/API_docs_v25/methods/messages_getHistory.md index ba497c74..d5c01235 100644 --- a/old_docs/API_docs_v25/methods/messages_getHistory.md +++ b/old_docs/API_docs_v25/methods/messages_getHistory.md @@ -13,9 +13,9 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset|[CLICK ME int](../types/int.md) | Yes|Message ID offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| +|offset|[int](../types/int.md) | Yes|Message ID offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -23,18 +23,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -77,3 +65,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v25/methods/messages_getMessages.md b/old_docs/API_docs_v25/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v25/methods/messages_getMessages.md +++ b/old_docs/API_docs_v25/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v25/methods/messages_getStickers.md b/old_docs/API_docs_v25/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v25/methods/messages_getStickers.md +++ b/old_docs/API_docs_v25/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v25/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v25/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v25/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v25/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v25/methods/messages_readHistory.md b/old_docs/API_docs_v25/methods/messages_readHistory.md index 7d5d7e35..6898f9ec 100644 --- a/old_docs/API_docs_v25/methods/messages_readHistory.md +++ b/old_docs/API_docs_v25/methods/messages_readHistory.md @@ -13,8 +13,8 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +|offset|[int](../types/int.md) | Yes|Offset| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,14 +22,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: messages_AffectedHistory = messages.readHistory({peer=InputPeer, max_id=int, offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v25/methods/messages_readMessageContents.md b/old_docs/API_docs_v25/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v25/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v25/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v25/methods/messages_receivedMessages.md b/old_docs/API_docs_v25/methods/messages_receivedMessages.md index aca67286..6498fc15 100644 --- a/old_docs/API_docs_v25/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v25/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v25/methods/messages_search.md b/old_docs/API_docs_v25/methods/messages_search.md index 735ddf47..63d58b40 100644 --- a/old_docs/API_docs_v25/methods/messages_search.md +++ b/old_docs/API_docs_v25/methods/messages_search.md @@ -13,13 +13,13 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,19 +27,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -90,3 +77,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v25/methods/messages_sendBroadcast.md b/old_docs/API_docs_v25/methods/messages_sendBroadcast.md index 341c3d8c..b3a7eadf 100644 --- a/old_docs/API_docs_v25/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v25/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v25/methods/messages_sendEncrypted.md b/old_docs/API_docs_v25/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v25/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v25/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v25/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v25/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v25/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v25/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v25/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v25/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v25/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v25/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v25/methods/messages_sendMedia.md b/old_docs/API_docs_v25/methods/messages_sendMedia.md index 933c00de..4462a5e8 100644 --- a/old_docs/API_docs_v25/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v25/methods/messages_sendMedia.md @@ -13,7 +13,7 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| @@ -22,34 +22,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -99,3 +71,31 @@ Or, if you're into Lua: messages_StatedMessage = messages.sendMedia({peer=InputPeer, reply_to_msg_id=int, media=InputMedia, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v25/methods/messages_sendMessage.md b/old_docs/API_docs_v25/methods/messages_sendMessage.md index c753aecb..262408bc 100644 --- a/old_docs/API_docs_v25/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v25/methods/messages_sendMessage.md @@ -13,8 +13,8 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [messages\_SentMessage](../types/messages_SentMessage.md) @@ -22,33 +22,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -104,3 +77,30 @@ messages_SentMessage = messages.sendMessage({peer=InputPeer, reply_to_msg_id=int If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentMessage](../types/messages_SentMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v25/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v25/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v25/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v25/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v25/methods/messages_setTyping.md b/old_docs/API_docs_v25/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v25/methods/messages_setTyping.md +++ b/old_docs/API_docs_v25/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v25/methods/photos_getUserPhotos.md b/old_docs/API_docs_v25/methods/photos_getUserPhotos.md index 071a8f98..7c2f0a96 100644 --- a/old_docs/API_docs_v25/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v25/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v25/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v25/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v25/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v25/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v25/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v25/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v25/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v25/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v25/methods/users_getUsers.md b/old_docs/API_docs_v25/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v25/methods/users_getUsers.md +++ b/old_docs/API_docs_v25/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v27/methods/account_changePhone.md b/old_docs/API_docs_v27/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v27/methods/account_changePhone.md +++ b/old_docs/API_docs_v27/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v27/methods/account_checkUsername.md b/old_docs/API_docs_v27/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v27/methods/account_checkUsername.md +++ b/old_docs/API_docs_v27/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v27/methods/account_deleteAccount.md b/old_docs/API_docs_v27/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v27/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v27/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/account_getNotifySettings.md b/old_docs/API_docs_v27/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v27/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v27/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v27/methods/account_getPasswordSettings.md b/old_docs/API_docs_v27/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v27/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v27/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v27/methods/account_getPrivacy.md b/old_docs/API_docs_v27/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v27/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v27/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v27/methods/account_registerDevice.md b/old_docs/API_docs_v27/methods/account_registerDevice.md index 8dae7506..a69b58ff 100644 --- a/old_docs/API_docs_v27/methods/account_registerDevice.md +++ b/old_docs/API_docs_v27/methods/account_registerDevice.md @@ -12,13 +12,13 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [Bool](../types/Bool.md) @@ -26,13 +26,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -81,3 +74,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v27/methods/account_resetAuthorization.md b/old_docs/API_docs_v27/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v27/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v27/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v27/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v27/methods/account_sendChangePhoneCode.md index 930e0f76..181e817f 100644 --- a/old_docs/API_docs_v27/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v27/methods/account_sendChangePhoneCode.md @@ -12,7 +12,7 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| +|phone\_number|[string](../types/string.md) | Yes|New phone number| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) @@ -20,13 +20,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_SentChangePhoneCode = account.sendChangePhoneCode({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v27/methods/account_setAccountTTL.md b/old_docs/API_docs_v27/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v27/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v27/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v27/methods/account_setPrivacy.md b/old_docs/API_docs_v27/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v27/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v27/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v27/methods/account_unregisterDevice.md b/old_docs/API_docs_v27/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v27/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v27/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v27/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v27/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v27/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v27/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/account_updateNotifySettings.md b/old_docs/API_docs_v27/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v27/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v27/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v27/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v27/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v27/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v27/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v27/methods/account_updateProfile.md b/old_docs/API_docs_v27/methods/account_updateProfile.md index caea3391..67ceb92e 100644 --- a/old_docs/API_docs_v27/methods/account_updateProfile.md +++ b/old_docs/API_docs_v27/methods/account_updateProfile.md @@ -12,8 +12,8 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Yes|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Yes|The last name| +|first\_name|[string](../types/string.md) | Yes|The first name| +|last\_name|[string](../types/string.md) | Yes|The last name| ### Return type: [User](../types/User.md) @@ -21,14 +21,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v27/methods/account_updateStatus.md b/old_docs/API_docs_v27/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v27/methods/account_updateStatus.md +++ b/old_docs/API_docs_v27/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v27/methods/account_updateUsername.md b/old_docs/API_docs_v27/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v27/methods/account_updateUsername.md +++ b/old_docs/API_docs_v27/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v27/methods/auth_checkPhone.md b/old_docs/API_docs_v27/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v27/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v27/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v27/methods/auth_recoverPassword.md b/old_docs/API_docs_v27/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v27/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v27/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v27/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v27/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v27/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v27/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v27/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v27/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v27/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v27/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v27/methods/auth_sendCall.md b/old_docs/API_docs_v27/methods/auth_sendCall.md index 5947cda7..2f56038d 100644 --- a/old_docs/API_docs_v27/methods/auth_sendCall.md +++ b/old_docs/API_docs_v27/methods/auth_sendCall.md @@ -12,8 +12,8 @@ Send verification phone call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/auth_sendInvites.md b/old_docs/API_docs_v27/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v27/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v27/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v27/methods/auth_sendSms.md b/old_docs/API_docs_v27/methods/auth_sendSms.md index 41340660..38be5985 100644 --- a/old_docs/API_docs_v27/methods/auth_sendSms.md +++ b/old_docs/API_docs_v27/methods/auth_sendSms.md @@ -12,8 +12,8 @@ Send SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code ash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/contacts_block.md b/old_docs/API_docs_v27/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v27/methods/contacts_block.md +++ b/old_docs/API_docs_v27/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v27/methods/contacts_deleteContact.md b/old_docs/API_docs_v27/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v27/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v27/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v27/methods/contacts_deleteContacts.md b/old_docs/API_docs_v27/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v27/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v27/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v27/methods/contacts_getBlocked.md b/old_docs/API_docs_v27/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v27/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v27/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v27/methods/contacts_getContacts.md b/old_docs/API_docs_v27/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v27/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v27/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v27/methods/contacts_getSuggested.md b/old_docs/API_docs_v27/methods/contacts_getSuggested.md index 1ce04bef..1dba94e1 100644 --- a/old_docs/API_docs_v27/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v27/methods/contacts_getSuggested.md @@ -12,7 +12,7 @@ Get suggested contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v27/methods/contacts_importCard.md b/old_docs/API_docs_v27/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v27/methods/contacts_importCard.md +++ b/old_docs/API_docs_v27/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v27/methods/contacts_importContacts.md b/old_docs/API_docs_v27/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v27/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v27/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v27/methods/contacts_search.md b/old_docs/API_docs_v27/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v27/methods/contacts_search.md +++ b/old_docs/API_docs_v27/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v27/methods/contacts_unblock.md b/old_docs/API_docs_v27/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v27/methods/contacts_unblock.md +++ b/old_docs/API_docs_v27/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v27/methods/geochats_checkin.md b/old_docs/API_docs_v27/methods/geochats_checkin.md index 829f8e85..5b795614 100644 --- a/old_docs/API_docs_v27/methods/geochats_checkin.md +++ b/old_docs/API_docs_v27/methods/geochats_checkin.md @@ -12,7 +12,7 @@ Join a geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v27/methods/geochats_createGeoChat.md b/old_docs/API_docs_v27/methods/geochats_createGeoChat.md index 6881f300..35a3b081 100644 --- a/old_docs/API_docs_v27/methods/geochats_createGeoChat.md +++ b/old_docs/API_docs_v27/methods/geochats_createGeoChat.md @@ -12,10 +12,10 @@ Create geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|title|[CLICK ME string](../types/string.md) | Yes|Geochat title| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geochat location| -|address|[CLICK ME string](../types/string.md) | Yes|Geochat address| -|venue|[CLICK ME string](../types/string.md) | Yes|Geochat venue | +|title|[string](../types/string.md) | Yes|Geochat title| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geochat location| +|address|[string](../types/string.md) | Yes|Geochat address| +|venue|[string](../types/string.md) | Yes|Geochat venue | ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v27/methods/geochats_editChatPhoto.md b/old_docs/API_docs_v27/methods/geochats_editChatPhoto.md index 9d975f3f..57876bef 100644 --- a/old_docs/API_docs_v27/methods/geochats_editChatPhoto.md +++ b/old_docs/API_docs_v27/methods/geochats_editChatPhoto.md @@ -12,8 +12,8 @@ Edit geochat photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v27/methods/geochats_editChatTitle.md b/old_docs/API_docs_v27/methods/geochats_editChatTitle.md index fe43e476..9e7a7bfc 100644 --- a/old_docs/API_docs_v27/methods/geochats_editChatTitle.md +++ b/old_docs/API_docs_v27/methods/geochats_editChatTitle.md @@ -12,9 +12,9 @@ Edit geochat title | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| -|address|[CLICK ME string](../types/string.md) | Yes|The new address| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|title|[string](../types/string.md) | Yes|The new title| +|address|[string](../types/string.md) | Yes|The new address| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v27/methods/geochats_getFullChat.md b/old_docs/API_docs_v27/methods/geochats_getFullChat.md index 0ca442e0..a5c4bc9a 100644 --- a/old_docs/API_docs_v27/methods/geochats_getFullChat.md +++ b/old_docs/API_docs_v27/methods/geochats_getFullChat.md @@ -12,7 +12,7 @@ Get full info about a geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| ### Return type: [messages\_ChatFull](../types/messages_ChatFull.md) diff --git a/old_docs/API_docs_v27/methods/geochats_getHistory.md b/old_docs/API_docs_v27/methods/geochats_getHistory.md index e2727fda..6b47dd7a 100644 --- a/old_docs/API_docs_v27/methods/geochats_getHistory.md +++ b/old_docs/API_docs_v27/methods/geochats_getHistory.md @@ -12,10 +12,10 @@ Get geochat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v27/methods/geochats_getLocated.md b/old_docs/API_docs_v27/methods/geochats_getLocated.md index 9bcb9a66..63c6b0a7 100644 --- a/old_docs/API_docs_v27/methods/geochats_getLocated.md +++ b/old_docs/API_docs_v27/methods/geochats_getLocated.md @@ -12,9 +12,9 @@ Get nearby geochats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Current location| -|radius|[CLICK ME int](../types/int.md) | Yes|Radius| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Current location| +|radius|[int](../types/int.md) | Yes|Radius| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [geochats\_Located](../types/geochats_Located.md) diff --git a/old_docs/API_docs_v27/methods/geochats_getRecents.md b/old_docs/API_docs_v27/methods/geochats_getRecents.md index 6cd93cb6..0adff14f 100644 --- a/old_docs/API_docs_v27/methods/geochats_getRecents.md +++ b/old_docs/API_docs_v27/methods/geochats_getRecents.md @@ -12,8 +12,8 @@ Get recent geochats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|offset|[int](../types/int.md) | Yes|offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v27/methods/geochats_search.md b/old_docs/API_docs_v27/methods/geochats_search.md index 7bb91137..97853473 100644 --- a/old_docs/API_docs_v27/methods/geochats_search.md +++ b/old_docs/API_docs_v27/methods/geochats_search.md @@ -12,14 +12,14 @@ Search messages in geocha | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Search filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|q|[string](../types/string.md) | Yes|The search query| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Search filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date| +|max\_date|[int](../types/int.md) | Yes|Maximum date| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v27/methods/geochats_sendMedia.md b/old_docs/API_docs_v27/methods/geochats_sendMedia.md index cd50d19d..a018422d 100644 --- a/old_docs/API_docs_v27/methods/geochats_sendMedia.md +++ b/old_docs/API_docs_v27/methods/geochats_sendMedia.md @@ -12,7 +12,7 @@ Send media to geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v27/methods/geochats_sendMessage.md b/old_docs/API_docs_v27/methods/geochats_sendMessage.md index 23607283..b8fc2f9e 100644 --- a/old_docs/API_docs_v27/methods/geochats_sendMessage.md +++ b/old_docs/API_docs_v27/methods/geochats_sendMessage.md @@ -12,8 +12,8 @@ Send message to geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|message|[string](../types/string.md) | Yes|The message| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v27/methods/geochats_setTyping.md b/old_docs/API_docs_v27/methods/geochats_setTyping.md index 1eb07800..9088ab4e 100644 --- a/old_docs/API_docs_v27/methods/geochats_setTyping.md +++ b/old_docs/API_docs_v27/methods/geochats_setTyping.md @@ -12,8 +12,8 @@ Send typing notification to geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Typing or not typing| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|typing|[Bool](../types/Bool.md) | Yes|Typing or not typing| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/help_getAppUpdate.md b/old_docs/API_docs_v27/methods/help_getAppUpdate.md index ad5b8228..ce84843d 100644 --- a/old_docs/API_docs_v27/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v27/methods/help_getAppUpdate.md @@ -12,10 +12,10 @@ Get info about app updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Langauge code| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v27/methods/help_getConfig.md b/old_docs/API_docs_v27/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v27/methods/help_getConfig.md +++ b/old_docs/API_docs_v27/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v27/methods/help_getInviteText.md b/old_docs/API_docs_v27/methods/help_getInviteText.md index ad6ac262..9b82d55d 100644 --- a/old_docs/API_docs_v27/methods/help_getInviteText.md +++ b/old_docs/API_docs_v27/methods/help_getInviteText.md @@ -12,7 +12,7 @@ Get invitation text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language| +|lang\_code|[string](../types/string.md) | Yes|Language| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v27/methods/help_saveAppLog.md b/old_docs/API_docs_v27/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v27/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v27/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/initConnection.md b/old_docs/API_docs_v27/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v27/methods/initConnection.md +++ b/old_docs/API_docs_v27/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v27/methods/invokeAfterMsg.md b/old_docs/API_docs_v27/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v27/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v27/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v27/methods/invokeAfterMsgs.md b/old_docs/API_docs_v27/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v27/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v27/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v27/methods/invokeWithLayer.md b/old_docs/API_docs_v27/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v27/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v27/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v27/methods/messages_addChatUser.md b/old_docs/API_docs_v27/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v27/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v27/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v27/methods/messages_createChat.md b/old_docs/API_docs_v27/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v27/methods/messages_createChat.md +++ b/old_docs/API_docs_v27/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v27/methods/messages_deleteChatUser.md b/old_docs/API_docs_v27/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v27/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v27/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v27/methods/messages_deleteHistory.md b/old_docs/API_docs_v27/methods/messages_deleteHistory.md index 77b8987e..38baaad6 100644 --- a/old_docs/API_docs_v27/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v27/methods/messages_deleteHistory.md @@ -13,7 +13,7 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|offset|[int](../types/int.md) | Yes|Offset| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -21,13 +21,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v27/methods/messages_deleteMessages.md b/old_docs/API_docs_v27/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v27/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v27/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v27/methods/messages_editChatPhoto.md b/old_docs/API_docs_v27/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v27/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v27/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v27/methods/messages_editChatTitle.md b/old_docs/API_docs_v27/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v27/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v27/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v27/methods/messages_forwardMessage.md b/old_docs/API_docs_v27/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v27/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v27/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v27/methods/messages_forwardMessages.md b/old_docs/API_docs_v27/methods/messages_forwardMessages.md index cecf057b..91a15758 100644 --- a/old_docs/API_docs_v27/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v27/methods/messages_forwardMessages.md @@ -13,7 +13,7 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [Updates](../types/Updates.md) @@ -21,34 +21,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -96,3 +68,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({peer=InputPeer, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v27/methods/messages_getAllStickers.md b/old_docs/API_docs_v27/methods/messages_getAllStickers.md index 322f9b0b..3a8a66d1 100644 --- a/old_docs/API_docs_v27/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v27/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|Previously fetched stickers| +|hash|[string](../types/string.md) | Yes|Previously fetched stickers| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v27/methods/messages_getChats.md b/old_docs/API_docs_v27/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v27/methods/messages_getChats.md +++ b/old_docs/API_docs_v27/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v27/methods/messages_getDialogs.md b/old_docs/API_docs_v27/methods/messages_getDialogs.md index c388f163..afc3e956 100644 --- a/old_docs/API_docs_v27/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v27/methods/messages_getDialogs.md @@ -12,9 +12,9 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of result to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum ID of result to return| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -22,16 +22,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v27/methods/messages_getHistory.md b/old_docs/API_docs_v27/methods/messages_getHistory.md index ba497c74..d5c01235 100644 --- a/old_docs/API_docs_v27/methods/messages_getHistory.md +++ b/old_docs/API_docs_v27/methods/messages_getHistory.md @@ -13,9 +13,9 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset|[CLICK ME int](../types/int.md) | Yes|Message ID offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| +|offset|[int](../types/int.md) | Yes|Message ID offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -23,18 +23,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -77,3 +65,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v27/methods/messages_getMessages.md b/old_docs/API_docs_v27/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v27/methods/messages_getMessages.md +++ b/old_docs/API_docs_v27/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v27/methods/messages_getStickers.md b/old_docs/API_docs_v27/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v27/methods/messages_getStickers.md +++ b/old_docs/API_docs_v27/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v27/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v27/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v27/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v27/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v27/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v27/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v27/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v27/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v27/methods/messages_readHistory.md b/old_docs/API_docs_v27/methods/messages_readHistory.md index 7d5d7e35..6898f9ec 100644 --- a/old_docs/API_docs_v27/methods/messages_readHistory.md +++ b/old_docs/API_docs_v27/methods/messages_readHistory.md @@ -13,8 +13,8 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +|offset|[int](../types/int.md) | Yes|Offset| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,14 +22,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: messages_AffectedHistory = messages.readHistory({peer=InputPeer, max_id=int, offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v27/methods/messages_readMessageContents.md b/old_docs/API_docs_v27/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v27/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v27/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v27/methods/messages_receivedMessages.md b/old_docs/API_docs_v27/methods/messages_receivedMessages.md index aca67286..6498fc15 100644 --- a/old_docs/API_docs_v27/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v27/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v27/methods/messages_search.md b/old_docs/API_docs_v27/methods/messages_search.md index 735ddf47..63d58b40 100644 --- a/old_docs/API_docs_v27/methods/messages_search.md +++ b/old_docs/API_docs_v27/methods/messages_search.md @@ -13,13 +13,13 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,19 +27,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -90,3 +77,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v27/methods/messages_sendBroadcast.md b/old_docs/API_docs_v27/methods/messages_sendBroadcast.md index 6cff8b29..8eca8090 100644 --- a/old_docs/API_docs_v27/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v27/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v27/methods/messages_sendEncrypted.md b/old_docs/API_docs_v27/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v27/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v27/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v27/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v27/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v27/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v27/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v27/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v27/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v27/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v27/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v27/methods/messages_sendMedia.md b/old_docs/API_docs_v27/methods/messages_sendMedia.md index e37d9970..f196ca92 100644 --- a/old_docs/API_docs_v27/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v27/methods/messages_sendMedia.md @@ -13,7 +13,7 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| @@ -22,34 +22,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -99,3 +71,31 @@ Or, if you're into Lua: Updates = messages.sendMedia({peer=InputPeer, reply_to_msg_id=int, media=InputMedia, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v27/methods/messages_sendMessage.md b/old_docs/API_docs_v27/methods/messages_sendMessage.md index 804cf5a2..27659188 100644 --- a/old_docs/API_docs_v27/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v27/methods/messages_sendMessage.md @@ -13,8 +13,8 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [messages\_SentMessage](../types/messages_SentMessage.md) @@ -22,33 +22,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -104,3 +77,30 @@ messages_SentMessage = messages.sendMessage({peer=InputPeer, reply_to_msg_id=int If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentMessage](../types/messages_SentMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v27/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v27/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v27/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v27/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v27/methods/messages_setTyping.md b/old_docs/API_docs_v27/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v27/methods/messages_setTyping.md +++ b/old_docs/API_docs_v27/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v27/methods/photos_getUserPhotos.md b/old_docs/API_docs_v27/methods/photos_getUserPhotos.md index 071a8f98..7c2f0a96 100644 --- a/old_docs/API_docs_v27/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v27/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v27/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v27/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v27/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v27/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v27/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v27/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v27/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v27/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v27/methods/users_getUsers.md b/old_docs/API_docs_v27/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v27/methods/users_getUsers.md +++ b/old_docs/API_docs_v27/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v33/methods/account_changePhone.md b/old_docs/API_docs_v33/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v33/methods/account_changePhone.md +++ b/old_docs/API_docs_v33/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v33/methods/account_checkUsername.md b/old_docs/API_docs_v33/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v33/methods/account_checkUsername.md +++ b/old_docs/API_docs_v33/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v33/methods/account_deleteAccount.md b/old_docs/API_docs_v33/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v33/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v33/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/account_getNotifySettings.md b/old_docs/API_docs_v33/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v33/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v33/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v33/methods/account_getPasswordSettings.md b/old_docs/API_docs_v33/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v33/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v33/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v33/methods/account_getPrivacy.md b/old_docs/API_docs_v33/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v33/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v33/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v33/methods/account_registerDevice.md b/old_docs/API_docs_v33/methods/account_registerDevice.md index 8dae7506..a69b58ff 100644 --- a/old_docs/API_docs_v33/methods/account_registerDevice.md +++ b/old_docs/API_docs_v33/methods/account_registerDevice.md @@ -12,13 +12,13 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [Bool](../types/Bool.md) @@ -26,13 +26,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -81,3 +74,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v33/methods/account_resetAuthorization.md b/old_docs/API_docs_v33/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v33/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v33/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v33/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v33/methods/account_sendChangePhoneCode.md index 930e0f76..181e817f 100644 --- a/old_docs/API_docs_v33/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v33/methods/account_sendChangePhoneCode.md @@ -12,7 +12,7 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| +|phone\_number|[string](../types/string.md) | Yes|New phone number| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) @@ -20,13 +20,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_SentChangePhoneCode = account.sendChangePhoneCode({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v33/methods/account_setAccountTTL.md b/old_docs/API_docs_v33/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v33/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v33/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v33/methods/account_setPrivacy.md b/old_docs/API_docs_v33/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v33/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v33/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v33/methods/account_unregisterDevice.md b/old_docs/API_docs_v33/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v33/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v33/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v33/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v33/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v33/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v33/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/account_updateNotifySettings.md b/old_docs/API_docs_v33/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v33/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v33/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v33/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v33/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v33/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v33/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v33/methods/account_updateProfile.md b/old_docs/API_docs_v33/methods/account_updateProfile.md index caea3391..67ceb92e 100644 --- a/old_docs/API_docs_v33/methods/account_updateProfile.md +++ b/old_docs/API_docs_v33/methods/account_updateProfile.md @@ -12,8 +12,8 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Yes|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Yes|The last name| +|first\_name|[string](../types/string.md) | Yes|The first name| +|last\_name|[string](../types/string.md) | Yes|The last name| ### Return type: [User](../types/User.md) @@ -21,14 +21,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v33/methods/account_updateStatus.md b/old_docs/API_docs_v33/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v33/methods/account_updateStatus.md +++ b/old_docs/API_docs_v33/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v33/methods/account_updateUsername.md b/old_docs/API_docs_v33/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v33/methods/account_updateUsername.md +++ b/old_docs/API_docs_v33/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v33/methods/auth_checkPhone.md b/old_docs/API_docs_v33/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v33/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v33/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v33/methods/auth_recoverPassword.md b/old_docs/API_docs_v33/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v33/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v33/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v33/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v33/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v33/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v33/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v33/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v33/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v33/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v33/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v33/methods/auth_sendCall.md b/old_docs/API_docs_v33/methods/auth_sendCall.md index 5947cda7..2f56038d 100644 --- a/old_docs/API_docs_v33/methods/auth_sendCall.md +++ b/old_docs/API_docs_v33/methods/auth_sendCall.md @@ -12,8 +12,8 @@ Send verification phone call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/auth_sendInvites.md b/old_docs/API_docs_v33/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v33/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v33/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v33/methods/auth_sendSms.md b/old_docs/API_docs_v33/methods/auth_sendSms.md index 41340660..38be5985 100644 --- a/old_docs/API_docs_v33/methods/auth_sendSms.md +++ b/old_docs/API_docs_v33/methods/auth_sendSms.md @@ -12,8 +12,8 @@ Send SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code ash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/contacts_block.md b/old_docs/API_docs_v33/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v33/methods/contacts_block.md +++ b/old_docs/API_docs_v33/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v33/methods/contacts_deleteContact.md b/old_docs/API_docs_v33/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v33/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v33/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v33/methods/contacts_deleteContacts.md b/old_docs/API_docs_v33/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v33/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v33/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v33/methods/contacts_getBlocked.md b/old_docs/API_docs_v33/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v33/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v33/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v33/methods/contacts_getContacts.md b/old_docs/API_docs_v33/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v33/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v33/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v33/methods/contacts_getSuggested.md b/old_docs/API_docs_v33/methods/contacts_getSuggested.md index 1ce04bef..1dba94e1 100644 --- a/old_docs/API_docs_v33/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v33/methods/contacts_getSuggested.md @@ -12,7 +12,7 @@ Get suggested contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v33/methods/contacts_importCard.md b/old_docs/API_docs_v33/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v33/methods/contacts_importCard.md +++ b/old_docs/API_docs_v33/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v33/methods/contacts_importContacts.md b/old_docs/API_docs_v33/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v33/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v33/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v33/methods/contacts_search.md b/old_docs/API_docs_v33/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v33/methods/contacts_search.md +++ b/old_docs/API_docs_v33/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v33/methods/contacts_unblock.md b/old_docs/API_docs_v33/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v33/methods/contacts_unblock.md +++ b/old_docs/API_docs_v33/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v33/methods/geochats_checkin.md b/old_docs/API_docs_v33/methods/geochats_checkin.md index 829f8e85..5b795614 100644 --- a/old_docs/API_docs_v33/methods/geochats_checkin.md +++ b/old_docs/API_docs_v33/methods/geochats_checkin.md @@ -12,7 +12,7 @@ Join a geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v33/methods/geochats_createGeoChat.md b/old_docs/API_docs_v33/methods/geochats_createGeoChat.md index 6881f300..35a3b081 100644 --- a/old_docs/API_docs_v33/methods/geochats_createGeoChat.md +++ b/old_docs/API_docs_v33/methods/geochats_createGeoChat.md @@ -12,10 +12,10 @@ Create geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|title|[CLICK ME string](../types/string.md) | Yes|Geochat title| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geochat location| -|address|[CLICK ME string](../types/string.md) | Yes|Geochat address| -|venue|[CLICK ME string](../types/string.md) | Yes|Geochat venue | +|title|[string](../types/string.md) | Yes|Geochat title| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geochat location| +|address|[string](../types/string.md) | Yes|Geochat address| +|venue|[string](../types/string.md) | Yes|Geochat venue | ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v33/methods/geochats_editChatPhoto.md b/old_docs/API_docs_v33/methods/geochats_editChatPhoto.md index 9d975f3f..57876bef 100644 --- a/old_docs/API_docs_v33/methods/geochats_editChatPhoto.md +++ b/old_docs/API_docs_v33/methods/geochats_editChatPhoto.md @@ -12,8 +12,8 @@ Edit geochat photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v33/methods/geochats_editChatTitle.md b/old_docs/API_docs_v33/methods/geochats_editChatTitle.md index fe43e476..9e7a7bfc 100644 --- a/old_docs/API_docs_v33/methods/geochats_editChatTitle.md +++ b/old_docs/API_docs_v33/methods/geochats_editChatTitle.md @@ -12,9 +12,9 @@ Edit geochat title | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| -|address|[CLICK ME string](../types/string.md) | Yes|The new address| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|title|[string](../types/string.md) | Yes|The new title| +|address|[string](../types/string.md) | Yes|The new address| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v33/methods/geochats_getFullChat.md b/old_docs/API_docs_v33/methods/geochats_getFullChat.md index 0ca442e0..a5c4bc9a 100644 --- a/old_docs/API_docs_v33/methods/geochats_getFullChat.md +++ b/old_docs/API_docs_v33/methods/geochats_getFullChat.md @@ -12,7 +12,7 @@ Get full info about a geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| ### Return type: [messages\_ChatFull](../types/messages_ChatFull.md) diff --git a/old_docs/API_docs_v33/methods/geochats_getHistory.md b/old_docs/API_docs_v33/methods/geochats_getHistory.md index e2727fda..6b47dd7a 100644 --- a/old_docs/API_docs_v33/methods/geochats_getHistory.md +++ b/old_docs/API_docs_v33/methods/geochats_getHistory.md @@ -12,10 +12,10 @@ Get geochat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v33/methods/geochats_getLocated.md b/old_docs/API_docs_v33/methods/geochats_getLocated.md index 9bcb9a66..63c6b0a7 100644 --- a/old_docs/API_docs_v33/methods/geochats_getLocated.md +++ b/old_docs/API_docs_v33/methods/geochats_getLocated.md @@ -12,9 +12,9 @@ Get nearby geochats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Current location| -|radius|[CLICK ME int](../types/int.md) | Yes|Radius| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Current location| +|radius|[int](../types/int.md) | Yes|Radius| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [geochats\_Located](../types/geochats_Located.md) diff --git a/old_docs/API_docs_v33/methods/geochats_getRecents.md b/old_docs/API_docs_v33/methods/geochats_getRecents.md index 6cd93cb6..0adff14f 100644 --- a/old_docs/API_docs_v33/methods/geochats_getRecents.md +++ b/old_docs/API_docs_v33/methods/geochats_getRecents.md @@ -12,8 +12,8 @@ Get recent geochats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|offset|[int](../types/int.md) | Yes|offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v33/methods/geochats_search.md b/old_docs/API_docs_v33/methods/geochats_search.md index 7bb91137..97853473 100644 --- a/old_docs/API_docs_v33/methods/geochats_search.md +++ b/old_docs/API_docs_v33/methods/geochats_search.md @@ -12,14 +12,14 @@ Search messages in geocha | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Search filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|q|[string](../types/string.md) | Yes|The search query| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Search filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date| +|max\_date|[int](../types/int.md) | Yes|Maximum date| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v33/methods/geochats_sendMedia.md b/old_docs/API_docs_v33/methods/geochats_sendMedia.md index cd50d19d..a018422d 100644 --- a/old_docs/API_docs_v33/methods/geochats_sendMedia.md +++ b/old_docs/API_docs_v33/methods/geochats_sendMedia.md @@ -12,7 +12,7 @@ Send media to geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v33/methods/geochats_sendMessage.md b/old_docs/API_docs_v33/methods/geochats_sendMessage.md index 23607283..b8fc2f9e 100644 --- a/old_docs/API_docs_v33/methods/geochats_sendMessage.md +++ b/old_docs/API_docs_v33/methods/geochats_sendMessage.md @@ -12,8 +12,8 @@ Send message to geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|message|[string](../types/string.md) | Yes|The message| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v33/methods/geochats_setTyping.md b/old_docs/API_docs_v33/methods/geochats_setTyping.md index 1eb07800..9088ab4e 100644 --- a/old_docs/API_docs_v33/methods/geochats_setTyping.md +++ b/old_docs/API_docs_v33/methods/geochats_setTyping.md @@ -12,8 +12,8 @@ Send typing notification to geochat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Typing or not typing| +|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +|typing|[Bool](../types/Bool.md) | Yes|Typing or not typing| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/help_getAppChangelog.md b/old_docs/API_docs_v33/methods/help_getAppChangelog.md index eb48fabb..f2d8c2ef 100644 --- a/old_docs/API_docs_v33/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v33/methods/help_getAppChangelog.md @@ -12,10 +12,10 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v33/methods/help_getAppUpdate.md b/old_docs/API_docs_v33/methods/help_getAppUpdate.md index ad5b8228..ce84843d 100644 --- a/old_docs/API_docs_v33/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v33/methods/help_getAppUpdate.md @@ -12,10 +12,10 @@ Get info about app updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Langauge code| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v33/methods/help_getConfig.md b/old_docs/API_docs_v33/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v33/methods/help_getConfig.md +++ b/old_docs/API_docs_v33/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v33/methods/help_getInviteText.md b/old_docs/API_docs_v33/methods/help_getInviteText.md index ad6ac262..9b82d55d 100644 --- a/old_docs/API_docs_v33/methods/help_getInviteText.md +++ b/old_docs/API_docs_v33/methods/help_getInviteText.md @@ -12,7 +12,7 @@ Get invitation text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language| +|lang\_code|[string](../types/string.md) | Yes|Language| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v33/methods/help_saveAppLog.md b/old_docs/API_docs_v33/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v33/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v33/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/initConnection.md b/old_docs/API_docs_v33/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v33/methods/initConnection.md +++ b/old_docs/API_docs_v33/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v33/methods/invokeAfterMsg.md b/old_docs/API_docs_v33/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v33/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v33/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v33/methods/invokeAfterMsgs.md b/old_docs/API_docs_v33/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v33/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v33/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v33/methods/invokeWithLayer.md b/old_docs/API_docs_v33/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v33/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v33/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v33/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v33/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v33/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v33/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v33/methods/messages_addChatUser.md b/old_docs/API_docs_v33/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v33/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v33/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v33/methods/messages_checkChatInvite.md b/old_docs/API_docs_v33/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v33/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v33/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v33/methods/messages_createChat.md b/old_docs/API_docs_v33/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v33/methods/messages_createChat.md +++ b/old_docs/API_docs_v33/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v33/methods/messages_deleteChatUser.md b/old_docs/API_docs_v33/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v33/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v33/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v33/methods/messages_deleteHistory.md b/old_docs/API_docs_v33/methods/messages_deleteHistory.md index 77b8987e..38baaad6 100644 --- a/old_docs/API_docs_v33/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v33/methods/messages_deleteHistory.md @@ -13,7 +13,7 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|offset|[int](../types/int.md) | Yes|Offset| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -21,13 +21,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v33/methods/messages_deleteMessages.md b/old_docs/API_docs_v33/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v33/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v33/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v33/methods/messages_editChatPhoto.md b/old_docs/API_docs_v33/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v33/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v33/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v33/methods/messages_editChatTitle.md b/old_docs/API_docs_v33/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v33/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v33/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v33/methods/messages_exportChatInvite.md b/old_docs/API_docs_v33/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v33/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v33/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v33/methods/messages_forwardMessage.md b/old_docs/API_docs_v33/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v33/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v33/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v33/methods/messages_forwardMessages.md b/old_docs/API_docs_v33/methods/messages_forwardMessages.md index cecf057b..91a15758 100644 --- a/old_docs/API_docs_v33/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v33/methods/messages_forwardMessages.md @@ -13,7 +13,7 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [Updates](../types/Updates.md) @@ -21,34 +21,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -96,3 +68,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({peer=InputPeer, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v33/methods/messages_getAllStickers.md b/old_docs/API_docs_v33/methods/messages_getAllStickers.md index 322f9b0b..3a8a66d1 100644 --- a/old_docs/API_docs_v33/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v33/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|Previously fetched stickers| +|hash|[string](../types/string.md) | Yes|Previously fetched stickers| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v33/methods/messages_getChats.md b/old_docs/API_docs_v33/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v33/methods/messages_getChats.md +++ b/old_docs/API_docs_v33/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v33/methods/messages_getDialogs.md b/old_docs/API_docs_v33/methods/messages_getDialogs.md index c388f163..afc3e956 100644 --- a/old_docs/API_docs_v33/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v33/methods/messages_getDialogs.md @@ -12,9 +12,9 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of result to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum ID of result to return| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -22,16 +22,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v33/methods/messages_getHistory.md b/old_docs/API_docs_v33/methods/messages_getHistory.md index ba497c74..d5c01235 100644 --- a/old_docs/API_docs_v33/methods/messages_getHistory.md +++ b/old_docs/API_docs_v33/methods/messages_getHistory.md @@ -13,9 +13,9 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset|[CLICK ME int](../types/int.md) | Yes|Message ID offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| +|offset|[int](../types/int.md) | Yes|Message ID offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -23,18 +23,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -77,3 +65,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v33/methods/messages_getMessages.md b/old_docs/API_docs_v33/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v33/methods/messages_getMessages.md +++ b/old_docs/API_docs_v33/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v33/methods/messages_getStickerSet.md b/old_docs/API_docs_v33/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v33/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v33/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v33/methods/messages_getStickers.md b/old_docs/API_docs_v33/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v33/methods/messages_getStickers.md +++ b/old_docs/API_docs_v33/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v33/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v33/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v33/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v33/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v33/methods/messages_importChatInvite.md b/old_docs/API_docs_v33/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v33/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v33/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v33/methods/messages_installStickerSet.md b/old_docs/API_docs_v33/methods/messages_installStickerSet.md index 77c5a2a5..c807ba66 100644 --- a/old_docs/API_docs_v33/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v33/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|Disable stickerset?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.installStickerSet({stickerset=InputStickerSet, disabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v33/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v33/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v33/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v33/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v33/methods/messages_readHistory.md b/old_docs/API_docs_v33/methods/messages_readHistory.md index 7d5d7e35..6898f9ec 100644 --- a/old_docs/API_docs_v33/methods/messages_readHistory.md +++ b/old_docs/API_docs_v33/methods/messages_readHistory.md @@ -13,8 +13,8 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +|offset|[int](../types/int.md) | Yes|Offset| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,14 +22,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: messages_AffectedHistory = messages.readHistory({peer=InputPeer, max_id=int, offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v33/methods/messages_readMessageContents.md b/old_docs/API_docs_v33/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v33/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v33/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v33/methods/messages_receivedMessages.md b/old_docs/API_docs_v33/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v33/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v33/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v33/methods/messages_search.md b/old_docs/API_docs_v33/methods/messages_search.md index 735ddf47..63d58b40 100644 --- a/old_docs/API_docs_v33/methods/messages_search.md +++ b/old_docs/API_docs_v33/methods/messages_search.md @@ -13,13 +13,13 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,19 +27,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -90,3 +77,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v33/methods/messages_sendBroadcast.md b/old_docs/API_docs_v33/methods/messages_sendBroadcast.md index 6cff8b29..8eca8090 100644 --- a/old_docs/API_docs_v33/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v33/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v33/methods/messages_sendEncrypted.md b/old_docs/API_docs_v33/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v33/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v33/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v33/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v33/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v33/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v33/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v33/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v33/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v33/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v33/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v33/methods/messages_sendMedia.md b/old_docs/API_docs_v33/methods/messages_sendMedia.md index 552a60d0..2ddcd120 100644 --- a/old_docs/API_docs_v33/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v33/methods/messages_sendMedia.md @@ -13,9 +13,9 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -23,34 +23,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -108,3 +80,31 @@ Updates = messages.sendMedia({peer=InputPeer, reply_to_msg_id=int, media=InputMe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v33/methods/messages_sendMessage.md b/old_docs/API_docs_v33/methods/messages_sendMessage.md index 50b289bb..b1ec3dec 100644 --- a/old_docs/API_docs_v33/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v33/methods/messages_sendMessage.md @@ -13,9 +13,9 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [messages\_SentMessage](../types/messages_SentMessage.md) @@ -23,33 +23,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -113,3 +86,30 @@ You can provide bot API reply_markup objects here. If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentMessage](../types/messages_SentMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v33/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v33/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v33/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v33/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v33/methods/messages_setTyping.md b/old_docs/API_docs_v33/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v33/methods/messages_setTyping.md +++ b/old_docs/API_docs_v33/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v33/methods/messages_startBot.md b/old_docs/API_docs_v33/methods/messages_startBot.md index 82054827..8105a214 100644 --- a/old_docs/API_docs_v33/methods/messages_startBot.md +++ b/old_docs/API_docs_v33/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Chat ID| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, chat_id=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v33/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v33/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v33/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v33/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v33/methods/photos_getUserPhotos.md b/old_docs/API_docs_v33/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v33/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v33/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v33/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v33/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v33/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v33/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v33/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v33/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v33/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v33/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v33/methods/users_getUsers.md b/old_docs/API_docs_v33/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v33/methods/users_getUsers.md +++ b/old_docs/API_docs_v33/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v38/methods/account_changePhone.md b/old_docs/API_docs_v38/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v38/methods/account_changePhone.md +++ b/old_docs/API_docs_v38/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v38/methods/account_checkUsername.md b/old_docs/API_docs_v38/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v38/methods/account_checkUsername.md +++ b/old_docs/API_docs_v38/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v38/methods/account_deleteAccount.md b/old_docs/API_docs_v38/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v38/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v38/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/account_getNotifySettings.md b/old_docs/API_docs_v38/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v38/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v38/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v38/methods/account_getPasswordSettings.md b/old_docs/API_docs_v38/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v38/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v38/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v38/methods/account_getPrivacy.md b/old_docs/API_docs_v38/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v38/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v38/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v38/methods/account_registerDevice.md b/old_docs/API_docs_v38/methods/account_registerDevice.md index 8dae7506..a69b58ff 100644 --- a/old_docs/API_docs_v38/methods/account_registerDevice.md +++ b/old_docs/API_docs_v38/methods/account_registerDevice.md @@ -12,13 +12,13 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [Bool](../types/Bool.md) @@ -26,13 +26,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -81,3 +74,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v38/methods/account_resetAuthorization.md b/old_docs/API_docs_v38/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v38/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v38/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v38/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v38/methods/account_sendChangePhoneCode.md index 930e0f76..181e817f 100644 --- a/old_docs/API_docs_v38/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v38/methods/account_sendChangePhoneCode.md @@ -12,7 +12,7 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| +|phone\_number|[string](../types/string.md) | Yes|New phone number| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) @@ -20,13 +20,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_SentChangePhoneCode = account.sendChangePhoneCode({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v38/methods/account_setAccountTTL.md b/old_docs/API_docs_v38/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v38/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v38/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v38/methods/account_setPrivacy.md b/old_docs/API_docs_v38/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v38/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v38/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v38/methods/account_unregisterDevice.md b/old_docs/API_docs_v38/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v38/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v38/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v38/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v38/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v38/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v38/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/account_updateNotifySettings.md b/old_docs/API_docs_v38/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v38/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v38/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v38/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v38/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v38/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v38/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v38/methods/account_updateProfile.md b/old_docs/API_docs_v38/methods/account_updateProfile.md index caea3391..67ceb92e 100644 --- a/old_docs/API_docs_v38/methods/account_updateProfile.md +++ b/old_docs/API_docs_v38/methods/account_updateProfile.md @@ -12,8 +12,8 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Yes|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Yes|The last name| +|first\_name|[string](../types/string.md) | Yes|The first name| +|last\_name|[string](../types/string.md) | Yes|The last name| ### Return type: [User](../types/User.md) @@ -21,14 +21,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v38/methods/account_updateStatus.md b/old_docs/API_docs_v38/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v38/methods/account_updateStatus.md +++ b/old_docs/API_docs_v38/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v38/methods/account_updateUsername.md b/old_docs/API_docs_v38/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v38/methods/account_updateUsername.md +++ b/old_docs/API_docs_v38/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v38/methods/auth_checkPhone.md b/old_docs/API_docs_v38/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v38/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v38/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v38/methods/auth_recoverPassword.md b/old_docs/API_docs_v38/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v38/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v38/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v38/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v38/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v38/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v38/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v38/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v38/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v38/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v38/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v38/methods/auth_sendCall.md b/old_docs/API_docs_v38/methods/auth_sendCall.md index 5947cda7..2f56038d 100644 --- a/old_docs/API_docs_v38/methods/auth_sendCall.md +++ b/old_docs/API_docs_v38/methods/auth_sendCall.md @@ -12,8 +12,8 @@ Send verification phone call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/auth_sendInvites.md b/old_docs/API_docs_v38/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v38/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v38/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v38/methods/auth_sendSms.md b/old_docs/API_docs_v38/methods/auth_sendSms.md index 41340660..38be5985 100644 --- a/old_docs/API_docs_v38/methods/auth_sendSms.md +++ b/old_docs/API_docs_v38/methods/auth_sendSms.md @@ -12,8 +12,8 @@ Send SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code ash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/channels_checkUsername.md b/old_docs/API_docs_v38/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v38/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v38/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v38/methods/channels_createChannel.md b/old_docs/API_docs_v38/methods/channels_createChannel.md index 9ebdab9d..3fbe7c36 100644 --- a/old_docs/API_docs_v38/methods/channels_createChannel.md +++ b/old_docs/API_docs_v38/methods/channels_createChannel.md @@ -12,8 +12,8 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|Users to add to channel| @@ -22,14 +22,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Updates = channels.createChannel({title='string', about='string', users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v38/methods/channels_deleteChannel.md b/old_docs/API_docs_v38/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v38/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v38/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v38/methods/channels_deleteMessages.md b/old_docs/API_docs_v38/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v38/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v38/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v38/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v38/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v38/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v38/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v38/methods/channels_editAbout.md b/old_docs/API_docs_v38/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v38/methods/channels_editAbout.md +++ b/old_docs/API_docs_v38/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v38/methods/channels_editAdmin.md b/old_docs/API_docs_v38/methods/channels_editAdmin.md index 9f69c065..8d6d4901 100644 --- a/old_docs/API_docs_v38/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v38/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| ### Return type: [Bool](../types/Bool.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Bool = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v38/methods/channels_editPhoto.md b/old_docs/API_docs_v38/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v38/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v38/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v38/methods/channels_editTitle.md b/old_docs/API_docs_v38/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v38/methods/channels_editTitle.md +++ b/old_docs/API_docs_v38/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v38/methods/channels_exportInvite.md b/old_docs/API_docs_v38/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v38/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v38/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v38/methods/channels_getChannels.md b/old_docs/API_docs_v38/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v38/methods/channels_getChannels.md +++ b/old_docs/API_docs_v38/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v38/methods/channels_getDialogs.md b/old_docs/API_docs_v38/methods/channels_getDialogs.md index 1b5837b7..563b798b 100644 --- a/old_docs/API_docs_v38/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v38/methods/channels_getDialogs.md @@ -12,8 +12,8 @@ Get channel dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v38/methods/channels_getImportantHistory.md b/old_docs/API_docs_v38/methods/channels_getImportantHistory.md index 861e4a32..43cdd5b9 100644 --- a/old_docs/API_docs_v38/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v38/methods/channels_getImportantHistory.md @@ -13,11 +13,11 @@ Get important channel/supergroup history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID| +|offset\_id|[int](../types/int.md) | Yes|Message ID offset| +|add\_offset|[int](../types/int.md) | Yes|Additional offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v38/methods/channels_getMessages.md b/old_docs/API_docs_v38/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v38/methods/channels_getMessages.md +++ b/old_docs/API_docs_v38/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v38/methods/channels_getParticipant.md b/old_docs/API_docs_v38/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v38/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v38/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v38/methods/channels_getParticipants.md b/old_docs/API_docs_v38/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v38/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v38/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v38/methods/channels_inviteToChannel.md b/old_docs/API_docs_v38/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v38/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v38/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v38/methods/channels_joinChannel.md b/old_docs/API_docs_v38/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v38/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v38/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v38/methods/channels_kickFromChannel.md b/old_docs/API_docs_v38/methods/channels_kickFromChannel.md index 8f6c92be..0c6c0258 100644 --- a/old_docs/API_docs_v38/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v38/methods/channels_kickFromChannel.md @@ -14,7 +14,7 @@ Kick user from channel |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick| -|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|Kick or unkick?| +|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/channels_leaveChannel.md b/old_docs/API_docs_v38/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v38/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v38/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v38/methods/channels_readHistory.md b/old_docs/API_docs_v38/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v38/methods/channels_readHistory.md +++ b/old_docs/API_docs_v38/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v38/methods/channels_reportSpam.md b/old_docs/API_docs_v38/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v38/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v38/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v38/methods/channels_toggleComments.md b/old_docs/API_docs_v38/methods/channels_toggleComments.md index cc9f478d..3f52496b 100644 --- a/old_docs/API_docs_v38/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v38/methods/channels_toggleComments.md @@ -13,7 +13,7 @@ Enable channel comments | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable comments| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/channels_updateUsername.md b/old_docs/API_docs_v38/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v38/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v38/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v38/methods/contacts_block.md b/old_docs/API_docs_v38/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v38/methods/contacts_block.md +++ b/old_docs/API_docs_v38/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v38/methods/contacts_deleteContact.md b/old_docs/API_docs_v38/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v38/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v38/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v38/methods/contacts_deleteContacts.md b/old_docs/API_docs_v38/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v38/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v38/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v38/methods/contacts_getBlocked.md b/old_docs/API_docs_v38/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v38/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v38/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v38/methods/contacts_getContacts.md b/old_docs/API_docs_v38/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v38/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v38/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v38/methods/contacts_getSuggested.md b/old_docs/API_docs_v38/methods/contacts_getSuggested.md index 1ce04bef..1dba94e1 100644 --- a/old_docs/API_docs_v38/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v38/methods/contacts_getSuggested.md @@ -12,7 +12,7 @@ Get suggested contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v38/methods/contacts_importCard.md b/old_docs/API_docs_v38/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v38/methods/contacts_importCard.md +++ b/old_docs/API_docs_v38/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v38/methods/contacts_importContacts.md b/old_docs/API_docs_v38/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v38/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v38/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v38/methods/contacts_search.md b/old_docs/API_docs_v38/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v38/methods/contacts_search.md +++ b/old_docs/API_docs_v38/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v38/methods/contacts_unblock.md b/old_docs/API_docs_v38/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v38/methods/contacts_unblock.md +++ b/old_docs/API_docs_v38/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v38/methods/help_getAppChangelog.md b/old_docs/API_docs_v38/methods/help_getAppChangelog.md index eb48fabb..f2d8c2ef 100644 --- a/old_docs/API_docs_v38/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v38/methods/help_getAppChangelog.md @@ -12,10 +12,10 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v38/methods/help_getAppUpdate.md b/old_docs/API_docs_v38/methods/help_getAppUpdate.md index ad5b8228..ce84843d 100644 --- a/old_docs/API_docs_v38/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v38/methods/help_getAppUpdate.md @@ -12,10 +12,10 @@ Get info about app updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Langauge code| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v38/methods/help_getConfig.md b/old_docs/API_docs_v38/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v38/methods/help_getConfig.md +++ b/old_docs/API_docs_v38/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v38/methods/help_getInviteText.md b/old_docs/API_docs_v38/methods/help_getInviteText.md index ad6ac262..9b82d55d 100644 --- a/old_docs/API_docs_v38/methods/help_getInviteText.md +++ b/old_docs/API_docs_v38/methods/help_getInviteText.md @@ -12,7 +12,7 @@ Get invitation text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language| +|lang\_code|[string](../types/string.md) | Yes|Language| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v38/methods/help_saveAppLog.md b/old_docs/API_docs_v38/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v38/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v38/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/initConnection.md b/old_docs/API_docs_v38/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v38/methods/initConnection.md +++ b/old_docs/API_docs_v38/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v38/methods/invokeAfterMsg.md b/old_docs/API_docs_v38/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v38/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v38/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v38/methods/invokeAfterMsgs.md b/old_docs/API_docs_v38/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v38/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v38/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v38/methods/invokeWithLayer.md b/old_docs/API_docs_v38/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v38/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v38/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v38/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v38/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v38/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v38/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v38/methods/messages_addChatUser.md b/old_docs/API_docs_v38/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v38/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v38/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v38/methods/messages_checkChatInvite.md b/old_docs/API_docs_v38/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v38/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v38/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v38/methods/messages_createChat.md b/old_docs/API_docs_v38/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v38/methods/messages_createChat.md +++ b/old_docs/API_docs_v38/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v38/methods/messages_deleteChatUser.md b/old_docs/API_docs_v38/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v38/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v38/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v38/methods/messages_deleteHistory.md b/old_docs/API_docs_v38/methods/messages_deleteHistory.md index 77b8987e..38baaad6 100644 --- a/old_docs/API_docs_v38/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v38/methods/messages_deleteHistory.md @@ -13,7 +13,7 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|offset|[int](../types/int.md) | Yes|Offset| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -21,13 +21,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v38/methods/messages_deleteMessages.md b/old_docs/API_docs_v38/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v38/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v38/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v38/methods/messages_editChatPhoto.md b/old_docs/API_docs_v38/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v38/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v38/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v38/methods/messages_editChatTitle.md b/old_docs/API_docs_v38/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v38/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v38/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v38/methods/messages_exportChatInvite.md b/old_docs/API_docs_v38/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v38/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v38/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v38/methods/messages_forwardMessage.md b/old_docs/API_docs_v38/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v38/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v38/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v38/methods/messages_forwardMessages.md b/old_docs/API_docs_v38/methods/messages_forwardMessages.md index 5267c383..617e025f 100644 --- a/old_docs/API_docs_v38/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v38/methods/messages_forwardMessages.md @@ -13,7 +13,7 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -22,34 +22,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -99,3 +71,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v38/methods/messages_getAllStickers.md b/old_docs/API_docs_v38/methods/messages_getAllStickers.md index 322f9b0b..3a8a66d1 100644 --- a/old_docs/API_docs_v38/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v38/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|Previously fetched stickers| +|hash|[string](../types/string.md) | Yes|Previously fetched stickers| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v38/methods/messages_getChats.md b/old_docs/API_docs_v38/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v38/methods/messages_getChats.md +++ b/old_docs/API_docs_v38/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v38/methods/messages_getDialogs.md b/old_docs/API_docs_v38/methods/messages_getDialogs.md index 269c6897..a6e1c610 100644 --- a/old_docs/API_docs_v38/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v38/methods/messages_getDialogs.md @@ -12,8 +12,8 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -21,16 +21,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v38/methods/messages_getHistory.md b/old_docs/API_docs_v38/methods/messages_getHistory.md index dfefb639..cc438ce2 100644 --- a/old_docs/API_docs_v38/methods/messages_getHistory.md +++ b/old_docs/API_docs_v38/methods/messages_getHistory.md @@ -13,11 +13,11 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -25,18 +25,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -83,3 +71,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v38/methods/messages_getMessages.md b/old_docs/API_docs_v38/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v38/methods/messages_getMessages.md +++ b/old_docs/API_docs_v38/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v38/methods/messages_getMessagesViews.md b/old_docs/API_docs_v38/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v38/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v38/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v38/methods/messages_getStickerSet.md b/old_docs/API_docs_v38/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v38/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v38/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v38/methods/messages_getStickers.md b/old_docs/API_docs_v38/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v38/methods/messages_getStickers.md +++ b/old_docs/API_docs_v38/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v38/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v38/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v38/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v38/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v38/methods/messages_importChatInvite.md b/old_docs/API_docs_v38/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v38/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v38/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v38/methods/messages_installStickerSet.md b/old_docs/API_docs_v38/methods/messages_installStickerSet.md index 77c5a2a5..c807ba66 100644 --- a/old_docs/API_docs_v38/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v38/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|Disable stickerset?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.installStickerSet({stickerset=InputStickerSet, disabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v38/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v38/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v38/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v38/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v38/methods/messages_readHistory.md b/old_docs/API_docs_v38/methods/messages_readHistory.md index 7d5d7e35..6898f9ec 100644 --- a/old_docs/API_docs_v38/methods/messages_readHistory.md +++ b/old_docs/API_docs_v38/methods/messages_readHistory.md @@ -13,8 +13,8 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +|offset|[int](../types/int.md) | Yes|Offset| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,14 +22,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: messages_AffectedHistory = messages.readHistory({peer=InputPeer, max_id=int, offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v38/methods/messages_readMessageContents.md b/old_docs/API_docs_v38/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v38/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v38/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v38/methods/messages_receivedMessages.md b/old_docs/API_docs_v38/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v38/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v38/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v38/methods/messages_reportSpam.md b/old_docs/API_docs_v38/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v38/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v38/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v38/methods/messages_search.md b/old_docs/API_docs_v38/methods/messages_search.md index 735ddf47..63d58b40 100644 --- a/old_docs/API_docs_v38/methods/messages_search.md +++ b/old_docs/API_docs_v38/methods/messages_search.md @@ -13,13 +13,13 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,19 +27,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -90,3 +77,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v38/methods/messages_sendBroadcast.md b/old_docs/API_docs_v38/methods/messages_sendBroadcast.md index 6cff8b29..8eca8090 100644 --- a/old_docs/API_docs_v38/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v38/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v38/methods/messages_sendEncrypted.md b/old_docs/API_docs_v38/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v38/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v38/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v38/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v38/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v38/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v38/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v38/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v38/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v38/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v38/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v38/methods/messages_sendMedia.md b/old_docs/API_docs_v38/methods/messages_sendMedia.md index 552a60d0..2ddcd120 100644 --- a/old_docs/API_docs_v38/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v38/methods/messages_sendMedia.md @@ -13,9 +13,9 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -23,34 +23,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -108,3 +80,31 @@ Updates = messages.sendMedia({peer=InputPeer, reply_to_msg_id=int, media=InputMe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v38/methods/messages_sendMessage.md b/old_docs/API_docs_v38/methods/messages_sendMessage.md index 494f9871..14e2c75f 100644 --- a/old_docs/API_docs_v38/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v38/methods/messages_sendMessage.md @@ -13,10 +13,10 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,33 +25,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -139,3 +112,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v38/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v38/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v38/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v38/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v38/methods/messages_setTyping.md b/old_docs/API_docs_v38/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v38/methods/messages_setTyping.md +++ b/old_docs/API_docs_v38/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v38/methods/messages_startBot.md b/old_docs/API_docs_v38/methods/messages_startBot.md index 82054827..8105a214 100644 --- a/old_docs/API_docs_v38/methods/messages_startBot.md +++ b/old_docs/API_docs_v38/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Chat ID| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, chat_id=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v38/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v38/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v38/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v38/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v38/methods/photos_getUserPhotos.md b/old_docs/API_docs_v38/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v38/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v38/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v38/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v38/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v38/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v38/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v38/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v38/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v38/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v38/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v38/methods/users_getUsers.md b/old_docs/API_docs_v38/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v38/methods/users_getUsers.md +++ b/old_docs/API_docs_v38/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v40/methods/account_changePhone.md b/old_docs/API_docs_v40/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v40/methods/account_changePhone.md +++ b/old_docs/API_docs_v40/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v40/methods/account_checkUsername.md b/old_docs/API_docs_v40/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v40/methods/account_checkUsername.md +++ b/old_docs/API_docs_v40/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v40/methods/account_deleteAccount.md b/old_docs/API_docs_v40/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v40/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v40/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/account_getNotifySettings.md b/old_docs/API_docs_v40/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v40/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v40/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v40/methods/account_getPasswordSettings.md b/old_docs/API_docs_v40/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v40/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v40/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v40/methods/account_getPrivacy.md b/old_docs/API_docs_v40/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v40/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v40/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v40/methods/account_registerDevice.md b/old_docs/API_docs_v40/methods/account_registerDevice.md index 8dae7506..a69b58ff 100644 --- a/old_docs/API_docs_v40/methods/account_registerDevice.md +++ b/old_docs/API_docs_v40/methods/account_registerDevice.md @@ -12,13 +12,13 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [Bool](../types/Bool.md) @@ -26,13 +26,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -81,3 +74,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v40/methods/account_resetAuthorization.md b/old_docs/API_docs_v40/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v40/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v40/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v40/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v40/methods/account_sendChangePhoneCode.md index 930e0f76..181e817f 100644 --- a/old_docs/API_docs_v40/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v40/methods/account_sendChangePhoneCode.md @@ -12,7 +12,7 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| +|phone\_number|[string](../types/string.md) | Yes|New phone number| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) @@ -20,13 +20,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_SentChangePhoneCode = account.sendChangePhoneCode({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v40/methods/account_setAccountTTL.md b/old_docs/API_docs_v40/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v40/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v40/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v40/methods/account_setPrivacy.md b/old_docs/API_docs_v40/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v40/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v40/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v40/methods/account_unregisterDevice.md b/old_docs/API_docs_v40/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v40/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v40/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v40/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v40/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v40/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v40/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/account_updateNotifySettings.md b/old_docs/API_docs_v40/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v40/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v40/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v40/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v40/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v40/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v40/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v40/methods/account_updateProfile.md b/old_docs/API_docs_v40/methods/account_updateProfile.md index caea3391..67ceb92e 100644 --- a/old_docs/API_docs_v40/methods/account_updateProfile.md +++ b/old_docs/API_docs_v40/methods/account_updateProfile.md @@ -12,8 +12,8 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Yes|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Yes|The last name| +|first\_name|[string](../types/string.md) | Yes|The first name| +|last\_name|[string](../types/string.md) | Yes|The last name| ### Return type: [User](../types/User.md) @@ -21,14 +21,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v40/methods/account_updateStatus.md b/old_docs/API_docs_v40/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v40/methods/account_updateStatus.md +++ b/old_docs/API_docs_v40/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v40/methods/account_updateUsername.md b/old_docs/API_docs_v40/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v40/methods/account_updateUsername.md +++ b/old_docs/API_docs_v40/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v40/methods/auth_checkPhone.md b/old_docs/API_docs_v40/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v40/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v40/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v40/methods/auth_recoverPassword.md b/old_docs/API_docs_v40/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v40/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v40/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v40/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v40/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v40/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v40/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v40/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v40/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v40/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v40/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v40/methods/auth_sendCall.md b/old_docs/API_docs_v40/methods/auth_sendCall.md index 5947cda7..2f56038d 100644 --- a/old_docs/API_docs_v40/methods/auth_sendCall.md +++ b/old_docs/API_docs_v40/methods/auth_sendCall.md @@ -12,8 +12,8 @@ Send verification phone call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/auth_sendInvites.md b/old_docs/API_docs_v40/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v40/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v40/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v40/methods/auth_sendSms.md b/old_docs/API_docs_v40/methods/auth_sendSms.md index 41340660..38be5985 100644 --- a/old_docs/API_docs_v40/methods/auth_sendSms.md +++ b/old_docs/API_docs_v40/methods/auth_sendSms.md @@ -12,8 +12,8 @@ Send SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code ash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/contacts_block.md b/old_docs/API_docs_v40/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v40/methods/contacts_block.md +++ b/old_docs/API_docs_v40/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v40/methods/contacts_deleteContact.md b/old_docs/API_docs_v40/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v40/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v40/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v40/methods/contacts_deleteContacts.md b/old_docs/API_docs_v40/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v40/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v40/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v40/methods/contacts_getBlocked.md b/old_docs/API_docs_v40/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v40/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v40/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v40/methods/contacts_getContacts.md b/old_docs/API_docs_v40/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v40/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v40/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v40/methods/contacts_getSuggested.md b/old_docs/API_docs_v40/methods/contacts_getSuggested.md index 1ce04bef..1dba94e1 100644 --- a/old_docs/API_docs_v40/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v40/methods/contacts_getSuggested.md @@ -12,7 +12,7 @@ Get suggested contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v40/methods/contacts_importCard.md b/old_docs/API_docs_v40/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v40/methods/contacts_importCard.md +++ b/old_docs/API_docs_v40/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v40/methods/contacts_importContacts.md b/old_docs/API_docs_v40/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v40/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v40/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v40/methods/contacts_search.md b/old_docs/API_docs_v40/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v40/methods/contacts_search.md +++ b/old_docs/API_docs_v40/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v40/methods/contacts_unblock.md b/old_docs/API_docs_v40/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v40/methods/contacts_unblock.md +++ b/old_docs/API_docs_v40/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v40/methods/help_getAppChangelog.md b/old_docs/API_docs_v40/methods/help_getAppChangelog.md index eb48fabb..f2d8c2ef 100644 --- a/old_docs/API_docs_v40/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v40/methods/help_getAppChangelog.md @@ -12,10 +12,10 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v40/methods/help_getAppUpdate.md b/old_docs/API_docs_v40/methods/help_getAppUpdate.md index ad5b8228..ce84843d 100644 --- a/old_docs/API_docs_v40/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v40/methods/help_getAppUpdate.md @@ -12,10 +12,10 @@ Get info about app updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Langauge code| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v40/methods/help_getConfig.md b/old_docs/API_docs_v40/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v40/methods/help_getConfig.md +++ b/old_docs/API_docs_v40/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v40/methods/help_getInviteText.md b/old_docs/API_docs_v40/methods/help_getInviteText.md index ad6ac262..9b82d55d 100644 --- a/old_docs/API_docs_v40/methods/help_getInviteText.md +++ b/old_docs/API_docs_v40/methods/help_getInviteText.md @@ -12,7 +12,7 @@ Get invitation text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language| +|lang\_code|[string](../types/string.md) | Yes|Language| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v40/methods/help_saveAppLog.md b/old_docs/API_docs_v40/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v40/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v40/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/initConnection.md b/old_docs/API_docs_v40/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v40/methods/initConnection.md +++ b/old_docs/API_docs_v40/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v40/methods/invokeAfterMsg.md b/old_docs/API_docs_v40/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v40/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v40/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v40/methods/invokeAfterMsgs.md b/old_docs/API_docs_v40/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v40/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v40/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v40/methods/invokeWithLayer.md b/old_docs/API_docs_v40/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v40/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v40/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v40/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v40/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v40/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v40/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v40/methods/messages_addChatUser.md b/old_docs/API_docs_v40/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v40/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v40/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v40/methods/messages_checkChatInvite.md b/old_docs/API_docs_v40/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v40/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v40/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v40/methods/messages_createChannel.md b/old_docs/API_docs_v40/methods/messages_createChannel.md index 621f9125..0463929f 100644 --- a/old_docs/API_docs_v40/methods/messages_createChannel.md +++ b/old_docs/API_docs_v40/methods/messages_createChannel.md @@ -12,7 +12,7 @@ Create channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|title|[CLICK ME string](../types/string.md) | Yes|Channel/supergroup title| +|title|[string](../types/string.md) | Yes|Channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v40/methods/messages_createChat.md b/old_docs/API_docs_v40/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v40/methods/messages_createChat.md +++ b/old_docs/API_docs_v40/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v40/methods/messages_deleteChannelMessages.md b/old_docs/API_docs_v40/methods/messages_deleteChannelMessages.md index fd6d49cc..6013614f 100644 --- a/old_docs/API_docs_v40/methods/messages_deleteChannelMessages.md +++ b/old_docs/API_docs_v40/methods/messages_deleteChannelMessages.md @@ -13,7 +13,7 @@ Delete channel messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v40/methods/messages_deleteChatUser.md b/old_docs/API_docs_v40/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v40/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v40/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v40/methods/messages_deleteHistory.md b/old_docs/API_docs_v40/methods/messages_deleteHistory.md index 77b8987e..38baaad6 100644 --- a/old_docs/API_docs_v40/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v40/methods/messages_deleteHistory.md @@ -13,7 +13,7 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|offset|[int](../types/int.md) | Yes|Offset| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -21,13 +21,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v40/methods/messages_deleteMessages.md b/old_docs/API_docs_v40/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v40/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v40/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v40/methods/messages_editChatPhoto.md b/old_docs/API_docs_v40/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v40/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v40/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v40/methods/messages_editChatTitle.md b/old_docs/API_docs_v40/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v40/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v40/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v40/methods/messages_exportChatInvite.md b/old_docs/API_docs_v40/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v40/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v40/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v40/methods/messages_forwardMessage.md b/old_docs/API_docs_v40/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v40/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v40/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v40/methods/messages_forwardMessages.md b/old_docs/API_docs_v40/methods/messages_forwardMessages.md index cecf057b..91a15758 100644 --- a/old_docs/API_docs_v40/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v40/methods/messages_forwardMessages.md @@ -13,7 +13,7 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [Updates](../types/Updates.md) @@ -21,34 +21,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -96,3 +68,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({peer=InputPeer, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v40/methods/messages_getAllStickers.md b/old_docs/API_docs_v40/methods/messages_getAllStickers.md index 322f9b0b..3a8a66d1 100644 --- a/old_docs/API_docs_v40/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v40/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|Previously fetched stickers| +|hash|[string](../types/string.md) | Yes|Previously fetched stickers| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v40/methods/messages_getChannelDialogs.md b/old_docs/API_docs_v40/methods/messages_getChannelDialogs.md index a0214662..8acc19f9 100644 --- a/old_docs/API_docs_v40/methods/messages_getChannelDialogs.md +++ b/old_docs/API_docs_v40/methods/messages_getChannelDialogs.md @@ -12,8 +12,8 @@ Get channel/supergruop dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v40/methods/messages_getChats.md b/old_docs/API_docs_v40/methods/messages_getChats.md index 2fe86556..3525bf7e 100644 --- a/old_docs/API_docs_v40/methods/messages_getChats.md +++ b/old_docs/API_docs_v40/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME InputChat](../types/InputChat.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [InputChat](../types/InputChat.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={InputChat}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v40/methods/messages_getDialogs.md b/old_docs/API_docs_v40/methods/messages_getDialogs.md index 269c6897..a6e1c610 100644 --- a/old_docs/API_docs_v40/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v40/methods/messages_getDialogs.md @@ -12,8 +12,8 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -21,16 +21,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v40/methods/messages_getHistory.md b/old_docs/API_docs_v40/methods/messages_getHistory.md index 429092a0..8213eacb 100644 --- a/old_docs/API_docs_v40/methods/messages_getHistory.md +++ b/old_docs/API_docs_v40/methods/messages_getHistory.md @@ -13,10 +13,10 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset|[CLICK ME int](../types/int.md) | Yes|Message ID offset| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| +|offset|[int](../types/int.md) | Yes|Message ID offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,18 +24,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -80,3 +68,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset=int, max_id=int, min_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v40/methods/messages_getImportantHistory.md b/old_docs/API_docs_v40/methods/messages_getImportantHistory.md index d8659cdb..91f0b001 100644 --- a/old_docs/API_docs_v40/methods/messages_getImportantHistory.md +++ b/old_docs/API_docs_v40/methods/messages_getImportantHistory.md @@ -13,9 +13,9 @@ Get important message history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v40/methods/messages_getMessages.md b/old_docs/API_docs_v40/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v40/methods/messages_getMessages.md +++ b/old_docs/API_docs_v40/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v40/methods/messages_getStickerSet.md b/old_docs/API_docs_v40/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v40/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v40/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v40/methods/messages_getStickers.md b/old_docs/API_docs_v40/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v40/methods/messages_getStickers.md +++ b/old_docs/API_docs_v40/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v40/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v40/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v40/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v40/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v40/methods/messages_importChatInvite.md b/old_docs/API_docs_v40/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v40/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v40/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v40/methods/messages_installStickerSet.md b/old_docs/API_docs_v40/methods/messages_installStickerSet.md index 77c5a2a5..c807ba66 100644 --- a/old_docs/API_docs_v40/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v40/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|Disable stickerset?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.installStickerSet({stickerset=InputStickerSet, disabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v40/methods/messages_readChannelHistory.md b/old_docs/API_docs_v40/methods/messages_readChannelHistory.md index 50661907..c7bb053d 100644 --- a/old_docs/API_docs_v40/methods/messages_readChannelHistory.md +++ b/old_docs/API_docs_v40/methods/messages_readChannelHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The channel/supergruop| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v40/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v40/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v40/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v40/methods/messages_readHistory.md b/old_docs/API_docs_v40/methods/messages_readHistory.md index 7d5d7e35..6898f9ec 100644 --- a/old_docs/API_docs_v40/methods/messages_readHistory.md +++ b/old_docs/API_docs_v40/methods/messages_readHistory.md @@ -13,8 +13,8 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +|offset|[int](../types/int.md) | Yes|Offset| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,14 +22,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: messages_AffectedHistory = messages.readHistory({peer=InputPeer, max_id=int, offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v40/methods/messages_readMessageContents.md b/old_docs/API_docs_v40/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v40/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v40/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v40/methods/messages_receivedMessages.md b/old_docs/API_docs_v40/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v40/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v40/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v40/methods/messages_search.md b/old_docs/API_docs_v40/methods/messages_search.md index 735ddf47..63d58b40 100644 --- a/old_docs/API_docs_v40/methods/messages_search.md +++ b/old_docs/API_docs_v40/methods/messages_search.md @@ -13,13 +13,13 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,19 +27,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -90,3 +77,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v40/methods/messages_sendBroadcast.md b/old_docs/API_docs_v40/methods/messages_sendBroadcast.md index 6cff8b29..8eca8090 100644 --- a/old_docs/API_docs_v40/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v40/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v40/methods/messages_sendEncrypted.md b/old_docs/API_docs_v40/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v40/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v40/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v40/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v40/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v40/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v40/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v40/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v40/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v40/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v40/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v40/methods/messages_sendMedia.md b/old_docs/API_docs_v40/methods/messages_sendMedia.md index 552a60d0..2ddcd120 100644 --- a/old_docs/API_docs_v40/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v40/methods/messages_sendMedia.md @@ -13,9 +13,9 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -23,34 +23,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -108,3 +80,31 @@ Updates = messages.sendMedia({peer=InputPeer, reply_to_msg_id=int, media=InputMe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v40/methods/messages_sendMessage.md b/old_docs/API_docs_v40/methods/messages_sendMessage.md index 494f9871..14e2c75f 100644 --- a/old_docs/API_docs_v40/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v40/methods/messages_sendMessage.md @@ -13,10 +13,10 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,33 +25,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -139,3 +112,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v40/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v40/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v40/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v40/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v40/methods/messages_setTyping.md b/old_docs/API_docs_v40/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v40/methods/messages_setTyping.md +++ b/old_docs/API_docs_v40/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v40/methods/messages_startBot.md b/old_docs/API_docs_v40/methods/messages_startBot.md index 82054827..8105a214 100644 --- a/old_docs/API_docs_v40/methods/messages_startBot.md +++ b/old_docs/API_docs_v40/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Chat ID| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, chat_id=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v40/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v40/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v40/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v40/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v40/methods/photos_getUserPhotos.md b/old_docs/API_docs_v40/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v40/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v40/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v40/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v40/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v40/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v40/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v40/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v40/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v40/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v40/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v40/methods/users_getUsers.md b/old_docs/API_docs_v40/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v40/methods/users_getUsers.md +++ b/old_docs/API_docs_v40/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v41/methods/account_changePhone.md b/old_docs/API_docs_v41/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v41/methods/account_changePhone.md +++ b/old_docs/API_docs_v41/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v41/methods/account_checkUsername.md b/old_docs/API_docs_v41/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v41/methods/account_checkUsername.md +++ b/old_docs/API_docs_v41/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v41/methods/account_deleteAccount.md b/old_docs/API_docs_v41/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v41/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v41/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/account_getNotifySettings.md b/old_docs/API_docs_v41/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v41/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v41/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v41/methods/account_getPasswordSettings.md b/old_docs/API_docs_v41/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v41/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v41/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v41/methods/account_getPrivacy.md b/old_docs/API_docs_v41/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v41/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v41/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v41/methods/account_registerDevice.md b/old_docs/API_docs_v41/methods/account_registerDevice.md index 8dae7506..a69b58ff 100644 --- a/old_docs/API_docs_v41/methods/account_registerDevice.md +++ b/old_docs/API_docs_v41/methods/account_registerDevice.md @@ -12,13 +12,13 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [Bool](../types/Bool.md) @@ -26,13 +26,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -81,3 +74,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v41/methods/account_resetAuthorization.md b/old_docs/API_docs_v41/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v41/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v41/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v41/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v41/methods/account_sendChangePhoneCode.md index 930e0f76..181e817f 100644 --- a/old_docs/API_docs_v41/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v41/methods/account_sendChangePhoneCode.md @@ -12,7 +12,7 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| +|phone\_number|[string](../types/string.md) | Yes|New phone number| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) @@ -20,13 +20,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_SentChangePhoneCode = account.sendChangePhoneCode({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v41/methods/account_setAccountTTL.md b/old_docs/API_docs_v41/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v41/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v41/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v41/methods/account_setPrivacy.md b/old_docs/API_docs_v41/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v41/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v41/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v41/methods/account_unregisterDevice.md b/old_docs/API_docs_v41/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v41/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v41/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v41/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v41/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v41/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v41/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/account_updateNotifySettings.md b/old_docs/API_docs_v41/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v41/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v41/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v41/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v41/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v41/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v41/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v41/methods/account_updateProfile.md b/old_docs/API_docs_v41/methods/account_updateProfile.md index caea3391..67ceb92e 100644 --- a/old_docs/API_docs_v41/methods/account_updateProfile.md +++ b/old_docs/API_docs_v41/methods/account_updateProfile.md @@ -12,8 +12,8 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Yes|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Yes|The last name| +|first\_name|[string](../types/string.md) | Yes|The first name| +|last\_name|[string](../types/string.md) | Yes|The last name| ### Return type: [User](../types/User.md) @@ -21,14 +21,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v41/methods/account_updateStatus.md b/old_docs/API_docs_v41/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v41/methods/account_updateStatus.md +++ b/old_docs/API_docs_v41/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v41/methods/account_updateUsername.md b/old_docs/API_docs_v41/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v41/methods/account_updateUsername.md +++ b/old_docs/API_docs_v41/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v41/methods/auth_checkPhone.md b/old_docs/API_docs_v41/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v41/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v41/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v41/methods/auth_recoverPassword.md b/old_docs/API_docs_v41/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v41/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v41/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v41/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v41/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v41/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v41/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v41/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v41/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v41/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v41/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v41/methods/auth_sendCall.md b/old_docs/API_docs_v41/methods/auth_sendCall.md index 5947cda7..2f56038d 100644 --- a/old_docs/API_docs_v41/methods/auth_sendCall.md +++ b/old_docs/API_docs_v41/methods/auth_sendCall.md @@ -12,8 +12,8 @@ Send verification phone call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/auth_sendInvites.md b/old_docs/API_docs_v41/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v41/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v41/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v41/methods/auth_sendSms.md b/old_docs/API_docs_v41/methods/auth_sendSms.md index 41340660..38be5985 100644 --- a/old_docs/API_docs_v41/methods/auth_sendSms.md +++ b/old_docs/API_docs_v41/methods/auth_sendSms.md @@ -12,8 +12,8 @@ Send SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code ash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/channels_checkUsername.md b/old_docs/API_docs_v41/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v41/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v41/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v41/methods/channels_createChannel.md b/old_docs/API_docs_v41/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v41/methods/channels_createChannel.md +++ b/old_docs/API_docs_v41/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v41/methods/channels_deleteChannel.md b/old_docs/API_docs_v41/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v41/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v41/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v41/methods/channels_deleteMessages.md b/old_docs/API_docs_v41/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v41/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v41/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v41/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v41/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v41/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v41/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v41/methods/channels_editAbout.md b/old_docs/API_docs_v41/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v41/methods/channels_editAbout.md +++ b/old_docs/API_docs_v41/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v41/methods/channels_editAdmin.md b/old_docs/API_docs_v41/methods/channels_editAdmin.md index 9f69c065..8d6d4901 100644 --- a/old_docs/API_docs_v41/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v41/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| ### Return type: [Bool](../types/Bool.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Bool = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v41/methods/channels_editPhoto.md b/old_docs/API_docs_v41/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v41/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v41/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v41/methods/channels_editTitle.md b/old_docs/API_docs_v41/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v41/methods/channels_editTitle.md +++ b/old_docs/API_docs_v41/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v41/methods/channels_exportInvite.md b/old_docs/API_docs_v41/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v41/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v41/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v41/methods/channels_getChannels.md b/old_docs/API_docs_v41/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v41/methods/channels_getChannels.md +++ b/old_docs/API_docs_v41/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v41/methods/channels_getDialogs.md b/old_docs/API_docs_v41/methods/channels_getDialogs.md index 1b5837b7..563b798b 100644 --- a/old_docs/API_docs_v41/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v41/methods/channels_getDialogs.md @@ -12,8 +12,8 @@ Get channel dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v41/methods/channels_getImportantHistory.md b/old_docs/API_docs_v41/methods/channels_getImportantHistory.md index 861e4a32..43cdd5b9 100644 --- a/old_docs/API_docs_v41/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v41/methods/channels_getImportantHistory.md @@ -13,11 +13,11 @@ Get important channel/supergroup history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID| +|offset\_id|[int](../types/int.md) | Yes|Message ID offset| +|add\_offset|[int](../types/int.md) | Yes|Additional offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v41/methods/channels_getMessages.md b/old_docs/API_docs_v41/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v41/methods/channels_getMessages.md +++ b/old_docs/API_docs_v41/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v41/methods/channels_getParticipant.md b/old_docs/API_docs_v41/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v41/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v41/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v41/methods/channels_getParticipants.md b/old_docs/API_docs_v41/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v41/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v41/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v41/methods/channels_inviteToChannel.md b/old_docs/API_docs_v41/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v41/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v41/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v41/methods/channels_joinChannel.md b/old_docs/API_docs_v41/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v41/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v41/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v41/methods/channels_kickFromChannel.md b/old_docs/API_docs_v41/methods/channels_kickFromChannel.md index 8f6c92be..0c6c0258 100644 --- a/old_docs/API_docs_v41/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v41/methods/channels_kickFromChannel.md @@ -14,7 +14,7 @@ Kick user from channel |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick| -|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|Kick or unkick?| +|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/channels_leaveChannel.md b/old_docs/API_docs_v41/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v41/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v41/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v41/methods/channels_readHistory.md b/old_docs/API_docs_v41/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v41/methods/channels_readHistory.md +++ b/old_docs/API_docs_v41/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v41/methods/channels_reportSpam.md b/old_docs/API_docs_v41/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v41/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v41/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v41/methods/channels_toggleComments.md b/old_docs/API_docs_v41/methods/channels_toggleComments.md index cc9f478d..3f52496b 100644 --- a/old_docs/API_docs_v41/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v41/methods/channels_toggleComments.md @@ -13,7 +13,7 @@ Enable channel comments | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable comments| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/channels_updateUsername.md b/old_docs/API_docs_v41/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v41/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v41/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v41/methods/contacts_block.md b/old_docs/API_docs_v41/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v41/methods/contacts_block.md +++ b/old_docs/API_docs_v41/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v41/methods/contacts_deleteContact.md b/old_docs/API_docs_v41/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v41/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v41/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v41/methods/contacts_deleteContacts.md b/old_docs/API_docs_v41/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v41/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v41/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v41/methods/contacts_getBlocked.md b/old_docs/API_docs_v41/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v41/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v41/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v41/methods/contacts_getContacts.md b/old_docs/API_docs_v41/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v41/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v41/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v41/methods/contacts_getSuggested.md b/old_docs/API_docs_v41/methods/contacts_getSuggested.md index 1ce04bef..1dba94e1 100644 --- a/old_docs/API_docs_v41/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v41/methods/contacts_getSuggested.md @@ -12,7 +12,7 @@ Get suggested contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v41/methods/contacts_importCard.md b/old_docs/API_docs_v41/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v41/methods/contacts_importCard.md +++ b/old_docs/API_docs_v41/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v41/methods/contacts_importContacts.md b/old_docs/API_docs_v41/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v41/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v41/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v41/methods/contacts_search.md b/old_docs/API_docs_v41/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v41/methods/contacts_search.md +++ b/old_docs/API_docs_v41/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v41/methods/contacts_unblock.md b/old_docs/API_docs_v41/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v41/methods/contacts_unblock.md +++ b/old_docs/API_docs_v41/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v41/methods/help_getAppChangelog.md b/old_docs/API_docs_v41/methods/help_getAppChangelog.md index eb48fabb..f2d8c2ef 100644 --- a/old_docs/API_docs_v41/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v41/methods/help_getAppChangelog.md @@ -12,10 +12,10 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v41/methods/help_getAppUpdate.md b/old_docs/API_docs_v41/methods/help_getAppUpdate.md index ad5b8228..ce84843d 100644 --- a/old_docs/API_docs_v41/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v41/methods/help_getAppUpdate.md @@ -12,10 +12,10 @@ Get info about app updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Langauge code| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v41/methods/help_getConfig.md b/old_docs/API_docs_v41/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v41/methods/help_getConfig.md +++ b/old_docs/API_docs_v41/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v41/methods/help_getInviteText.md b/old_docs/API_docs_v41/methods/help_getInviteText.md index ad6ac262..9b82d55d 100644 --- a/old_docs/API_docs_v41/methods/help_getInviteText.md +++ b/old_docs/API_docs_v41/methods/help_getInviteText.md @@ -12,7 +12,7 @@ Get invitation text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language| +|lang\_code|[string](../types/string.md) | Yes|Language| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v41/methods/help_saveAppLog.md b/old_docs/API_docs_v41/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v41/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v41/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/initConnection.md b/old_docs/API_docs_v41/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v41/methods/initConnection.md +++ b/old_docs/API_docs_v41/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v41/methods/invokeAfterMsg.md b/old_docs/API_docs_v41/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v41/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v41/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v41/methods/invokeAfterMsgs.md b/old_docs/API_docs_v41/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v41/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v41/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v41/methods/invokeWithLayer.md b/old_docs/API_docs_v41/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v41/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v41/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v41/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v41/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v41/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v41/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v41/methods/messages_addChatUser.md b/old_docs/API_docs_v41/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v41/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v41/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v41/methods/messages_checkChatInvite.md b/old_docs/API_docs_v41/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v41/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v41/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_createChat.md b/old_docs/API_docs_v41/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v41/methods/messages_createChat.md +++ b/old_docs/API_docs_v41/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v41/methods/messages_deactivateChat.md b/old_docs/API_docs_v41/methods/messages_deactivateChat.md index c4bab810..34055ba4 100644 --- a/old_docs/API_docs_v41/methods/messages_deactivateChat.md +++ b/old_docs/API_docs_v41/methods/messages_deactivateChat.md @@ -13,7 +13,7 @@ Deactivate chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to deactivate| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Activate or deactivate?| +|enabled|[Bool](../types/Bool.md) | Yes|Activate or deactivate?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_deleteChatUser.md b/old_docs/API_docs_v41/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v41/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v41/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v41/methods/messages_deleteHistory.md b/old_docs/API_docs_v41/methods/messages_deleteHistory.md index 4cb70ec8..86f83b4b 100644 --- a/old_docs/API_docs_v41/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v41/methods/messages_deleteHistory.md @@ -13,7 +13,7 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -21,13 +21,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_deleteMessages.md b/old_docs/API_docs_v41/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v41/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v41/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v41/methods/messages_editChatAdmin.md b/old_docs/API_docs_v41/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v41/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v41/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_editChatPhoto.md b/old_docs/API_docs_v41/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v41/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v41/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_editChatTitle.md b/old_docs/API_docs_v41/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v41/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v41/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_exportChatInvite.md b/old_docs/API_docs_v41/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v41/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v41/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_forwardMessage.md b/old_docs/API_docs_v41/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v41/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v41/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v41/methods/messages_forwardMessages.md b/old_docs/API_docs_v41/methods/messages_forwardMessages.md index 6a646f5f..3a85b995 100644 --- a/old_docs/API_docs_v41/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v41/methods/messages_forwardMessages.md @@ -12,9 +12,9 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -23,34 +23,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -102,3 +74,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({broadcast=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v41/methods/messages_getAllStickers.md b/old_docs/API_docs_v41/methods/messages_getAllStickers.md index 322f9b0b..3a8a66d1 100644 --- a/old_docs/API_docs_v41/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v41/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|Previously fetched stickers| +|hash|[string](../types/string.md) | Yes|Previously fetched stickers| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v41/methods/messages_getChats.md b/old_docs/API_docs_v41/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v41/methods/messages_getChats.md +++ b/old_docs/API_docs_v41/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_getDialogs.md b/old_docs/API_docs_v41/methods/messages_getDialogs.md index 269c6897..a6e1c610 100644 --- a/old_docs/API_docs_v41/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v41/methods/messages_getDialogs.md @@ -12,8 +12,8 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -21,16 +21,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v41/methods/messages_getHistory.md b/old_docs/API_docs_v41/methods/messages_getHistory.md index dfefb639..cc438ce2 100644 --- a/old_docs/API_docs_v41/methods/messages_getHistory.md +++ b/old_docs/API_docs_v41/methods/messages_getHistory.md @@ -13,11 +13,11 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -25,18 +25,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -83,3 +71,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v41/methods/messages_getMessages.md b/old_docs/API_docs_v41/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v41/methods/messages_getMessages.md +++ b/old_docs/API_docs_v41/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v41/methods/messages_getMessagesViews.md b/old_docs/API_docs_v41/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v41/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v41/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_getStickerSet.md b/old_docs/API_docs_v41/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v41/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v41/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_getStickers.md b/old_docs/API_docs_v41/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v41/methods/messages_getStickers.md +++ b/old_docs/API_docs_v41/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v41/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v41/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v41/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v41/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v41/methods/messages_importChatInvite.md b/old_docs/API_docs_v41/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v41/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v41/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v41/methods/messages_installStickerSet.md b/old_docs/API_docs_v41/methods/messages_installStickerSet.md index 77c5a2a5..c807ba66 100644 --- a/old_docs/API_docs_v41/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v41/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|Disable stickerset?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.installStickerSet({stickerset=InputStickerSet, disabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_migrateChat.md b/old_docs/API_docs_v41/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v41/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v41/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v41/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v41/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v41/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v41/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v41/methods/messages_readHistory.md b/old_docs/API_docs_v41/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v41/methods/messages_readHistory.md +++ b/old_docs/API_docs_v41/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v41/methods/messages_readMessageContents.md b/old_docs/API_docs_v41/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v41/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v41/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v41/methods/messages_receivedMessages.md b/old_docs/API_docs_v41/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v41/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v41/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v41/methods/messages_reportSpam.md b/old_docs/API_docs_v41/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v41/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v41/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_search.md b/old_docs/API_docs_v41/methods/messages_search.md index 01af8760..42b9e947 100644 --- a/old_docs/API_docs_v41/methods/messages_search.md +++ b/old_docs/API_docs_v41/methods/messages_search.md @@ -12,15 +12,15 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|important\_only|[CLICK ME Bool](../types/Bool.md) | Optional|Show only important messages| +|important\_only|[Bool](../types/Bool.md) | Optional|Show only important messages| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -28,19 +28,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -93,3 +80,16 @@ Or, if you're into Lua: messages_Messages = messages.search({important_only=Bool, peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_searchGlobal.md b/old_docs/API_docs_v41/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v41/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v41/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v41/methods/messages_sendBroadcast.md b/old_docs/API_docs_v41/methods/messages_sendBroadcast.md index 6cff8b29..8eca8090 100644 --- a/old_docs/API_docs_v41/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v41/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v41/methods/messages_sendEncrypted.md b/old_docs/API_docs_v41/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v41/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v41/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v41/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v41/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v41/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v41/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v41/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v41/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v41/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v41/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v41/methods/messages_sendMedia.md b/old_docs/API_docs_v41/methods/messages_sendMedia.md index 694ccc4b..d6ec806e 100644 --- a/old_docs/API_docs_v41/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v41/methods/messages_sendMedia.md @@ -12,11 +12,11 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -24,34 +24,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -111,3 +83,31 @@ Updates = messages.sendMedia({broadcast=Bool, peer=InputPeer, reply_to_msg_id=in You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v41/methods/messages_sendMessage.md b/old_docs/API_docs_v41/methods/messages_sendMessage.md index 0c3ef389..a4845a78 100644 --- a/old_docs/API_docs_v41/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v41/methods/messages_sendMessage.md @@ -12,13 +12,13 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -27,33 +27,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -141,3 +114,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v41/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v41/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v41/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v41/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_setTyping.md b/old_docs/API_docs_v41/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v41/methods/messages_setTyping.md +++ b/old_docs/API_docs_v41/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v41/methods/messages_startBot.md b/old_docs/API_docs_v41/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v41/methods/messages_startBot.md +++ b/old_docs/API_docs_v41/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v41/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v41/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v41/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v41/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v41/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v41/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v41/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v41/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v41/methods/photos_getUserPhotos.md b/old_docs/API_docs_v41/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v41/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v41/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v41/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v41/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v41/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v41/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v41/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v41/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v41/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v41/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v41/methods/users_getUsers.md b/old_docs/API_docs_v41/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v41/methods/users_getUsers.md +++ b/old_docs/API_docs_v41/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v42/methods/account_changePhone.md b/old_docs/API_docs_v42/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v42/methods/account_changePhone.md +++ b/old_docs/API_docs_v42/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v42/methods/account_checkUsername.md b/old_docs/API_docs_v42/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v42/methods/account_checkUsername.md +++ b/old_docs/API_docs_v42/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v42/methods/account_deleteAccount.md b/old_docs/API_docs_v42/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v42/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v42/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/account_getNotifySettings.md b/old_docs/API_docs_v42/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v42/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v42/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v42/methods/account_getPasswordSettings.md b/old_docs/API_docs_v42/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v42/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v42/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v42/methods/account_getPrivacy.md b/old_docs/API_docs_v42/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v42/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v42/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v42/methods/account_registerDevice.md b/old_docs/API_docs_v42/methods/account_registerDevice.md index 8dae7506..a69b58ff 100644 --- a/old_docs/API_docs_v42/methods/account_registerDevice.md +++ b/old_docs/API_docs_v42/methods/account_registerDevice.md @@ -12,13 +12,13 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [Bool](../types/Bool.md) @@ -26,13 +26,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -81,3 +74,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v42/methods/account_resetAuthorization.md b/old_docs/API_docs_v42/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v42/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v42/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v42/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v42/methods/account_sendChangePhoneCode.md index 930e0f76..181e817f 100644 --- a/old_docs/API_docs_v42/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v42/methods/account_sendChangePhoneCode.md @@ -12,7 +12,7 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| +|phone\_number|[string](../types/string.md) | Yes|New phone number| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) @@ -20,13 +20,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_SentChangePhoneCode = account.sendChangePhoneCode({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v42/methods/account_setAccountTTL.md b/old_docs/API_docs_v42/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v42/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v42/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v42/methods/account_setPrivacy.md b/old_docs/API_docs_v42/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v42/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v42/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v42/methods/account_unregisterDevice.md b/old_docs/API_docs_v42/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v42/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v42/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v42/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v42/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v42/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v42/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/account_updateNotifySettings.md b/old_docs/API_docs_v42/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v42/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v42/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v42/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v42/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v42/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v42/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v42/methods/account_updateProfile.md b/old_docs/API_docs_v42/methods/account_updateProfile.md index caea3391..67ceb92e 100644 --- a/old_docs/API_docs_v42/methods/account_updateProfile.md +++ b/old_docs/API_docs_v42/methods/account_updateProfile.md @@ -12,8 +12,8 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Yes|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Yes|The last name| +|first\_name|[string](../types/string.md) | Yes|The first name| +|last\_name|[string](../types/string.md) | Yes|The last name| ### Return type: [User](../types/User.md) @@ -21,14 +21,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v42/methods/account_updateStatus.md b/old_docs/API_docs_v42/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v42/methods/account_updateStatus.md +++ b/old_docs/API_docs_v42/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v42/methods/account_updateUsername.md b/old_docs/API_docs_v42/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v42/methods/account_updateUsername.md +++ b/old_docs/API_docs_v42/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v42/methods/auth_checkPhone.md b/old_docs/API_docs_v42/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v42/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v42/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v42/methods/auth_recoverPassword.md b/old_docs/API_docs_v42/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v42/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v42/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v42/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v42/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v42/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v42/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v42/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v42/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v42/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v42/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v42/methods/auth_sendCall.md b/old_docs/API_docs_v42/methods/auth_sendCall.md index 5947cda7..2f56038d 100644 --- a/old_docs/API_docs_v42/methods/auth_sendCall.md +++ b/old_docs/API_docs_v42/methods/auth_sendCall.md @@ -12,8 +12,8 @@ Send verification phone call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/auth_sendInvites.md b/old_docs/API_docs_v42/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v42/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v42/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v42/methods/auth_sendSms.md b/old_docs/API_docs_v42/methods/auth_sendSms.md index 41340660..38be5985 100644 --- a/old_docs/API_docs_v42/methods/auth_sendSms.md +++ b/old_docs/API_docs_v42/methods/auth_sendSms.md @@ -12,8 +12,8 @@ Send SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code ash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/channels_checkUsername.md b/old_docs/API_docs_v42/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v42/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v42/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v42/methods/channels_createChannel.md b/old_docs/API_docs_v42/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v42/methods/channels_createChannel.md +++ b/old_docs/API_docs_v42/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v42/methods/channels_deleteChannel.md b/old_docs/API_docs_v42/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v42/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v42/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v42/methods/channels_deleteMessages.md b/old_docs/API_docs_v42/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v42/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v42/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v42/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v42/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v42/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v42/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v42/methods/channels_editAbout.md b/old_docs/API_docs_v42/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v42/methods/channels_editAbout.md +++ b/old_docs/API_docs_v42/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v42/methods/channels_editAdmin.md b/old_docs/API_docs_v42/methods/channels_editAdmin.md index 7b6cc0f1..62f1fdaa 100644 --- a/old_docs/API_docs_v42/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v42/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v42/methods/channels_editPhoto.md b/old_docs/API_docs_v42/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v42/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v42/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v42/methods/channels_editTitle.md b/old_docs/API_docs_v42/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v42/methods/channels_editTitle.md +++ b/old_docs/API_docs_v42/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v42/methods/channels_exportInvite.md b/old_docs/API_docs_v42/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v42/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v42/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v42/methods/channels_getChannels.md b/old_docs/API_docs_v42/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v42/methods/channels_getChannels.md +++ b/old_docs/API_docs_v42/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v42/methods/channels_getDialogs.md b/old_docs/API_docs_v42/methods/channels_getDialogs.md index 1b5837b7..563b798b 100644 --- a/old_docs/API_docs_v42/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v42/methods/channels_getDialogs.md @@ -12,8 +12,8 @@ Get channel dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v42/methods/channels_getImportantHistory.md b/old_docs/API_docs_v42/methods/channels_getImportantHistory.md index 861e4a32..43cdd5b9 100644 --- a/old_docs/API_docs_v42/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v42/methods/channels_getImportantHistory.md @@ -13,11 +13,11 @@ Get important channel/supergroup history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID| +|offset\_id|[int](../types/int.md) | Yes|Message ID offset| +|add\_offset|[int](../types/int.md) | Yes|Additional offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v42/methods/channels_getMessages.md b/old_docs/API_docs_v42/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v42/methods/channels_getMessages.md +++ b/old_docs/API_docs_v42/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v42/methods/channels_getParticipant.md b/old_docs/API_docs_v42/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v42/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v42/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v42/methods/channels_getParticipants.md b/old_docs/API_docs_v42/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v42/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v42/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v42/methods/channels_inviteToChannel.md b/old_docs/API_docs_v42/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v42/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v42/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v42/methods/channels_joinChannel.md b/old_docs/API_docs_v42/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v42/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v42/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v42/methods/channels_kickFromChannel.md b/old_docs/API_docs_v42/methods/channels_kickFromChannel.md index 8f6c92be..0c6c0258 100644 --- a/old_docs/API_docs_v42/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v42/methods/channels_kickFromChannel.md @@ -14,7 +14,7 @@ Kick user from channel |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick| -|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|Kick or unkick?| +|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/channels_leaveChannel.md b/old_docs/API_docs_v42/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v42/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v42/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v42/methods/channels_readHistory.md b/old_docs/API_docs_v42/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v42/methods/channels_readHistory.md +++ b/old_docs/API_docs_v42/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v42/methods/channels_reportSpam.md b/old_docs/API_docs_v42/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v42/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v42/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v42/methods/channels_toggleComments.md b/old_docs/API_docs_v42/methods/channels_toggleComments.md index cc9f478d..3f52496b 100644 --- a/old_docs/API_docs_v42/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v42/methods/channels_toggleComments.md @@ -13,7 +13,7 @@ Enable channel comments | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable comments| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/channels_updateUsername.md b/old_docs/API_docs_v42/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v42/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v42/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v42/methods/contacts_block.md b/old_docs/API_docs_v42/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v42/methods/contacts_block.md +++ b/old_docs/API_docs_v42/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v42/methods/contacts_deleteContact.md b/old_docs/API_docs_v42/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v42/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v42/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v42/methods/contacts_deleteContacts.md b/old_docs/API_docs_v42/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v42/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v42/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v42/methods/contacts_getBlocked.md b/old_docs/API_docs_v42/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v42/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v42/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v42/methods/contacts_getContacts.md b/old_docs/API_docs_v42/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v42/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v42/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v42/methods/contacts_getSuggested.md b/old_docs/API_docs_v42/methods/contacts_getSuggested.md index 1ce04bef..1dba94e1 100644 --- a/old_docs/API_docs_v42/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v42/methods/contacts_getSuggested.md @@ -12,7 +12,7 @@ Get suggested contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v42/methods/contacts_importCard.md b/old_docs/API_docs_v42/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v42/methods/contacts_importCard.md +++ b/old_docs/API_docs_v42/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v42/methods/contacts_importContacts.md b/old_docs/API_docs_v42/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v42/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v42/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v42/methods/contacts_search.md b/old_docs/API_docs_v42/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v42/methods/contacts_search.md +++ b/old_docs/API_docs_v42/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v42/methods/contacts_unblock.md b/old_docs/API_docs_v42/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v42/methods/contacts_unblock.md +++ b/old_docs/API_docs_v42/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v42/methods/help_getAppChangelog.md b/old_docs/API_docs_v42/methods/help_getAppChangelog.md index eb48fabb..f2d8c2ef 100644 --- a/old_docs/API_docs_v42/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v42/methods/help_getAppChangelog.md @@ -12,10 +12,10 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v42/methods/help_getAppUpdate.md b/old_docs/API_docs_v42/methods/help_getAppUpdate.md index ad5b8228..ce84843d 100644 --- a/old_docs/API_docs_v42/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v42/methods/help_getAppUpdate.md @@ -12,10 +12,10 @@ Get info about app updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Langauge code| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v42/methods/help_getConfig.md b/old_docs/API_docs_v42/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v42/methods/help_getConfig.md +++ b/old_docs/API_docs_v42/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v42/methods/help_getInviteText.md b/old_docs/API_docs_v42/methods/help_getInviteText.md index ad6ac262..9b82d55d 100644 --- a/old_docs/API_docs_v42/methods/help_getInviteText.md +++ b/old_docs/API_docs_v42/methods/help_getInviteText.md @@ -12,7 +12,7 @@ Get invitation text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language| +|lang\_code|[string](../types/string.md) | Yes|Language| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v42/methods/help_saveAppLog.md b/old_docs/API_docs_v42/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v42/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v42/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/initConnection.md b/old_docs/API_docs_v42/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v42/methods/initConnection.md +++ b/old_docs/API_docs_v42/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v42/methods/invokeAfterMsg.md b/old_docs/API_docs_v42/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v42/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v42/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v42/methods/invokeAfterMsgs.md b/old_docs/API_docs_v42/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v42/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v42/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v42/methods/invokeWithLayer.md b/old_docs/API_docs_v42/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v42/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v42/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v42/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v42/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v42/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v42/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v42/methods/messages_addChatUser.md b/old_docs/API_docs_v42/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v42/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v42/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v42/methods/messages_checkChatInvite.md b/old_docs/API_docs_v42/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v42/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v42/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_createChat.md b/old_docs/API_docs_v42/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v42/methods/messages_createChat.md +++ b/old_docs/API_docs_v42/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v42/methods/messages_deleteChatUser.md b/old_docs/API_docs_v42/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v42/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v42/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v42/methods/messages_deleteHistory.md b/old_docs/API_docs_v42/methods/messages_deleteHistory.md index 4cb70ec8..86f83b4b 100644 --- a/old_docs/API_docs_v42/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v42/methods/messages_deleteHistory.md @@ -13,7 +13,7 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -21,13 +21,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_deleteMessages.md b/old_docs/API_docs_v42/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v42/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v42/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v42/methods/messages_editChatAdmin.md b/old_docs/API_docs_v42/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v42/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v42/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_editChatPhoto.md b/old_docs/API_docs_v42/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v42/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v42/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_editChatTitle.md b/old_docs/API_docs_v42/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v42/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v42/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_exportChatInvite.md b/old_docs/API_docs_v42/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v42/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v42/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_forwardMessage.md b/old_docs/API_docs_v42/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v42/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v42/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v42/methods/messages_forwardMessages.md b/old_docs/API_docs_v42/methods/messages_forwardMessages.md index 6a646f5f..3a85b995 100644 --- a/old_docs/API_docs_v42/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v42/methods/messages_forwardMessages.md @@ -12,9 +12,9 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -23,34 +23,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -102,3 +74,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({broadcast=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v42/methods/messages_getAllStickers.md b/old_docs/API_docs_v42/methods/messages_getAllStickers.md index 322f9b0b..3a8a66d1 100644 --- a/old_docs/API_docs_v42/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v42/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|Previously fetched stickers| +|hash|[string](../types/string.md) | Yes|Previously fetched stickers| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v42/methods/messages_getChats.md b/old_docs/API_docs_v42/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v42/methods/messages_getChats.md +++ b/old_docs/API_docs_v42/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_getDialogs.md b/old_docs/API_docs_v42/methods/messages_getDialogs.md index bd3ef681..623f002a 100644 --- a/old_docs/API_docs_v42/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v42/methods/messages_getDialogs.md @@ -12,10 +12,10 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -23,16 +23,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v42/methods/messages_getHistory.md b/old_docs/API_docs_v42/methods/messages_getHistory.md index dfefb639..cc438ce2 100644 --- a/old_docs/API_docs_v42/methods/messages_getHistory.md +++ b/old_docs/API_docs_v42/methods/messages_getHistory.md @@ -13,11 +13,11 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -25,18 +25,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -83,3 +71,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v42/methods/messages_getMessages.md b/old_docs/API_docs_v42/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v42/methods/messages_getMessages.md +++ b/old_docs/API_docs_v42/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v42/methods/messages_getMessagesViews.md b/old_docs/API_docs_v42/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v42/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v42/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_getStickerSet.md b/old_docs/API_docs_v42/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v42/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v42/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_getStickers.md b/old_docs/API_docs_v42/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v42/methods/messages_getStickers.md +++ b/old_docs/API_docs_v42/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v42/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v42/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v42/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v42/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v42/methods/messages_importChatInvite.md b/old_docs/API_docs_v42/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v42/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v42/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v42/methods/messages_installStickerSet.md b/old_docs/API_docs_v42/methods/messages_installStickerSet.md index 77c5a2a5..c807ba66 100644 --- a/old_docs/API_docs_v42/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v42/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|Disable stickerset?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.installStickerSet({stickerset=InputStickerSet, disabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_migrateChat.md b/old_docs/API_docs_v42/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v42/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v42/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v42/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v42/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v42/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v42/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v42/methods/messages_readHistory.md b/old_docs/API_docs_v42/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v42/methods/messages_readHistory.md +++ b/old_docs/API_docs_v42/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v42/methods/messages_readMessageContents.md b/old_docs/API_docs_v42/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v42/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v42/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v42/methods/messages_receivedMessages.md b/old_docs/API_docs_v42/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v42/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v42/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v42/methods/messages_reportSpam.md b/old_docs/API_docs_v42/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v42/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v42/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_search.md b/old_docs/API_docs_v42/methods/messages_search.md index 01af8760..42b9e947 100644 --- a/old_docs/API_docs_v42/methods/messages_search.md +++ b/old_docs/API_docs_v42/methods/messages_search.md @@ -12,15 +12,15 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|important\_only|[CLICK ME Bool](../types/Bool.md) | Optional|Show only important messages| +|important\_only|[Bool](../types/Bool.md) | Optional|Show only important messages| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -28,19 +28,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -93,3 +80,16 @@ Or, if you're into Lua: messages_Messages = messages.search({important_only=Bool, peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_searchGlobal.md b/old_docs/API_docs_v42/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v42/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v42/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v42/methods/messages_sendBroadcast.md b/old_docs/API_docs_v42/methods/messages_sendBroadcast.md index 6cff8b29..8eca8090 100644 --- a/old_docs/API_docs_v42/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v42/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v42/methods/messages_sendEncrypted.md b/old_docs/API_docs_v42/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v42/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v42/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v42/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v42/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v42/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v42/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v42/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v42/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v42/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v42/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v42/methods/messages_sendMedia.md b/old_docs/API_docs_v42/methods/messages_sendMedia.md index 694ccc4b..d6ec806e 100644 --- a/old_docs/API_docs_v42/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v42/methods/messages_sendMedia.md @@ -12,11 +12,11 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -24,34 +24,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -111,3 +83,31 @@ Updates = messages.sendMedia({broadcast=Bool, peer=InputPeer, reply_to_msg_id=in You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v42/methods/messages_sendMessage.md b/old_docs/API_docs_v42/methods/messages_sendMessage.md index 0c3ef389..a4845a78 100644 --- a/old_docs/API_docs_v42/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v42/methods/messages_sendMessage.md @@ -12,13 +12,13 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -27,33 +27,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -141,3 +114,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v42/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v42/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v42/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v42/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_setTyping.md b/old_docs/API_docs_v42/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v42/methods/messages_setTyping.md +++ b/old_docs/API_docs_v42/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v42/methods/messages_startBot.md b/old_docs/API_docs_v42/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v42/methods/messages_startBot.md +++ b/old_docs/API_docs_v42/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v42/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v42/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v42/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v42/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v42/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v42/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v42/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v42/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v42/methods/photos_getUserPhotos.md b/old_docs/API_docs_v42/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v42/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v42/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v42/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v42/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v42/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v42/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v42/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v42/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v42/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v42/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v42/methods/users_getUsers.md b/old_docs/API_docs_v42/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v42/methods/users_getUsers.md +++ b/old_docs/API_docs_v42/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v44/methods/account_changePhone.md b/old_docs/API_docs_v44/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v44/methods/account_changePhone.md +++ b/old_docs/API_docs_v44/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_checkUsername.md b/old_docs/API_docs_v44/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v44/methods/account_checkUsername.md +++ b/old_docs/API_docs_v44/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v44/methods/account_deleteAccount.md b/old_docs/API_docs_v44/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v44/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v44/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/account_getNotifySettings.md b/old_docs/API_docs_v44/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v44/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v44/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_getPasswordSettings.md b/old_docs/API_docs_v44/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v44/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v44/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_getPrivacy.md b/old_docs/API_docs_v44/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v44/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v44/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_registerDevice.md b/old_docs/API_docs_v44/methods/account_registerDevice.md index 8dae7506..a69b58ff 100644 --- a/old_docs/API_docs_v44/methods/account_registerDevice.md +++ b/old_docs/API_docs_v44/methods/account_registerDevice.md @@ -12,13 +12,13 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [Bool](../types/Bool.md) @@ -26,13 +26,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -81,3 +74,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_reportPeer.md b/old_docs/API_docs_v44/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v44/methods/account_reportPeer.md +++ b/old_docs/API_docs_v44/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_resetAuthorization.md b/old_docs/API_docs_v44/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v44/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v44/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v44/methods/account_sendChangePhoneCode.md index 930e0f76..181e817f 100644 --- a/old_docs/API_docs_v44/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v44/methods/account_sendChangePhoneCode.md @@ -12,7 +12,7 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| +|phone\_number|[string](../types/string.md) | Yes|New phone number| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) @@ -20,13 +20,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_SentChangePhoneCode = account.sendChangePhoneCode({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_setAccountTTL.md b/old_docs/API_docs_v44/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v44/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v44/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_setPrivacy.md b/old_docs/API_docs_v44/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v44/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v44/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_unregisterDevice.md b/old_docs/API_docs_v44/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v44/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v44/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v44/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v44/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v44/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/account_updateNotifySettings.md b/old_docs/API_docs_v44/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v44/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v44/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v44/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v44/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v44/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_updateProfile.md b/old_docs/API_docs_v44/methods/account_updateProfile.md index caea3391..67ceb92e 100644 --- a/old_docs/API_docs_v44/methods/account_updateProfile.md +++ b/old_docs/API_docs_v44/methods/account_updateProfile.md @@ -12,8 +12,8 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Yes|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Yes|The last name| +|first\_name|[string](../types/string.md) | Yes|The first name| +|last\_name|[string](../types/string.md) | Yes|The last name| ### Return type: [User](../types/User.md) @@ -21,14 +21,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account_updateStatus.md b/old_docs/API_docs_v44/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v44/methods/account_updateStatus.md +++ b/old_docs/API_docs_v44/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v44/methods/account_updateUsername.md b/old_docs/API_docs_v44/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v44/methods/account_updateUsername.md +++ b/old_docs/API_docs_v44/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v44/methods/auth_checkPhone.md b/old_docs/API_docs_v44/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v44/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v44/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v44/methods/auth_recoverPassword.md b/old_docs/API_docs_v44/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v44/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v44/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v44/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v44/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v44/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v44/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v44/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v44/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v44/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v44/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v44/methods/auth_sendCall.md b/old_docs/API_docs_v44/methods/auth_sendCall.md index 5947cda7..2f56038d 100644 --- a/old_docs/API_docs_v44/methods/auth_sendCall.md +++ b/old_docs/API_docs_v44/methods/auth_sendCall.md @@ -12,8 +12,8 @@ Send verification phone call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/auth_sendInvites.md b/old_docs/API_docs_v44/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v44/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v44/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v44/methods/auth_sendSms.md b/old_docs/API_docs_v44/methods/auth_sendSms.md index 41340660..38be5985 100644 --- a/old_docs/API_docs_v44/methods/auth_sendSms.md +++ b/old_docs/API_docs_v44/methods/auth_sendSms.md @@ -12,8 +12,8 @@ Send SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code ash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/channels_checkUsername.md b/old_docs/API_docs_v44/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v44/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v44/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v44/methods/channels_createChannel.md b/old_docs/API_docs_v44/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v44/methods/channels_createChannel.md +++ b/old_docs/API_docs_v44/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v44/methods/channels_deleteChannel.md b/old_docs/API_docs_v44/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v44/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v44/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v44/methods/channels_deleteMessages.md b/old_docs/API_docs_v44/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v44/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v44/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v44/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v44/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v44/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v44/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v44/methods/channels_editAbout.md b/old_docs/API_docs_v44/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v44/methods/channels_editAbout.md +++ b/old_docs/API_docs_v44/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v44/methods/channels_editAdmin.md b/old_docs/API_docs_v44/methods/channels_editAdmin.md index 7b6cc0f1..62f1fdaa 100644 --- a/old_docs/API_docs_v44/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v44/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v44/methods/channels_editPhoto.md b/old_docs/API_docs_v44/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v44/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v44/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v44/methods/channels_editTitle.md b/old_docs/API_docs_v44/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v44/methods/channels_editTitle.md +++ b/old_docs/API_docs_v44/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v44/methods/channels_exportInvite.md b/old_docs/API_docs_v44/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v44/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v44/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v44/methods/channels_getChannels.md b/old_docs/API_docs_v44/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v44/methods/channels_getChannels.md +++ b/old_docs/API_docs_v44/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v44/methods/channels_getDialogs.md b/old_docs/API_docs_v44/methods/channels_getDialogs.md index 1b5837b7..563b798b 100644 --- a/old_docs/API_docs_v44/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v44/methods/channels_getDialogs.md @@ -12,8 +12,8 @@ Get channel dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v44/methods/channels_getImportantHistory.md b/old_docs/API_docs_v44/methods/channels_getImportantHistory.md index 861e4a32..43cdd5b9 100644 --- a/old_docs/API_docs_v44/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v44/methods/channels_getImportantHistory.md @@ -13,11 +13,11 @@ Get important channel/supergroup history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID| +|offset\_id|[int](../types/int.md) | Yes|Message ID offset| +|add\_offset|[int](../types/int.md) | Yes|Additional offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v44/methods/channels_getMessages.md b/old_docs/API_docs_v44/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v44/methods/channels_getMessages.md +++ b/old_docs/API_docs_v44/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v44/methods/channels_getParticipant.md b/old_docs/API_docs_v44/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v44/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v44/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v44/methods/channels_getParticipants.md b/old_docs/API_docs_v44/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v44/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v44/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v44/methods/channels_inviteToChannel.md b/old_docs/API_docs_v44/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v44/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v44/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v44/methods/channels_joinChannel.md b/old_docs/API_docs_v44/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v44/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v44/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v44/methods/channels_kickFromChannel.md b/old_docs/API_docs_v44/methods/channels_kickFromChannel.md index 8f6c92be..0c6c0258 100644 --- a/old_docs/API_docs_v44/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v44/methods/channels_kickFromChannel.md @@ -14,7 +14,7 @@ Kick user from channel |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick| -|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|Kick or unkick?| +|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/channels_leaveChannel.md b/old_docs/API_docs_v44/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v44/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v44/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v44/methods/channels_readHistory.md b/old_docs/API_docs_v44/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v44/methods/channels_readHistory.md +++ b/old_docs/API_docs_v44/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v44/methods/channels_reportSpam.md b/old_docs/API_docs_v44/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v44/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v44/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v44/methods/channels_toggleComments.md b/old_docs/API_docs_v44/methods/channels_toggleComments.md index cc9f478d..3f52496b 100644 --- a/old_docs/API_docs_v44/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v44/methods/channels_toggleComments.md @@ -13,7 +13,7 @@ Enable channel comments | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable comments| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/channels_updateUsername.md b/old_docs/API_docs_v44/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v44/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v44/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v44/methods/contacts_block.md b/old_docs/API_docs_v44/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v44/methods/contacts_block.md +++ b/old_docs/API_docs_v44/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v44/methods/contacts_deleteContact.md b/old_docs/API_docs_v44/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v44/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v44/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v44/methods/contacts_deleteContacts.md b/old_docs/API_docs_v44/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v44/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v44/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v44/methods/contacts_getBlocked.md b/old_docs/API_docs_v44/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v44/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v44/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v44/methods/contacts_getContacts.md b/old_docs/API_docs_v44/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v44/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v44/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v44/methods/contacts_getSuggested.md b/old_docs/API_docs_v44/methods/contacts_getSuggested.md index 1ce04bef..1dba94e1 100644 --- a/old_docs/API_docs_v44/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v44/methods/contacts_getSuggested.md @@ -12,7 +12,7 @@ Get suggested contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v44/methods/contacts_importCard.md b/old_docs/API_docs_v44/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v44/methods/contacts_importCard.md +++ b/old_docs/API_docs_v44/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v44/methods/contacts_importContacts.md b/old_docs/API_docs_v44/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v44/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v44/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v44/methods/contacts_search.md b/old_docs/API_docs_v44/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v44/methods/contacts_search.md +++ b/old_docs/API_docs_v44/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v44/methods/contacts_unblock.md b/old_docs/API_docs_v44/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v44/methods/contacts_unblock.md +++ b/old_docs/API_docs_v44/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v44/methods/help_getAppChangelog.md b/old_docs/API_docs_v44/methods/help_getAppChangelog.md index eb48fabb..f2d8c2ef 100644 --- a/old_docs/API_docs_v44/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v44/methods/help_getAppChangelog.md @@ -12,10 +12,10 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v44/methods/help_getAppUpdate.md b/old_docs/API_docs_v44/methods/help_getAppUpdate.md index ad5b8228..ce84843d 100644 --- a/old_docs/API_docs_v44/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v44/methods/help_getAppUpdate.md @@ -12,10 +12,10 @@ Get info about app updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Langauge code| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v44/methods/help_getConfig.md b/old_docs/API_docs_v44/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v44/methods/help_getConfig.md +++ b/old_docs/API_docs_v44/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v44/methods/help_getInviteText.md b/old_docs/API_docs_v44/methods/help_getInviteText.md index ad6ac262..9b82d55d 100644 --- a/old_docs/API_docs_v44/methods/help_getInviteText.md +++ b/old_docs/API_docs_v44/methods/help_getInviteText.md @@ -12,7 +12,7 @@ Get invitation text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language| +|lang\_code|[string](../types/string.md) | Yes|Language| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v44/methods/help_getTermsOfService.md b/old_docs/API_docs_v44/methods/help_getTermsOfService.md index 0936575e..44087504 100644 --- a/old_docs/API_docs_v44/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v44/methods/help_getTermsOfService.md @@ -12,7 +12,7 @@ Get terms of service | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v44/methods/help_saveAppLog.md b/old_docs/API_docs_v44/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v44/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v44/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/initConnection.md b/old_docs/API_docs_v44/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v44/methods/initConnection.md +++ b/old_docs/API_docs_v44/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v44/methods/invokeAfterMsg.md b/old_docs/API_docs_v44/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v44/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v44/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v44/methods/invokeAfterMsgs.md b/old_docs/API_docs_v44/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v44/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v44/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v44/methods/invokeWithLayer.md b/old_docs/API_docs_v44/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v44/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v44/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v44/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v44/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v44/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v44/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v44/methods/messages_addChatUser.md b/old_docs/API_docs_v44/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v44/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v44/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v44/methods/messages_checkChatInvite.md b/old_docs/API_docs_v44/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v44/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v44/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_createChat.md b/old_docs/API_docs_v44/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v44/methods/messages_createChat.md +++ b/old_docs/API_docs_v44/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v44/methods/messages_deleteChatUser.md b/old_docs/API_docs_v44/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v44/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v44/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v44/methods/messages_deleteHistory.md b/old_docs/API_docs_v44/methods/messages_deleteHistory.md index 4cb70ec8..86f83b4b 100644 --- a/old_docs/API_docs_v44/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v44/methods/messages_deleteHistory.md @@ -13,7 +13,7 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -21,13 +21,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_deleteMessages.md b/old_docs/API_docs_v44/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v44/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v44/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v44/methods/messages_editChatAdmin.md b/old_docs/API_docs_v44/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v44/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v44/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_editChatPhoto.md b/old_docs/API_docs_v44/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v44/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v44/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_editChatTitle.md b/old_docs/API_docs_v44/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v44/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v44/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_exportChatInvite.md b/old_docs/API_docs_v44/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v44/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v44/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_forwardMessage.md b/old_docs/API_docs_v44/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v44/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v44/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v44/methods/messages_forwardMessages.md b/old_docs/API_docs_v44/methods/messages_forwardMessages.md index 6a646f5f..3a85b995 100644 --- a/old_docs/API_docs_v44/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v44/methods/messages_forwardMessages.md @@ -12,9 +12,9 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -23,34 +23,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -102,3 +74,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({broadcast=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v44/methods/messages_getAllStickers.md b/old_docs/API_docs_v44/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v44/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v44/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v44/methods/messages_getChats.md b/old_docs/API_docs_v44/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v44/methods/messages_getChats.md +++ b/old_docs/API_docs_v44/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_getDialogs.md b/old_docs/API_docs_v44/methods/messages_getDialogs.md index bd3ef681..623f002a 100644 --- a/old_docs/API_docs_v44/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v44/methods/messages_getDialogs.md @@ -12,10 +12,10 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -23,16 +23,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v44/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v44/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v44/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v44/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_getHistory.md b/old_docs/API_docs_v44/methods/messages_getHistory.md index dfefb639..cc438ce2 100644 --- a/old_docs/API_docs_v44/methods/messages_getHistory.md +++ b/old_docs/API_docs_v44/methods/messages_getHistory.md @@ -13,11 +13,11 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -25,18 +25,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -83,3 +71,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v44/methods/messages_getMessages.md b/old_docs/API_docs_v44/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v44/methods/messages_getMessages.md +++ b/old_docs/API_docs_v44/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v44/methods/messages_getMessagesViews.md b/old_docs/API_docs_v44/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v44/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v44/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_getStickerSet.md b/old_docs/API_docs_v44/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v44/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v44/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_getStickers.md b/old_docs/API_docs_v44/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v44/methods/messages_getStickers.md +++ b/old_docs/API_docs_v44/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v44/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v44/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v44/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v44/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v44/methods/messages_importChatInvite.md b/old_docs/API_docs_v44/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v44/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v44/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v44/methods/messages_installStickerSet.md b/old_docs/API_docs_v44/methods/messages_installStickerSet.md index 77c5a2a5..c807ba66 100644 --- a/old_docs/API_docs_v44/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v44/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|Disable stickerset?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.installStickerSet({stickerset=InputStickerSet, disabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_migrateChat.md b/old_docs/API_docs_v44/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v44/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v44/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v44/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v44/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v44/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v44/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v44/methods/messages_readHistory.md b/old_docs/API_docs_v44/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v44/methods/messages_readHistory.md +++ b/old_docs/API_docs_v44/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v44/methods/messages_readMessageContents.md b/old_docs/API_docs_v44/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v44/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v44/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v44/methods/messages_receivedMessages.md b/old_docs/API_docs_v44/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v44/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v44/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v44/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v44/methods/messages_reorderStickerSets.md index 90913e5d..53930d4f 100644 --- a/old_docs/API_docs_v44/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v44/methods/messages_reorderStickerSets.md @@ -12,7 +12,7 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_reportSpam.md b/old_docs/API_docs_v44/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v44/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v44/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_search.md b/old_docs/API_docs_v44/methods/messages_search.md index 01af8760..42b9e947 100644 --- a/old_docs/API_docs_v44/methods/messages_search.md +++ b/old_docs/API_docs_v44/methods/messages_search.md @@ -12,15 +12,15 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|important\_only|[CLICK ME Bool](../types/Bool.md) | Optional|Show only important messages| +|important\_only|[Bool](../types/Bool.md) | Optional|Show only important messages| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -28,19 +28,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -93,3 +80,16 @@ Or, if you're into Lua: messages_Messages = messages.search({important_only=Bool, peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_searchGifs.md b/old_docs/API_docs_v44/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v44/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v44/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v44/methods/messages_searchGlobal.md b/old_docs/API_docs_v44/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v44/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v44/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v44/methods/messages_sendBroadcast.md b/old_docs/API_docs_v44/methods/messages_sendBroadcast.md index 6cff8b29..8eca8090 100644 --- a/old_docs/API_docs_v44/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v44/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v44/methods/messages_sendEncrypted.md b/old_docs/API_docs_v44/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v44/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v44/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v44/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v44/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v44/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v44/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v44/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v44/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v44/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v44/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v44/methods/messages_sendMedia.md b/old_docs/API_docs_v44/methods/messages_sendMedia.md index 694ccc4b..d6ec806e 100644 --- a/old_docs/API_docs_v44/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v44/methods/messages_sendMedia.md @@ -12,11 +12,11 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -24,34 +24,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -111,3 +83,31 @@ Updates = messages.sendMedia({broadcast=Bool, peer=InputPeer, reply_to_msg_id=in You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v44/methods/messages_sendMessage.md b/old_docs/API_docs_v44/methods/messages_sendMessage.md index 0c3ef389..a4845a78 100644 --- a/old_docs/API_docs_v44/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v44/methods/messages_sendMessage.md @@ -12,13 +12,13 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -27,33 +27,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -141,3 +114,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v44/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v44/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v44/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v44/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_setTyping.md b/old_docs/API_docs_v44/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v44/methods/messages_setTyping.md +++ b/old_docs/API_docs_v44/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v44/methods/messages_startBot.md b/old_docs/API_docs_v44/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v44/methods/messages_startBot.md +++ b/old_docs/API_docs_v44/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v44/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v44/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v44/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v44/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v44/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v44/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v44/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v44/methods/photos_getUserPhotos.md b/old_docs/API_docs_v44/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v44/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v44/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v44/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v44/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v44/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v44/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v44/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v44/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v44/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v44/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v44/methods/users_getUsers.md b/old_docs/API_docs_v44/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v44/methods/users_getUsers.md +++ b/old_docs/API_docs_v44/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v45/methods/account_changePhone.md b/old_docs/API_docs_v45/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v45/methods/account_changePhone.md +++ b/old_docs/API_docs_v45/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_checkUsername.md b/old_docs/API_docs_v45/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v45/methods/account_checkUsername.md +++ b/old_docs/API_docs_v45/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v45/methods/account_deleteAccount.md b/old_docs/API_docs_v45/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v45/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v45/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/account_getNotifySettings.md b/old_docs/API_docs_v45/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v45/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v45/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_getPasswordSettings.md b/old_docs/API_docs_v45/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v45/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v45/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_getPrivacy.md b/old_docs/API_docs_v45/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v45/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v45/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_registerDevice.md b/old_docs/API_docs_v45/methods/account_registerDevice.md index 8dae7506..a69b58ff 100644 --- a/old_docs/API_docs_v45/methods/account_registerDevice.md +++ b/old_docs/API_docs_v45/methods/account_registerDevice.md @@ -12,13 +12,13 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [Bool](../types/Bool.md) @@ -26,13 +26,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -81,3 +74,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_reportPeer.md b/old_docs/API_docs_v45/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v45/methods/account_reportPeer.md +++ b/old_docs/API_docs_v45/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_resetAuthorization.md b/old_docs/API_docs_v45/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v45/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v45/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v45/methods/account_sendChangePhoneCode.md index 930e0f76..181e817f 100644 --- a/old_docs/API_docs_v45/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v45/methods/account_sendChangePhoneCode.md @@ -12,7 +12,7 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| +|phone\_number|[string](../types/string.md) | Yes|New phone number| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) @@ -20,13 +20,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_SentChangePhoneCode = account.sendChangePhoneCode({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_setAccountTTL.md b/old_docs/API_docs_v45/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v45/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v45/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_setPrivacy.md b/old_docs/API_docs_v45/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v45/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v45/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_unregisterDevice.md b/old_docs/API_docs_v45/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v45/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v45/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v45/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v45/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v45/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/account_updateNotifySettings.md b/old_docs/API_docs_v45/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v45/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v45/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v45/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v45/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v45/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_updateProfile.md b/old_docs/API_docs_v45/methods/account_updateProfile.md index caea3391..67ceb92e 100644 --- a/old_docs/API_docs_v45/methods/account_updateProfile.md +++ b/old_docs/API_docs_v45/methods/account_updateProfile.md @@ -12,8 +12,8 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Yes|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Yes|The last name| +|first\_name|[string](../types/string.md) | Yes|The first name| +|last\_name|[string](../types/string.md) | Yes|The last name| ### Return type: [User](../types/User.md) @@ -21,14 +21,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v45/methods/account_updateStatus.md b/old_docs/API_docs_v45/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v45/methods/account_updateStatus.md +++ b/old_docs/API_docs_v45/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v45/methods/account_updateUsername.md b/old_docs/API_docs_v45/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v45/methods/account_updateUsername.md +++ b/old_docs/API_docs_v45/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v45/methods/auth_checkPhone.md b/old_docs/API_docs_v45/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v45/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v45/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v45/methods/auth_recoverPassword.md b/old_docs/API_docs_v45/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v45/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v45/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v45/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v45/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v45/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v45/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v45/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v45/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v45/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v45/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v45/methods/auth_sendCall.md b/old_docs/API_docs_v45/methods/auth_sendCall.md index 5947cda7..2f56038d 100644 --- a/old_docs/API_docs_v45/methods/auth_sendCall.md +++ b/old_docs/API_docs_v45/methods/auth_sendCall.md @@ -12,8 +12,8 @@ Send verification phone call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/auth_sendInvites.md b/old_docs/API_docs_v45/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v45/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v45/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v45/methods/auth_sendSms.md b/old_docs/API_docs_v45/methods/auth_sendSms.md index 41340660..38be5985 100644 --- a/old_docs/API_docs_v45/methods/auth_sendSms.md +++ b/old_docs/API_docs_v45/methods/auth_sendSms.md @@ -12,8 +12,8 @@ Send SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code ash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/channels_checkUsername.md b/old_docs/API_docs_v45/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v45/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v45/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v45/methods/channels_createChannel.md b/old_docs/API_docs_v45/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v45/methods/channels_createChannel.md +++ b/old_docs/API_docs_v45/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v45/methods/channels_deleteChannel.md b/old_docs/API_docs_v45/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v45/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v45/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v45/methods/channels_deleteMessages.md b/old_docs/API_docs_v45/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v45/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v45/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v45/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v45/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v45/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v45/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v45/methods/channels_editAbout.md b/old_docs/API_docs_v45/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v45/methods/channels_editAbout.md +++ b/old_docs/API_docs_v45/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v45/methods/channels_editAdmin.md b/old_docs/API_docs_v45/methods/channels_editAdmin.md index 7b6cc0f1..62f1fdaa 100644 --- a/old_docs/API_docs_v45/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v45/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v45/methods/channels_editPhoto.md b/old_docs/API_docs_v45/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v45/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v45/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v45/methods/channels_editTitle.md b/old_docs/API_docs_v45/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v45/methods/channels_editTitle.md +++ b/old_docs/API_docs_v45/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v45/methods/channels_exportInvite.md b/old_docs/API_docs_v45/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v45/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v45/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v45/methods/channels_getChannels.md b/old_docs/API_docs_v45/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v45/methods/channels_getChannels.md +++ b/old_docs/API_docs_v45/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v45/methods/channels_getDialogs.md b/old_docs/API_docs_v45/methods/channels_getDialogs.md index 1b5837b7..563b798b 100644 --- a/old_docs/API_docs_v45/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v45/methods/channels_getDialogs.md @@ -12,8 +12,8 @@ Get channel dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v45/methods/channels_getImportantHistory.md b/old_docs/API_docs_v45/methods/channels_getImportantHistory.md index 861e4a32..43cdd5b9 100644 --- a/old_docs/API_docs_v45/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v45/methods/channels_getImportantHistory.md @@ -13,11 +13,11 @@ Get important channel/supergroup history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID| +|offset\_id|[int](../types/int.md) | Yes|Message ID offset| +|add\_offset|[int](../types/int.md) | Yes|Additional offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v45/methods/channels_getMessages.md b/old_docs/API_docs_v45/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v45/methods/channels_getMessages.md +++ b/old_docs/API_docs_v45/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v45/methods/channels_getParticipant.md b/old_docs/API_docs_v45/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v45/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v45/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v45/methods/channels_getParticipants.md b/old_docs/API_docs_v45/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v45/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v45/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v45/methods/channels_inviteToChannel.md b/old_docs/API_docs_v45/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v45/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v45/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v45/methods/channels_joinChannel.md b/old_docs/API_docs_v45/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v45/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v45/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v45/methods/channels_kickFromChannel.md b/old_docs/API_docs_v45/methods/channels_kickFromChannel.md index 8f6c92be..0c6c0258 100644 --- a/old_docs/API_docs_v45/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v45/methods/channels_kickFromChannel.md @@ -14,7 +14,7 @@ Kick user from channel |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick| -|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|Kick or unkick?| +|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/channels_leaveChannel.md b/old_docs/API_docs_v45/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v45/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v45/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v45/methods/channels_readHistory.md b/old_docs/API_docs_v45/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v45/methods/channels_readHistory.md +++ b/old_docs/API_docs_v45/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v45/methods/channels_reportSpam.md b/old_docs/API_docs_v45/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v45/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v45/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v45/methods/channels_toggleComments.md b/old_docs/API_docs_v45/methods/channels_toggleComments.md index cc9f478d..3f52496b 100644 --- a/old_docs/API_docs_v45/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v45/methods/channels_toggleComments.md @@ -13,7 +13,7 @@ Enable channel comments | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable comments| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/channels_updateUsername.md b/old_docs/API_docs_v45/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v45/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v45/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v45/methods/contacts_block.md b/old_docs/API_docs_v45/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v45/methods/contacts_block.md +++ b/old_docs/API_docs_v45/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v45/methods/contacts_deleteContact.md b/old_docs/API_docs_v45/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v45/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v45/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v45/methods/contacts_deleteContacts.md b/old_docs/API_docs_v45/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v45/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v45/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v45/methods/contacts_getBlocked.md b/old_docs/API_docs_v45/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v45/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v45/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v45/methods/contacts_getContacts.md b/old_docs/API_docs_v45/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v45/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v45/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v45/methods/contacts_getSuggested.md b/old_docs/API_docs_v45/methods/contacts_getSuggested.md index 1ce04bef..1dba94e1 100644 --- a/old_docs/API_docs_v45/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v45/methods/contacts_getSuggested.md @@ -12,7 +12,7 @@ Get suggested contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v45/methods/contacts_importCard.md b/old_docs/API_docs_v45/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v45/methods/contacts_importCard.md +++ b/old_docs/API_docs_v45/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v45/methods/contacts_importContacts.md b/old_docs/API_docs_v45/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v45/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v45/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v45/methods/contacts_search.md b/old_docs/API_docs_v45/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v45/methods/contacts_search.md +++ b/old_docs/API_docs_v45/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v45/methods/contacts_unblock.md b/old_docs/API_docs_v45/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v45/methods/contacts_unblock.md +++ b/old_docs/API_docs_v45/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v45/methods/help_getAppChangelog.md b/old_docs/API_docs_v45/methods/help_getAppChangelog.md index eb48fabb..f2d8c2ef 100644 --- a/old_docs/API_docs_v45/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v45/methods/help_getAppChangelog.md @@ -12,10 +12,10 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v45/methods/help_getAppUpdate.md b/old_docs/API_docs_v45/methods/help_getAppUpdate.md index ad5b8228..ce84843d 100644 --- a/old_docs/API_docs_v45/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v45/methods/help_getAppUpdate.md @@ -12,10 +12,10 @@ Get info about app updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Langauge code| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v45/methods/help_getConfig.md b/old_docs/API_docs_v45/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v45/methods/help_getConfig.md +++ b/old_docs/API_docs_v45/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v45/methods/help_getInviteText.md b/old_docs/API_docs_v45/methods/help_getInviteText.md index ad6ac262..9b82d55d 100644 --- a/old_docs/API_docs_v45/methods/help_getInviteText.md +++ b/old_docs/API_docs_v45/methods/help_getInviteText.md @@ -12,7 +12,7 @@ Get invitation text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language| +|lang\_code|[string](../types/string.md) | Yes|Language| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v45/methods/help_getTermsOfService.md b/old_docs/API_docs_v45/methods/help_getTermsOfService.md index 0936575e..44087504 100644 --- a/old_docs/API_docs_v45/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v45/methods/help_getTermsOfService.md @@ -12,7 +12,7 @@ Get terms of service | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v45/methods/help_saveAppLog.md b/old_docs/API_docs_v45/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v45/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v45/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/initConnection.md b/old_docs/API_docs_v45/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v45/methods/initConnection.md +++ b/old_docs/API_docs_v45/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v45/methods/invokeAfterMsg.md b/old_docs/API_docs_v45/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v45/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v45/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v45/methods/invokeAfterMsgs.md b/old_docs/API_docs_v45/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v45/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v45/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v45/methods/invokeWithLayer.md b/old_docs/API_docs_v45/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v45/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v45/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v45/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v45/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v45/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v45/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v45/methods/messages_addChatUser.md b/old_docs/API_docs_v45/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v45/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v45/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v45/methods/messages_checkChatInvite.md b/old_docs/API_docs_v45/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v45/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v45/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_createChat.md b/old_docs/API_docs_v45/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v45/methods/messages_createChat.md +++ b/old_docs/API_docs_v45/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v45/methods/messages_deleteChatUser.md b/old_docs/API_docs_v45/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v45/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v45/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v45/methods/messages_deleteHistory.md b/old_docs/API_docs_v45/methods/messages_deleteHistory.md index 4cb70ec8..86f83b4b 100644 --- a/old_docs/API_docs_v45/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v45/methods/messages_deleteHistory.md @@ -13,7 +13,7 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -21,13 +21,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_deleteMessages.md b/old_docs/API_docs_v45/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v45/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v45/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v45/methods/messages_editChatAdmin.md b/old_docs/API_docs_v45/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v45/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v45/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_editChatPhoto.md b/old_docs/API_docs_v45/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v45/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v45/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_editChatTitle.md b/old_docs/API_docs_v45/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v45/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v45/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_exportChatInvite.md b/old_docs/API_docs_v45/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v45/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v45/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_forwardMessage.md b/old_docs/API_docs_v45/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v45/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v45/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v45/methods/messages_forwardMessages.md b/old_docs/API_docs_v45/methods/messages_forwardMessages.md index 6a646f5f..3a85b995 100644 --- a/old_docs/API_docs_v45/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v45/methods/messages_forwardMessages.md @@ -12,9 +12,9 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -23,34 +23,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -102,3 +74,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({broadcast=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v45/methods/messages_getAllStickers.md b/old_docs/API_docs_v45/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v45/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v45/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v45/methods/messages_getChats.md b/old_docs/API_docs_v45/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v45/methods/messages_getChats.md +++ b/old_docs/API_docs_v45/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_getDialogs.md b/old_docs/API_docs_v45/methods/messages_getDialogs.md index bd3ef681..623f002a 100644 --- a/old_docs/API_docs_v45/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v45/methods/messages_getDialogs.md @@ -12,10 +12,10 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -23,16 +23,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v45/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v45/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v45/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v45/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_getHistory.md b/old_docs/API_docs_v45/methods/messages_getHistory.md index dfefb639..cc438ce2 100644 --- a/old_docs/API_docs_v45/methods/messages_getHistory.md +++ b/old_docs/API_docs_v45/methods/messages_getHistory.md @@ -13,11 +13,11 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -25,18 +25,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -83,3 +71,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v45/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v45/methods/messages_getInlineBotResults.md index 0675fe08..7200b4b4 100644 --- a/old_docs/API_docs_v45/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v45/methods/messages_getInlineBotResults.md @@ -13,8 +13,8 @@ Call inline bot | Name | Type | Required | Description | |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -22,16 +22,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v45/methods/messages_getMessages.md b/old_docs/API_docs_v45/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v45/methods/messages_getMessages.md +++ b/old_docs/API_docs_v45/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v45/methods/messages_getMessagesViews.md b/old_docs/API_docs_v45/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v45/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v45/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_getSavedGifs.md b/old_docs/API_docs_v45/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v45/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v45/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v45/methods/messages_getStickerSet.md b/old_docs/API_docs_v45/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v45/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v45/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_getStickers.md b/old_docs/API_docs_v45/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v45/methods/messages_getStickers.md +++ b/old_docs/API_docs_v45/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v45/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v45/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v45/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v45/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v45/methods/messages_importChatInvite.md b/old_docs/API_docs_v45/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v45/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v45/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v45/methods/messages_installStickerSet.md b/old_docs/API_docs_v45/methods/messages_installStickerSet.md index 77c5a2a5..c807ba66 100644 --- a/old_docs/API_docs_v45/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v45/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|Disable stickerset?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.installStickerSet({stickerset=InputStickerSet, disabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_migrateChat.md b/old_docs/API_docs_v45/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v45/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v45/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v45/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v45/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v45/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v45/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v45/methods/messages_readHistory.md b/old_docs/API_docs_v45/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v45/methods/messages_readHistory.md +++ b/old_docs/API_docs_v45/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v45/methods/messages_readMessageContents.md b/old_docs/API_docs_v45/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v45/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v45/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v45/methods/messages_receivedMessages.md b/old_docs/API_docs_v45/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v45/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v45/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v45/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v45/methods/messages_reorderStickerSets.md index 90913e5d..53930d4f 100644 --- a/old_docs/API_docs_v45/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v45/methods/messages_reorderStickerSets.md @@ -12,7 +12,7 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_reportSpam.md b/old_docs/API_docs_v45/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v45/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v45/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_saveGif.md b/old_docs/API_docs_v45/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v45/methods/messages_saveGif.md +++ b/old_docs/API_docs_v45/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_search.md b/old_docs/API_docs_v45/methods/messages_search.md index 01af8760..42b9e947 100644 --- a/old_docs/API_docs_v45/methods/messages_search.md +++ b/old_docs/API_docs_v45/methods/messages_search.md @@ -12,15 +12,15 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|important\_only|[CLICK ME Bool](../types/Bool.md) | Optional|Show only important messages| +|important\_only|[Bool](../types/Bool.md) | Optional|Show only important messages| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -28,19 +28,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -93,3 +80,16 @@ Or, if you're into Lua: messages_Messages = messages.search({important_only=Bool, peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_searchGifs.md b/old_docs/API_docs_v45/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v45/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v45/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v45/methods/messages_searchGlobal.md b/old_docs/API_docs_v45/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v45/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v45/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v45/methods/messages_sendBroadcast.md b/old_docs/API_docs_v45/methods/messages_sendBroadcast.md index 6cff8b29..8eca8090 100644 --- a/old_docs/API_docs_v45/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v45/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v45/methods/messages_sendEncrypted.md b/old_docs/API_docs_v45/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v45/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v45/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v45/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v45/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v45/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v45/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v45/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v45/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v45/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v45/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v45/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v45/methods/messages_sendInlineBotResult.md index 262c6059..440a8196 100644 --- a/old_docs/API_docs_v45/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v45/methods/messages_sendInlineBotResult.md @@ -12,11 +12,11 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message?| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -24,18 +24,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -80,3 +68,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({broadcast=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v45/methods/messages_sendMedia.md b/old_docs/API_docs_v45/methods/messages_sendMedia.md index 694ccc4b..d6ec806e 100644 --- a/old_docs/API_docs_v45/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v45/methods/messages_sendMedia.md @@ -12,11 +12,11 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -24,34 +24,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -111,3 +83,31 @@ Updates = messages.sendMedia({broadcast=Bool, peer=InputPeer, reply_to_msg_id=in You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v45/methods/messages_sendMessage.md b/old_docs/API_docs_v45/methods/messages_sendMessage.md index 0c3ef389..a4845a78 100644 --- a/old_docs/API_docs_v45/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v45/methods/messages_sendMessage.md @@ -12,13 +12,13 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -27,33 +27,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -141,3 +114,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v45/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v45/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v45/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v45/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v45/methods/messages_setInlineBotResults.md index 9febbecd..1761e6bf 100644 --- a/old_docs/API_docs_v45/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v45/methods/messages_setInlineBotResults.md @@ -12,12 +12,12 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| ### Return type: [Bool](../types/Bool.md) @@ -25,23 +25,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -97,3 +80,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v45/methods/messages_setTyping.md b/old_docs/API_docs_v45/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v45/methods/messages_setTyping.md +++ b/old_docs/API_docs_v45/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v45/methods/messages_startBot.md b/old_docs/API_docs_v45/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v45/methods/messages_startBot.md +++ b/old_docs/API_docs_v45/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v45/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v45/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v45/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v45/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v45/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v45/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v45/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v45/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v45/methods/photos_getUserPhotos.md b/old_docs/API_docs_v45/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v45/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v45/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v45/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v45/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v45/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v45/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v45/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v45/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v45/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v45/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v45/methods/users_getUsers.md b/old_docs/API_docs_v45/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v45/methods/users_getUsers.md +++ b/old_docs/API_docs_v45/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v46/methods/account_changePhone.md b/old_docs/API_docs_v46/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v46/methods/account_changePhone.md +++ b/old_docs/API_docs_v46/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_checkUsername.md b/old_docs/API_docs_v46/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v46/methods/account_checkUsername.md +++ b/old_docs/API_docs_v46/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v46/methods/account_deleteAccount.md b/old_docs/API_docs_v46/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v46/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v46/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/account_getNotifySettings.md b/old_docs/API_docs_v46/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v46/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v46/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_getPasswordSettings.md b/old_docs/API_docs_v46/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v46/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v46/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_getPrivacy.md b/old_docs/API_docs_v46/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v46/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v46/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_registerDevice.md b/old_docs/API_docs_v46/methods/account_registerDevice.md index 8dae7506..a69b58ff 100644 --- a/old_docs/API_docs_v46/methods/account_registerDevice.md +++ b/old_docs/API_docs_v46/methods/account_registerDevice.md @@ -12,13 +12,13 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [Bool](../types/Bool.md) @@ -26,13 +26,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -81,3 +74,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_reportPeer.md b/old_docs/API_docs_v46/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v46/methods/account_reportPeer.md +++ b/old_docs/API_docs_v46/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_resetAuthorization.md b/old_docs/API_docs_v46/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v46/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v46/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v46/methods/account_sendChangePhoneCode.md index 930e0f76..181e817f 100644 --- a/old_docs/API_docs_v46/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v46/methods/account_sendChangePhoneCode.md @@ -12,7 +12,7 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| +|phone\_number|[string](../types/string.md) | Yes|New phone number| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) @@ -20,13 +20,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_SentChangePhoneCode = account.sendChangePhoneCode({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_setAccountTTL.md b/old_docs/API_docs_v46/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v46/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v46/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_setPrivacy.md b/old_docs/API_docs_v46/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v46/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v46/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_unregisterDevice.md b/old_docs/API_docs_v46/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v46/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v46/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v46/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v46/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v46/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/account_updateNotifySettings.md b/old_docs/API_docs_v46/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v46/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v46/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v46/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v46/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v46/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_updateProfile.md b/old_docs/API_docs_v46/methods/account_updateProfile.md index caea3391..67ceb92e 100644 --- a/old_docs/API_docs_v46/methods/account_updateProfile.md +++ b/old_docs/API_docs_v46/methods/account_updateProfile.md @@ -12,8 +12,8 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Yes|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Yes|The last name| +|first\_name|[string](../types/string.md) | Yes|The first name| +|last\_name|[string](../types/string.md) | Yes|The last name| ### Return type: [User](../types/User.md) @@ -21,14 +21,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v46/methods/account_updateStatus.md b/old_docs/API_docs_v46/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v46/methods/account_updateStatus.md +++ b/old_docs/API_docs_v46/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v46/methods/account_updateUsername.md b/old_docs/API_docs_v46/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v46/methods/account_updateUsername.md +++ b/old_docs/API_docs_v46/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v46/methods/auth_checkPhone.md b/old_docs/API_docs_v46/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v46/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v46/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v46/methods/auth_recoverPassword.md b/old_docs/API_docs_v46/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v46/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v46/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v46/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v46/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v46/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v46/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v46/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v46/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v46/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v46/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v46/methods/auth_sendCall.md b/old_docs/API_docs_v46/methods/auth_sendCall.md index 5947cda7..2f56038d 100644 --- a/old_docs/API_docs_v46/methods/auth_sendCall.md +++ b/old_docs/API_docs_v46/methods/auth_sendCall.md @@ -12,8 +12,8 @@ Send verification phone call | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/auth_sendInvites.md b/old_docs/API_docs_v46/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v46/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v46/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v46/methods/auth_sendSms.md b/old_docs/API_docs_v46/methods/auth_sendSms.md index 41340660..38be5985 100644 --- a/old_docs/API_docs_v46/methods/auth_sendSms.md +++ b/old_docs/API_docs_v46/methods/auth_sendSms.md @@ -12,8 +12,8 @@ Send SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code ash| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/channels_checkUsername.md b/old_docs/API_docs_v46/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v46/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v46/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v46/methods/channels_createChannel.md b/old_docs/API_docs_v46/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v46/methods/channels_createChannel.md +++ b/old_docs/API_docs_v46/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v46/methods/channels_deleteChannel.md b/old_docs/API_docs_v46/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v46/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v46/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v46/methods/channels_deleteMessages.md b/old_docs/API_docs_v46/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v46/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v46/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v46/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v46/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v46/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v46/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v46/methods/channels_editAbout.md b/old_docs/API_docs_v46/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v46/methods/channels_editAbout.md +++ b/old_docs/API_docs_v46/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v46/methods/channels_editAdmin.md b/old_docs/API_docs_v46/methods/channels_editAdmin.md index 7b6cc0f1..62f1fdaa 100644 --- a/old_docs/API_docs_v46/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v46/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v46/methods/channels_editPhoto.md b/old_docs/API_docs_v46/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v46/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v46/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v46/methods/channels_editTitle.md b/old_docs/API_docs_v46/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v46/methods/channels_editTitle.md +++ b/old_docs/API_docs_v46/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v46/methods/channels_exportInvite.md b/old_docs/API_docs_v46/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v46/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v46/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v46/methods/channels_getChannels.md b/old_docs/API_docs_v46/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v46/methods/channels_getChannels.md +++ b/old_docs/API_docs_v46/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v46/methods/channels_getDialogs.md b/old_docs/API_docs_v46/methods/channels_getDialogs.md index 1b5837b7..563b798b 100644 --- a/old_docs/API_docs_v46/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v46/methods/channels_getDialogs.md @@ -12,8 +12,8 @@ Get channel dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v46/methods/channels_getImportantHistory.md b/old_docs/API_docs_v46/methods/channels_getImportantHistory.md index 861e4a32..43cdd5b9 100644 --- a/old_docs/API_docs_v46/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v46/methods/channels_getImportantHistory.md @@ -13,11 +13,11 @@ Get important channel/supergroup history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID| +|offset\_id|[int](../types/int.md) | Yes|Message ID offset| +|add\_offset|[int](../types/int.md) | Yes|Additional offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v46/methods/channels_getMessages.md b/old_docs/API_docs_v46/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v46/methods/channels_getMessages.md +++ b/old_docs/API_docs_v46/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v46/methods/channels_getParticipant.md b/old_docs/API_docs_v46/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v46/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v46/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v46/methods/channels_getParticipants.md b/old_docs/API_docs_v46/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v46/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v46/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v46/methods/channels_inviteToChannel.md b/old_docs/API_docs_v46/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v46/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v46/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v46/methods/channels_joinChannel.md b/old_docs/API_docs_v46/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v46/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v46/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v46/methods/channels_kickFromChannel.md b/old_docs/API_docs_v46/methods/channels_kickFromChannel.md index 8f6c92be..0c6c0258 100644 --- a/old_docs/API_docs_v46/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v46/methods/channels_kickFromChannel.md @@ -14,7 +14,7 @@ Kick user from channel |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick| -|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|Kick or unkick?| +|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/channels_leaveChannel.md b/old_docs/API_docs_v46/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v46/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v46/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v46/methods/channels_readHistory.md b/old_docs/API_docs_v46/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v46/methods/channels_readHistory.md +++ b/old_docs/API_docs_v46/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v46/methods/channels_reportSpam.md b/old_docs/API_docs_v46/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v46/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v46/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v46/methods/channels_toggleComments.md b/old_docs/API_docs_v46/methods/channels_toggleComments.md index cc9f478d..3f52496b 100644 --- a/old_docs/API_docs_v46/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v46/methods/channels_toggleComments.md @@ -13,7 +13,7 @@ Enable channel comments | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable comments| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/channels_updateUsername.md b/old_docs/API_docs_v46/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v46/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v46/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v46/methods/contacts_block.md b/old_docs/API_docs_v46/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v46/methods/contacts_block.md +++ b/old_docs/API_docs_v46/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v46/methods/contacts_deleteContact.md b/old_docs/API_docs_v46/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v46/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v46/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v46/methods/contacts_deleteContacts.md b/old_docs/API_docs_v46/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v46/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v46/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v46/methods/contacts_getBlocked.md b/old_docs/API_docs_v46/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v46/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v46/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v46/methods/contacts_getContacts.md b/old_docs/API_docs_v46/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v46/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v46/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v46/methods/contacts_getSuggested.md b/old_docs/API_docs_v46/methods/contacts_getSuggested.md index 1ce04bef..1dba94e1 100644 --- a/old_docs/API_docs_v46/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v46/methods/contacts_getSuggested.md @@ -12,7 +12,7 @@ Get suggested contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v46/methods/contacts_importCard.md b/old_docs/API_docs_v46/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v46/methods/contacts_importCard.md +++ b/old_docs/API_docs_v46/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v46/methods/contacts_importContacts.md b/old_docs/API_docs_v46/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v46/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v46/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v46/methods/contacts_search.md b/old_docs/API_docs_v46/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v46/methods/contacts_search.md +++ b/old_docs/API_docs_v46/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v46/methods/contacts_unblock.md b/old_docs/API_docs_v46/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v46/methods/contacts_unblock.md +++ b/old_docs/API_docs_v46/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v46/methods/help_getAppChangelog.md b/old_docs/API_docs_v46/methods/help_getAppChangelog.md index eb48fabb..f2d8c2ef 100644 --- a/old_docs/API_docs_v46/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v46/methods/help_getAppChangelog.md @@ -12,10 +12,10 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v46/methods/help_getAppUpdate.md b/old_docs/API_docs_v46/methods/help_getAppUpdate.md index ad5b8228..ce84843d 100644 --- a/old_docs/API_docs_v46/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v46/methods/help_getAppUpdate.md @@ -12,10 +12,10 @@ Get info about app updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Langauge code| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v46/methods/help_getConfig.md b/old_docs/API_docs_v46/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v46/methods/help_getConfig.md +++ b/old_docs/API_docs_v46/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v46/methods/help_getInviteText.md b/old_docs/API_docs_v46/methods/help_getInviteText.md index ad6ac262..9b82d55d 100644 --- a/old_docs/API_docs_v46/methods/help_getInviteText.md +++ b/old_docs/API_docs_v46/methods/help_getInviteText.md @@ -12,7 +12,7 @@ Get invitation text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language| +|lang\_code|[string](../types/string.md) | Yes|Language| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v46/methods/help_getTermsOfService.md b/old_docs/API_docs_v46/methods/help_getTermsOfService.md index 0936575e..44087504 100644 --- a/old_docs/API_docs_v46/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v46/methods/help_getTermsOfService.md @@ -12,7 +12,7 @@ Get terms of service | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v46/methods/help_saveAppLog.md b/old_docs/API_docs_v46/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v46/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v46/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/initConnection.md b/old_docs/API_docs_v46/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v46/methods/initConnection.md +++ b/old_docs/API_docs_v46/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v46/methods/invokeAfterMsg.md b/old_docs/API_docs_v46/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v46/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v46/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v46/methods/invokeAfterMsgs.md b/old_docs/API_docs_v46/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v46/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v46/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v46/methods/invokeWithLayer.md b/old_docs/API_docs_v46/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v46/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v46/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v46/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v46/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v46/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v46/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v46/methods/messages_addChatUser.md b/old_docs/API_docs_v46/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v46/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v46/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v46/methods/messages_checkChatInvite.md b/old_docs/API_docs_v46/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v46/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v46/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_createChat.md b/old_docs/API_docs_v46/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v46/methods/messages_createChat.md +++ b/old_docs/API_docs_v46/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v46/methods/messages_deleteChatUser.md b/old_docs/API_docs_v46/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v46/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v46/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v46/methods/messages_deleteHistory.md b/old_docs/API_docs_v46/methods/messages_deleteHistory.md index 4cb70ec8..86f83b4b 100644 --- a/old_docs/API_docs_v46/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v46/methods/messages_deleteHistory.md @@ -13,7 +13,7 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -21,13 +21,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_deleteMessages.md b/old_docs/API_docs_v46/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v46/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v46/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v46/methods/messages_editChatAdmin.md b/old_docs/API_docs_v46/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v46/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v46/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_editChatPhoto.md b/old_docs/API_docs_v46/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v46/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v46/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_editChatTitle.md b/old_docs/API_docs_v46/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v46/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v46/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_exportChatInvite.md b/old_docs/API_docs_v46/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v46/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v46/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_forwardMessage.md b/old_docs/API_docs_v46/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v46/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v46/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v46/methods/messages_forwardMessages.md b/old_docs/API_docs_v46/methods/messages_forwardMessages.md index 6a646f5f..3a85b995 100644 --- a/old_docs/API_docs_v46/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v46/methods/messages_forwardMessages.md @@ -12,9 +12,9 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -23,34 +23,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -102,3 +74,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({broadcast=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v46/methods/messages_getAllStickers.md b/old_docs/API_docs_v46/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v46/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v46/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v46/methods/messages_getChats.md b/old_docs/API_docs_v46/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v46/methods/messages_getChats.md +++ b/old_docs/API_docs_v46/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_getDialogs.md b/old_docs/API_docs_v46/methods/messages_getDialogs.md index bd3ef681..623f002a 100644 --- a/old_docs/API_docs_v46/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v46/methods/messages_getDialogs.md @@ -12,10 +12,10 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -23,16 +23,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v46/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v46/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v46/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v46/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_getHistory.md b/old_docs/API_docs_v46/methods/messages_getHistory.md index dfefb639..cc438ce2 100644 --- a/old_docs/API_docs_v46/methods/messages_getHistory.md +++ b/old_docs/API_docs_v46/methods/messages_getHistory.md @@ -13,11 +13,11 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -25,18 +25,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -83,3 +71,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v46/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v46/methods/messages_getInlineBotResults.md index 0675fe08..7200b4b4 100644 --- a/old_docs/API_docs_v46/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v46/methods/messages_getInlineBotResults.md @@ -13,8 +13,8 @@ Call inline bot | Name | Type | Required | Description | |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -22,16 +22,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v46/methods/messages_getMessages.md b/old_docs/API_docs_v46/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v46/methods/messages_getMessages.md +++ b/old_docs/API_docs_v46/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v46/methods/messages_getMessagesViews.md b/old_docs/API_docs_v46/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v46/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v46/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_getSavedGifs.md b/old_docs/API_docs_v46/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v46/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v46/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v46/methods/messages_getStickerSet.md b/old_docs/API_docs_v46/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v46/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v46/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_getStickers.md b/old_docs/API_docs_v46/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v46/methods/messages_getStickers.md +++ b/old_docs/API_docs_v46/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v46/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v46/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v46/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v46/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v46/methods/messages_importChatInvite.md b/old_docs/API_docs_v46/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v46/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v46/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v46/methods/messages_installStickerSet.md b/old_docs/API_docs_v46/methods/messages_installStickerSet.md index 77c5a2a5..c807ba66 100644 --- a/old_docs/API_docs_v46/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v46/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|Disable stickerset?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.installStickerSet({stickerset=InputStickerSet, disabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_migrateChat.md b/old_docs/API_docs_v46/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v46/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v46/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v46/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v46/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v46/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v46/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v46/methods/messages_readHistory.md b/old_docs/API_docs_v46/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v46/methods/messages_readHistory.md +++ b/old_docs/API_docs_v46/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v46/methods/messages_readMessageContents.md b/old_docs/API_docs_v46/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v46/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v46/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v46/methods/messages_receivedMessages.md b/old_docs/API_docs_v46/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v46/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v46/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v46/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v46/methods/messages_reorderStickerSets.md index 90913e5d..53930d4f 100644 --- a/old_docs/API_docs_v46/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v46/methods/messages_reorderStickerSets.md @@ -12,7 +12,7 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_reportSpam.md b/old_docs/API_docs_v46/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v46/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v46/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_saveGif.md b/old_docs/API_docs_v46/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v46/methods/messages_saveGif.md +++ b/old_docs/API_docs_v46/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_search.md b/old_docs/API_docs_v46/methods/messages_search.md index 01af8760..42b9e947 100644 --- a/old_docs/API_docs_v46/methods/messages_search.md +++ b/old_docs/API_docs_v46/methods/messages_search.md @@ -12,15 +12,15 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|important\_only|[CLICK ME Bool](../types/Bool.md) | Optional|Show only important messages| +|important\_only|[Bool](../types/Bool.md) | Optional|Show only important messages| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -28,19 +28,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -93,3 +80,16 @@ Or, if you're into Lua: messages_Messages = messages.search({important_only=Bool, peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_searchGifs.md b/old_docs/API_docs_v46/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v46/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v46/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v46/methods/messages_searchGlobal.md b/old_docs/API_docs_v46/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v46/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v46/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v46/methods/messages_sendBroadcast.md b/old_docs/API_docs_v46/methods/messages_sendBroadcast.md index 6cff8b29..8eca8090 100644 --- a/old_docs/API_docs_v46/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v46/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v46/methods/messages_sendEncrypted.md b/old_docs/API_docs_v46/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v46/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v46/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v46/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v46/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v46/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v46/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v46/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v46/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v46/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v46/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v46/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v46/methods/messages_sendInlineBotResult.md index 262c6059..440a8196 100644 --- a/old_docs/API_docs_v46/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v46/methods/messages_sendInlineBotResult.md @@ -12,11 +12,11 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message?| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -24,18 +24,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -80,3 +68,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({broadcast=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v46/methods/messages_sendMedia.md b/old_docs/API_docs_v46/methods/messages_sendMedia.md index 694ccc4b..d6ec806e 100644 --- a/old_docs/API_docs_v46/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v46/methods/messages_sendMedia.md @@ -12,11 +12,11 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -24,34 +24,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -111,3 +83,31 @@ Updates = messages.sendMedia({broadcast=Bool, peer=InputPeer, reply_to_msg_id=in You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v46/methods/messages_sendMessage.md b/old_docs/API_docs_v46/methods/messages_sendMessage.md index 0c3ef389..a4845a78 100644 --- a/old_docs/API_docs_v46/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v46/methods/messages_sendMessage.md @@ -12,13 +12,13 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -27,33 +27,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -141,3 +114,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v46/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v46/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v46/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v46/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v46/methods/messages_setInlineBotResults.md index 9febbecd..1761e6bf 100644 --- a/old_docs/API_docs_v46/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v46/methods/messages_setInlineBotResults.md @@ -12,12 +12,12 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| ### Return type: [Bool](../types/Bool.md) @@ -25,23 +25,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -97,3 +80,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v46/methods/messages_setTyping.md b/old_docs/API_docs_v46/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v46/methods/messages_setTyping.md +++ b/old_docs/API_docs_v46/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v46/methods/messages_startBot.md b/old_docs/API_docs_v46/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v46/methods/messages_startBot.md +++ b/old_docs/API_docs_v46/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v46/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v46/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v46/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v46/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v46/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v46/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v46/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v46/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v46/methods/photos_getUserPhotos.md b/old_docs/API_docs_v46/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v46/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v46/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v46/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v46/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v46/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v46/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v46/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v46/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v46/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v46/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v46/methods/users_getUsers.md b/old_docs/API_docs_v46/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v46/methods/users_getUsers.md +++ b/old_docs/API_docs_v46/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/account_changePhone.md b/old_docs/API_docs_v51/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v51/methods/account_changePhone.md +++ b/old_docs/API_docs_v51/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_checkUsername.md b/old_docs/API_docs_v51/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v51/methods/account_checkUsername.md +++ b/old_docs/API_docs_v51/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v51/methods/account_deleteAccount.md b/old_docs/API_docs_v51/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v51/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v51/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/account_getNotifySettings.md b/old_docs/API_docs_v51/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v51/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v51/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_getPasswordSettings.md b/old_docs/API_docs_v51/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v51/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v51/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_getPrivacy.md b/old_docs/API_docs_v51/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v51/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v51/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_registerDevice.md b/old_docs/API_docs_v51/methods/account_registerDevice.md index 8dae7506..a69b58ff 100644 --- a/old_docs/API_docs_v51/methods/account_registerDevice.md +++ b/old_docs/API_docs_v51/methods/account_registerDevice.md @@ -12,13 +12,13 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [Bool](../types/Bool.md) @@ -26,13 +26,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -81,3 +74,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_reportPeer.md b/old_docs/API_docs_v51/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v51/methods/account_reportPeer.md +++ b/old_docs/API_docs_v51/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_resetAuthorization.md b/old_docs/API_docs_v51/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v51/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v51/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v51/methods/account_sendChangePhoneCode.md index bdf7331f..476b6d79 100644 --- a/old_docs/API_docs_v51/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v51/methods/account_sendChangePhoneCode.md @@ -12,9 +12,9 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|Current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_setAccountTTL.md b/old_docs/API_docs_v51/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v51/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v51/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_setPrivacy.md b/old_docs/API_docs_v51/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v51/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v51/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_unregisterDevice.md b/old_docs/API_docs_v51/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v51/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v51/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v51/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v51/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v51/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/account_updateNotifySettings.md b/old_docs/API_docs_v51/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v51/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v51/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v51/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v51/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v51/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_updateProfile.md b/old_docs/API_docs_v51/methods/account_updateProfile.md index 59629188..ef19dc00 100644 --- a/old_docs/API_docs_v51/methods/account_updateProfile.md +++ b/old_docs/API_docs_v51/methods/account_updateProfile.md @@ -12,9 +12,9 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Optional|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Optional|The last name| -|about|[CLICK ME string](../types/string.md) | Optional|The bio/about field| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| ### Return type: [User](../types/User.md) @@ -22,14 +22,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v51/methods/account_updateStatus.md b/old_docs/API_docs_v51/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v51/methods/account_updateStatus.md +++ b/old_docs/API_docs_v51/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v51/methods/account_updateUsername.md b/old_docs/API_docs_v51/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v51/methods/account_updateUsername.md +++ b/old_docs/API_docs_v51/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v51/methods/auth_cancelCode.md b/old_docs/API_docs_v51/methods/auth_cancelCode.md index 52b85d4c..84401c62 100644 --- a/old_docs/API_docs_v51/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v51/methods/auth_cancelCode.md @@ -12,8 +12,8 @@ Invalidate sent phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invalidate sent phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v51/methods/auth_checkPhone.md b/old_docs/API_docs_v51/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v51/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v51/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v51/methods/auth_recoverPassword.md b/old_docs/API_docs_v51/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v51/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v51/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v51/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v51/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v51/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v51/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v51/methods/auth_resendCode.md b/old_docs/API_docs_v51/methods/auth_resendCode.md index 253480a3..4402bfe6 100644 --- a/old_docs/API_docs_v51/methods/auth_resendCode.md +++ b/old_docs/API_docs_v51/methods/auth_resendCode.md @@ -12,8 +12,8 @@ Resend the SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -21,13 +21,6 @@ Resend the SMS verification code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v51/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v51/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v51/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v51/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/auth_sendInvites.md b/old_docs/API_docs_v51/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v51/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v51/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v51/methods/channels_checkUsername.md b/old_docs/API_docs_v51/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v51/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v51/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v51/methods/channels_createChannel.md b/old_docs/API_docs_v51/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v51/methods/channels_createChannel.md +++ b/old_docs/API_docs_v51/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v51/methods/channels_deleteChannel.md b/old_docs/API_docs_v51/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v51/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v51/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v51/methods/channels_deleteMessages.md b/old_docs/API_docs_v51/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v51/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v51/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v51/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v51/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v51/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v51/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v51/methods/channels_editAbout.md b/old_docs/API_docs_v51/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v51/methods/channels_editAbout.md +++ b/old_docs/API_docs_v51/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v51/methods/channels_editAdmin.md b/old_docs/API_docs_v51/methods/channels_editAdmin.md index 7b6cc0f1..62f1fdaa 100644 --- a/old_docs/API_docs_v51/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v51/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v51/methods/channels_editPhoto.md b/old_docs/API_docs_v51/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v51/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v51/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v51/methods/channels_editTitle.md b/old_docs/API_docs_v51/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v51/methods/channels_editTitle.md +++ b/old_docs/API_docs_v51/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v51/methods/channels_exportInvite.md b/old_docs/API_docs_v51/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v51/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v51/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v51/methods/channels_exportMessageLink.md b/old_docs/API_docs_v51/methods/channels_exportMessageLink.md index b4a3c645..20f6e998 100644 --- a/old_docs/API_docs_v51/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v51/methods/channels_exportMessageLink.md @@ -13,7 +13,7 @@ Get the link of a message in a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| +|id|[int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -21,13 +21,6 @@ Get the link of a message in a channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v51/methods/channels_getChannels.md b/old_docs/API_docs_v51/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v51/methods/channels_getChannels.md +++ b/old_docs/API_docs_v51/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v51/methods/channels_getDialogs.md b/old_docs/API_docs_v51/methods/channels_getDialogs.md index 1b5837b7..563b798b 100644 --- a/old_docs/API_docs_v51/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v51/methods/channels_getDialogs.md @@ -12,8 +12,8 @@ Get channel dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v51/methods/channels_getImportantHistory.md b/old_docs/API_docs_v51/methods/channels_getImportantHistory.md index 029c670d..d77eec6c 100644 --- a/old_docs/API_docs_v51/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v51/methods/channels_getImportantHistory.md @@ -13,12 +13,12 @@ Get important channel/supergroup history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|Message ID offset| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|Date offset| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID| +|offset\_id|[int](../types/int.md) | Yes|Message ID offset| +|offset\_date|[int](../types/int.md) | Yes|Date offset| +|add\_offset|[int](../types/int.md) | Yes|Additional offset| +|limit|[int](../types/int.md) | Yes|Number of results to return| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v51/methods/channels_getMessages.md b/old_docs/API_docs_v51/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v51/methods/channels_getMessages.md +++ b/old_docs/API_docs_v51/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v51/methods/channels_getParticipant.md b/old_docs/API_docs_v51/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v51/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v51/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v51/methods/channels_getParticipants.md b/old_docs/API_docs_v51/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v51/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v51/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/channels_inviteToChannel.md b/old_docs/API_docs_v51/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v51/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v51/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v51/methods/channels_joinChannel.md b/old_docs/API_docs_v51/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v51/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v51/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v51/methods/channels_kickFromChannel.md b/old_docs/API_docs_v51/methods/channels_kickFromChannel.md index 8f6c92be..0c6c0258 100644 --- a/old_docs/API_docs_v51/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v51/methods/channels_kickFromChannel.md @@ -14,7 +14,7 @@ Kick user from channel |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick| -|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|Kick or unkick?| +|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_leaveChannel.md b/old_docs/API_docs_v51/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v51/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v51/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v51/methods/channels_readHistory.md b/old_docs/API_docs_v51/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v51/methods/channels_readHistory.md +++ b/old_docs/API_docs_v51/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v51/methods/channels_reportSpam.md b/old_docs/API_docs_v51/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v51/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v51/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v51/methods/channels_toggleComments.md b/old_docs/API_docs_v51/methods/channels_toggleComments.md index cc9f478d..3f52496b 100644 --- a/old_docs/API_docs_v51/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v51/methods/channels_toggleComments.md @@ -13,7 +13,7 @@ Enable channel comments | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable comments| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_toggleInvites.md b/old_docs/API_docs_v51/methods/channels_toggleInvites.md index e9e6450d..d437682f 100644 --- a/old_docs/API_docs_v51/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v51/methods/channels_toggleInvites.md @@ -13,7 +13,7 @@ Allow or disallow any user to invite users to this channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Allow or disallow any user to invite users to this channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v51/methods/channels_toggleSignatures.md b/old_docs/API_docs_v51/methods/channels_toggleSignatures.md index 36d1eccb..d40bf67b 100644 --- a/old_docs/API_docs_v51/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v51/methods/channels_toggleSignatures.md @@ -13,7 +13,7 @@ Toggle channel signatures | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Toggle channel signatures ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v51/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v51/methods/channels_updatePinnedMessage.md index f8d10ece..aa2cc783 100644 --- a/old_docs/API_docs_v51/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v51/methods/channels_updatePinnedMessage.md @@ -12,9 +12,9 @@ Set the pinned message of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Set the pinned message of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -81,3 +71,13 @@ Or, if you're into Lua: Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v51/methods/channels_updateUsername.md b/old_docs/API_docs_v51/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v51/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v51/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v51/methods/contacts_block.md b/old_docs/API_docs_v51/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v51/methods/contacts_block.md +++ b/old_docs/API_docs_v51/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v51/methods/contacts_deleteContact.md b/old_docs/API_docs_v51/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v51/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v51/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v51/methods/contacts_deleteContacts.md b/old_docs/API_docs_v51/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v51/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v51/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/contacts_getBlocked.md b/old_docs/API_docs_v51/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v51/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v51/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v51/methods/contacts_getContacts.md b/old_docs/API_docs_v51/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v51/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v51/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v51/methods/contacts_importCard.md b/old_docs/API_docs_v51/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v51/methods/contacts_importCard.md +++ b/old_docs/API_docs_v51/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v51/methods/contacts_importContacts.md b/old_docs/API_docs_v51/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v51/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v51/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v51/methods/contacts_search.md b/old_docs/API_docs_v51/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v51/methods/contacts_search.md +++ b/old_docs/API_docs_v51/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/contacts_unblock.md b/old_docs/API_docs_v51/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v51/methods/contacts_unblock.md +++ b/old_docs/API_docs_v51/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v51/methods/help_getAppChangelog.md b/old_docs/API_docs_v51/methods/help_getAppChangelog.md index eb48fabb..f2d8c2ef 100644 --- a/old_docs/API_docs_v51/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v51/methods/help_getAppChangelog.md @@ -12,10 +12,10 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v51/methods/help_getAppUpdate.md b/old_docs/API_docs_v51/methods/help_getAppUpdate.md index ad5b8228..ce84843d 100644 --- a/old_docs/API_docs_v51/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v51/methods/help_getAppUpdate.md @@ -12,10 +12,10 @@ Get info about app updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Langauge code| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v51/methods/help_getConfig.md b/old_docs/API_docs_v51/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v51/methods/help_getConfig.md +++ b/old_docs/API_docs_v51/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/help_getInviteText.md b/old_docs/API_docs_v51/methods/help_getInviteText.md index ad6ac262..9b82d55d 100644 --- a/old_docs/API_docs_v51/methods/help_getInviteText.md +++ b/old_docs/API_docs_v51/methods/help_getInviteText.md @@ -12,7 +12,7 @@ Get invitation text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language| +|lang\_code|[string](../types/string.md) | Yes|Language| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v51/methods/help_getTermsOfService.md b/old_docs/API_docs_v51/methods/help_getTermsOfService.md index 0936575e..44087504 100644 --- a/old_docs/API_docs_v51/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v51/methods/help_getTermsOfService.md @@ -12,7 +12,7 @@ Get terms of service | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v51/methods/help_saveAppLog.md b/old_docs/API_docs_v51/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v51/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v51/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/initConnection.md b/old_docs/API_docs_v51/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v51/methods/initConnection.md +++ b/old_docs/API_docs_v51/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v51/methods/invokeAfterMsg.md b/old_docs/API_docs_v51/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v51/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v51/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v51/methods/invokeAfterMsgs.md b/old_docs/API_docs_v51/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v51/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v51/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v51/methods/invokeWithLayer.md b/old_docs/API_docs_v51/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v51/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v51/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v51/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v51/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v51/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v51/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v51/methods/messages_addChatUser.md b/old_docs/API_docs_v51/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v51/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v51/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v51/methods/messages_checkChatInvite.md b/old_docs/API_docs_v51/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v51/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v51/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_createChat.md b/old_docs/API_docs_v51/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v51/methods/messages_createChat.md +++ b/old_docs/API_docs_v51/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v51/methods/messages_deleteChatUser.md b/old_docs/API_docs_v51/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v51/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v51/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v51/methods/messages_deleteHistory.md b/old_docs/API_docs_v51/methods/messages_deleteHistory.md index 4cb70ec8..86f83b4b 100644 --- a/old_docs/API_docs_v51/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v51/methods/messages_deleteHistory.md @@ -13,7 +13,7 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -21,13 +21,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_deleteMessages.md b/old_docs/API_docs_v51/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v51/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v51/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v51/methods/messages_editChatAdmin.md b/old_docs/API_docs_v51/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v51/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v51/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_editChatPhoto.md b/old_docs/API_docs_v51/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v51/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v51/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_editChatTitle.md b/old_docs/API_docs_v51/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v51/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v51/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v51/methods/messages_editInlineBotMessage.md index 73c8a2c4..4729b52a 100644 --- a/old_docs/API_docs_v51/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v51/methods/messages_editInlineBotMessage.md @@ -12,11 +12,11 @@ Edit a sent inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,14 +25,6 @@ Edit a sent inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| - - ### MadelineProto Example: @@ -120,3 +112,11 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v51/methods/messages_editMessage.md b/old_docs/API_docs_v51/methods/messages_editMessage.md index ad639325..4380aba6 100644 --- a/old_docs/API_docs_v51/methods/messages_editMessage.md +++ b/old_docs/API_docs_v51/methods/messages_editMessage.md @@ -12,12 +12,12 @@ Edit a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -26,22 +26,6 @@ Edit a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -129,3 +113,19 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v51/methods/messages_exportChatInvite.md b/old_docs/API_docs_v51/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v51/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v51/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_forwardMessage.md b/old_docs/API_docs_v51/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v51/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v51/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v51/methods/messages_forwardMessages.md b/old_docs/API_docs_v51/methods/messages_forwardMessages.md index b2549338..54acbbe1 100644 --- a/old_docs/API_docs_v51/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v51/methods/messages_forwardMessages.md @@ -12,11 +12,11 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -25,34 +25,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -108,3 +80,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({broadcast=Bool, silent=Bool, background=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/messages_getAllStickers.md b/old_docs/API_docs_v51/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v51/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v51/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v51/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v51/methods/messages_getBotCallbackAnswer.md index 01ae3ac9..9325dc2b 100644 --- a/old_docs/API_docs_v51/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v51/methods/messages_getBotCallbackAnswer.md @@ -13,8 +13,8 @@ Get the callback answer of a bot (after clicking a button) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|data|[CLICK ME bytes](../types/bytes.md) | Yes|The data to send to the bot| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Yes|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) @@ -22,17 +22,6 @@ Get the callback answer of a bot (after clicking a button) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|DATA_INVALID|Encrypted data invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -73,3 +62,14 @@ Or, if you're into Lua: messages_BotCallbackAnswer = messages.getBotCallbackAnswer({peer=InputPeer, msg_id=int, data='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/messages_getChats.md b/old_docs/API_docs_v51/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v51/methods/messages_getChats.md +++ b/old_docs/API_docs_v51/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_getDialogs.md b/old_docs/API_docs_v51/methods/messages_getDialogs.md index bd3ef681..623f002a 100644 --- a/old_docs/API_docs_v51/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v51/methods/messages_getDialogs.md @@ -12,10 +12,10 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -23,16 +23,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v51/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v51/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v51/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_getHistory.md b/old_docs/API_docs_v51/methods/messages_getHistory.md index 851d2680..86a744cf 100644 --- a/old_docs/API_docs_v51/methods/messages_getHistory.md +++ b/old_docs/API_docs_v51/methods/messages_getHistory.md @@ -13,12 +13,12 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -26,18 +26,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v51/methods/messages_getInlineBotResults.md index 4d86caf5..207624a7 100644 --- a/old_docs/API_docs_v51/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v51/methods/messages_getInlineBotResults.md @@ -14,9 +14,9 @@ Call inline bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -24,16 +24,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/messages_getMessageEditData.md b/old_docs/API_docs_v51/methods/messages_getMessageEditData.md index 34f8534f..00c63d28 100644 --- a/old_docs/API_docs_v51/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v51/methods/messages_getMessageEditData.md @@ -13,7 +13,7 @@ Check if about to edit a message or a media caption | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) @@ -21,14 +21,6 @@ Check if about to edit a message or a media caption ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v51/methods/messages_getMessages.md b/old_docs/API_docs_v51/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v51/methods/messages_getMessages.md +++ b/old_docs/API_docs_v51/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v51/methods/messages_getMessagesViews.md b/old_docs/API_docs_v51/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v51/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v51/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_getPeerSettings.md b/old_docs/API_docs_v51/methods/messages_getPeerSettings.md index a18126f0..5a3e9349 100644 --- a/old_docs/API_docs_v51/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v51/methods/messages_getPeerSettings.md @@ -20,14 +20,6 @@ Get the settings of apeer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: PeerSettings = messages.getPeerSettings({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_getSavedGifs.md b/old_docs/API_docs_v51/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v51/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v51/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v51/methods/messages_getStickerSet.md b/old_docs/API_docs_v51/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v51/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v51/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_getStickers.md b/old_docs/API_docs_v51/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v51/methods/messages_getStickers.md +++ b/old_docs/API_docs_v51/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v51/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v51/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v51/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v51/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v51/methods/messages_hideReportSpam.md b/old_docs/API_docs_v51/methods/messages_hideReportSpam.md index 30523f2a..0bf711ea 100644 --- a/old_docs/API_docs_v51/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v51/methods/messages_hideReportSpam.md @@ -20,13 +20,6 @@ Hide report spam popup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.hideReportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_importChatInvite.md b/old_docs/API_docs_v51/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v51/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v51/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v51/methods/messages_installStickerSet.md b/old_docs/API_docs_v51/methods/messages_installStickerSet.md index 77c5a2a5..c807ba66 100644 --- a/old_docs/API_docs_v51/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v51/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|Disable stickerset?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.installStickerSet({stickerset=InputStickerSet, disabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_migrateChat.md b/old_docs/API_docs_v51/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v51/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v51/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v51/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v51/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v51/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v51/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v51/methods/messages_readHistory.md b/old_docs/API_docs_v51/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v51/methods/messages_readHistory.md +++ b/old_docs/API_docs_v51/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/messages_readMessageContents.md b/old_docs/API_docs_v51/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v51/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v51/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v51/methods/messages_receivedMessages.md b/old_docs/API_docs_v51/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v51/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v51/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v51/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v51/methods/messages_reorderStickerSets.md index 90913e5d..53930d4f 100644 --- a/old_docs/API_docs_v51/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v51/methods/messages_reorderStickerSets.md @@ -12,7 +12,7 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_reportSpam.md b/old_docs/API_docs_v51/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v51/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v51/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_saveGif.md b/old_docs/API_docs_v51/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v51/methods/messages_saveGif.md +++ b/old_docs/API_docs_v51/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_search.md b/old_docs/API_docs_v51/methods/messages_search.md index 01af8760..42b9e947 100644 --- a/old_docs/API_docs_v51/methods/messages_search.md +++ b/old_docs/API_docs_v51/methods/messages_search.md @@ -12,15 +12,15 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|important\_only|[CLICK ME Bool](../types/Bool.md) | Optional|Show only important messages| +|important\_only|[Bool](../types/Bool.md) | Optional|Show only important messages| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -28,19 +28,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -93,3 +80,16 @@ Or, if you're into Lua: messages_Messages = messages.search({important_only=Bool, peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_searchGifs.md b/old_docs/API_docs_v51/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v51/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v51/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v51/methods/messages_searchGlobal.md b/old_docs/API_docs_v51/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v51/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v51/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v51/methods/messages_sendBroadcast.md b/old_docs/API_docs_v51/methods/messages_sendBroadcast.md index 6cff8b29..8eca8090 100644 --- a/old_docs/API_docs_v51/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v51/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v51/methods/messages_sendEncrypted.md b/old_docs/API_docs_v51/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v51/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v51/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v51/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v51/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v51/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v51/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v51/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v51/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v51/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v51/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v51/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v51/methods/messages_sendInlineBotResult.md index ab72a64c..e13429d8 100644 --- a/old_docs/API_docs_v51/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v51/methods/messages_sendInlineBotResult.md @@ -12,13 +12,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message?| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -26,18 +26,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({broadcast=Bool, silent=Bool, background=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v51/methods/messages_sendMedia.md b/old_docs/API_docs_v51/methods/messages_sendMedia.md index d8c20b9b..f2efa450 100644 --- a/old_docs/API_docs_v51/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v51/methods/messages_sendMedia.md @@ -12,13 +12,13 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -26,34 +26,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -117,3 +89,31 @@ Updates = messages.sendMedia({broadcast=Bool, silent=Bool, background=Bool, peer You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/messages_sendMessage.md b/old_docs/API_docs_v51/methods/messages_sendMessage.md index b30daa8b..092b2c7d 100644 --- a/old_docs/API_docs_v51/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v51/methods/messages_sendMessage.md @@ -12,15 +12,15 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Broadcast this message| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,33 +29,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -143,3 +116,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v51/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v51/methods/messages_setBotCallbackAnswer.md index f15699a0..66e3bc0e 100644 --- a/old_docs/API_docs_v51/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v51/methods/messages_setBotCallbackAnswer.md @@ -12,9 +12,9 @@ Bots only: set the callback answer (after a button was clicked) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|message|[CLICK ME string](../types/string.md) | Optional|The message| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set the callback answer (after a button was clicked) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v51/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v51/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v51/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v51/methods/messages_setInlineBotResults.md index d4ba6e65..e46598e2 100644 --- a/old_docs/API_docs_v51/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v51/methods/messages_setInlineBotResults.md @@ -12,13 +12,13 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) @@ -26,23 +26,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -100,3 +83,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v51/methods/messages_setTyping.md b/old_docs/API_docs_v51/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v51/methods/messages_setTyping.md +++ b/old_docs/API_docs_v51/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v51/methods/messages_startBot.md b/old_docs/API_docs_v51/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v51/methods/messages_startBot.md +++ b/old_docs/API_docs_v51/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v51/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v51/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v51/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v51/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v51/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v51/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v51/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v51/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v51/methods/photos_getUserPhotos.md b/old_docs/API_docs_v51/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v51/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v51/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v51/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v51/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v51/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v51/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v51/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v51/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v51/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v51/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v51/methods/users_getUsers.md b/old_docs/API_docs_v51/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v51/methods/users_getUsers.md +++ b/old_docs/API_docs_v51/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/account_changePhone.md b/old_docs/API_docs_v53/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v53/methods/account_changePhone.md +++ b/old_docs/API_docs_v53/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_checkUsername.md b/old_docs/API_docs_v53/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v53/methods/account_checkUsername.md +++ b/old_docs/API_docs_v53/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v53/methods/account_deleteAccount.md b/old_docs/API_docs_v53/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v53/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v53/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/account_getNotifySettings.md b/old_docs/API_docs_v53/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v53/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v53/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_getPasswordSettings.md b/old_docs/API_docs_v53/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v53/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v53/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_getPrivacy.md b/old_docs/API_docs_v53/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v53/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v53/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_registerDevice.md b/old_docs/API_docs_v53/methods/account_registerDevice.md index 4e148a7f..cbac71d3 100644 --- a/old_docs/API_docs_v53/methods/account_registerDevice.md +++ b/old_docs/API_docs_v53/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_reportPeer.md b/old_docs/API_docs_v53/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v53/methods/account_reportPeer.md +++ b/old_docs/API_docs_v53/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_resetAuthorization.md b/old_docs/API_docs_v53/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v53/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v53/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v53/methods/account_sendChangePhoneCode.md index bdf7331f..476b6d79 100644 --- a/old_docs/API_docs_v53/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v53/methods/account_sendChangePhoneCode.md @@ -12,9 +12,9 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|Current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_setAccountTTL.md b/old_docs/API_docs_v53/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v53/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v53/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_setPrivacy.md b/old_docs/API_docs_v53/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v53/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v53/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_unregisterDevice.md b/old_docs/API_docs_v53/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v53/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v53/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v53/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v53/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v53/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/account_updateNotifySettings.md b/old_docs/API_docs_v53/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v53/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v53/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v53/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v53/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v53/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_updateProfile.md b/old_docs/API_docs_v53/methods/account_updateProfile.md index 59629188..ef19dc00 100644 --- a/old_docs/API_docs_v53/methods/account_updateProfile.md +++ b/old_docs/API_docs_v53/methods/account_updateProfile.md @@ -12,9 +12,9 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Optional|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Optional|The last name| -|about|[CLICK ME string](../types/string.md) | Optional|The bio/about field| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| ### Return type: [User](../types/User.md) @@ -22,14 +22,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v53/methods/account_updateStatus.md b/old_docs/API_docs_v53/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v53/methods/account_updateStatus.md +++ b/old_docs/API_docs_v53/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v53/methods/account_updateUsername.md b/old_docs/API_docs_v53/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v53/methods/account_updateUsername.md +++ b/old_docs/API_docs_v53/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v53/methods/auth_cancelCode.md b/old_docs/API_docs_v53/methods/auth_cancelCode.md index 52b85d4c..84401c62 100644 --- a/old_docs/API_docs_v53/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v53/methods/auth_cancelCode.md @@ -12,8 +12,8 @@ Invalidate sent phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invalidate sent phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v53/methods/auth_checkPhone.md b/old_docs/API_docs_v53/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v53/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v53/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v53/methods/auth_recoverPassword.md b/old_docs/API_docs_v53/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v53/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v53/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v53/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v53/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v53/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v53/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v53/methods/auth_resendCode.md b/old_docs/API_docs_v53/methods/auth_resendCode.md index 253480a3..4402bfe6 100644 --- a/old_docs/API_docs_v53/methods/auth_resendCode.md +++ b/old_docs/API_docs_v53/methods/auth_resendCode.md @@ -12,8 +12,8 @@ Resend the SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -21,13 +21,6 @@ Resend the SMS verification code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v53/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v53/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v53/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v53/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/auth_sendInvites.md b/old_docs/API_docs_v53/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v53/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v53/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v53/methods/channels_checkUsername.md b/old_docs/API_docs_v53/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v53/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v53/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v53/methods/channels_createChannel.md b/old_docs/API_docs_v53/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v53/methods/channels_createChannel.md +++ b/old_docs/API_docs_v53/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v53/methods/channels_deleteChannel.md b/old_docs/API_docs_v53/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v53/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v53/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v53/methods/channels_deleteMessages.md b/old_docs/API_docs_v53/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v53/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v53/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v53/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v53/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v53/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v53/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v53/methods/channels_editAbout.md b/old_docs/API_docs_v53/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v53/methods/channels_editAbout.md +++ b/old_docs/API_docs_v53/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v53/methods/channels_editAdmin.md b/old_docs/API_docs_v53/methods/channels_editAdmin.md index 7b6cc0f1..62f1fdaa 100644 --- a/old_docs/API_docs_v53/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v53/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v53/methods/channels_editPhoto.md b/old_docs/API_docs_v53/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v53/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v53/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v53/methods/channels_editTitle.md b/old_docs/API_docs_v53/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v53/methods/channels_editTitle.md +++ b/old_docs/API_docs_v53/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v53/methods/channels_exportInvite.md b/old_docs/API_docs_v53/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v53/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v53/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v53/methods/channels_exportMessageLink.md b/old_docs/API_docs_v53/methods/channels_exportMessageLink.md index b4a3c645..20f6e998 100644 --- a/old_docs/API_docs_v53/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v53/methods/channels_exportMessageLink.md @@ -13,7 +13,7 @@ Get the link of a message in a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| +|id|[int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -21,13 +21,6 @@ Get the link of a message in a channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v53/methods/channels_getChannels.md b/old_docs/API_docs_v53/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v53/methods/channels_getChannels.md +++ b/old_docs/API_docs_v53/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v53/methods/channels_getMessages.md b/old_docs/API_docs_v53/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v53/methods/channels_getMessages.md +++ b/old_docs/API_docs_v53/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v53/methods/channels_getParticipant.md b/old_docs/API_docs_v53/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v53/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v53/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v53/methods/channels_getParticipants.md b/old_docs/API_docs_v53/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v53/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v53/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/channels_inviteToChannel.md b/old_docs/API_docs_v53/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v53/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v53/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v53/methods/channels_joinChannel.md b/old_docs/API_docs_v53/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v53/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v53/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v53/methods/channels_kickFromChannel.md b/old_docs/API_docs_v53/methods/channels_kickFromChannel.md index 8f6c92be..0c6c0258 100644 --- a/old_docs/API_docs_v53/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v53/methods/channels_kickFromChannel.md @@ -14,7 +14,7 @@ Kick user from channel |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick| -|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|Kick or unkick?| +|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_leaveChannel.md b/old_docs/API_docs_v53/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v53/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v53/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v53/methods/channels_readHistory.md b/old_docs/API_docs_v53/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v53/methods/channels_readHistory.md +++ b/old_docs/API_docs_v53/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v53/methods/channels_reportSpam.md b/old_docs/API_docs_v53/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v53/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v53/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v53/methods/channels_toggleInvites.md b/old_docs/API_docs_v53/methods/channels_toggleInvites.md index e9e6450d..d437682f 100644 --- a/old_docs/API_docs_v53/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v53/methods/channels_toggleInvites.md @@ -13,7 +13,7 @@ Allow or disallow any user to invite users to this channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Allow or disallow any user to invite users to this channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v53/methods/channels_toggleSignatures.md b/old_docs/API_docs_v53/methods/channels_toggleSignatures.md index 36d1eccb..d40bf67b 100644 --- a/old_docs/API_docs_v53/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v53/methods/channels_toggleSignatures.md @@ -13,7 +13,7 @@ Toggle channel signatures | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Toggle channel signatures ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v53/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v53/methods/channels_updatePinnedMessage.md index f8d10ece..aa2cc783 100644 --- a/old_docs/API_docs_v53/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v53/methods/channels_updatePinnedMessage.md @@ -12,9 +12,9 @@ Set the pinned message of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Set the pinned message of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -81,3 +71,13 @@ Or, if you're into Lua: Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v53/methods/channels_updateUsername.md b/old_docs/API_docs_v53/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v53/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v53/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v53/methods/contacts_block.md b/old_docs/API_docs_v53/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v53/methods/contacts_block.md +++ b/old_docs/API_docs_v53/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v53/methods/contacts_deleteContact.md b/old_docs/API_docs_v53/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v53/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v53/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v53/methods/contacts_deleteContacts.md b/old_docs/API_docs_v53/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v53/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v53/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/contacts_getBlocked.md b/old_docs/API_docs_v53/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v53/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v53/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v53/methods/contacts_getContacts.md b/old_docs/API_docs_v53/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v53/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v53/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v53/methods/contacts_getTopPeers.md b/old_docs/API_docs_v53/methods/contacts_getTopPeers.md index 8d39809c..b5108fd2 100644 --- a/old_docs/API_docs_v53/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v53/methods/contacts_getTopPeers.md @@ -12,14 +12,14 @@ Get most used chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|correspondents|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch users?| -|bots\_pm|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch bots?| -|bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| -|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| -|channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| +|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?| +|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?| +|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?| +|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?| +|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| +|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|limit|[int](../types/int.md) | Yes|How many results to fetch| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| ### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) @@ -27,13 +27,6 @@ Get most used chats ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TYPES_EMPTY|The types field is empty| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ Or, if you're into Lua: contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field is empty| + + diff --git a/old_docs/API_docs_v53/methods/contacts_importCard.md b/old_docs/API_docs_v53/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v53/methods/contacts_importCard.md +++ b/old_docs/API_docs_v53/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v53/methods/contacts_importContacts.md b/old_docs/API_docs_v53/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v53/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v53/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v53/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v53/methods/contacts_resetTopPeerRating.md index 4b5e96f1..15b07f96 100644 --- a/old_docs/API_docs_v53/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v53/methods/contacts_resetTopPeerRating.md @@ -12,7 +12,7 @@ Reset top peer rating for a certain category/peer | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| @@ -21,13 +21,6 @@ Reset top peer rating for a certain category/peer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/contacts_search.md b/old_docs/API_docs_v53/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v53/methods/contacts_search.md +++ b/old_docs/API_docs_v53/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/contacts_unblock.md b/old_docs/API_docs_v53/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v53/methods/contacts_unblock.md +++ b/old_docs/API_docs_v53/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v53/methods/help_getConfig.md b/old_docs/API_docs_v53/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v53/methods/help_getConfig.md +++ b/old_docs/API_docs_v53/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/help_saveAppLog.md b/old_docs/API_docs_v53/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v53/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v53/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/initConnection.md b/old_docs/API_docs_v53/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v53/methods/initConnection.md +++ b/old_docs/API_docs_v53/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v53/methods/invokeAfterMsg.md b/old_docs/API_docs_v53/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v53/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v53/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v53/methods/invokeAfterMsgs.md b/old_docs/API_docs_v53/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v53/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v53/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v53/methods/invokeWithLayer.md b/old_docs/API_docs_v53/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v53/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v53/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v53/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v53/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v53/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v53/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v53/methods/messages_addChatUser.md b/old_docs/API_docs_v53/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v53/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v53/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v53/methods/messages_checkChatInvite.md b/old_docs/API_docs_v53/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v53/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v53/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_createChat.md b/old_docs/API_docs_v53/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v53/methods/messages_createChat.md +++ b/old_docs/API_docs_v53/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v53/methods/messages_deleteChatUser.md b/old_docs/API_docs_v53/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v53/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v53/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v53/methods/messages_deleteHistory.md b/old_docs/API_docs_v53/methods/messages_deleteHistory.md index 45e9890d..601d1876 100644 --- a/old_docs/API_docs_v53/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v53/methods/messages_deleteHistory.md @@ -12,9 +12,9 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|just\_clear|[CLICK ME Bool](../types/Bool.md) | Optional|Only clear it from your side| +|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,13 +22,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_deleteMessages.md b/old_docs/API_docs_v53/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v53/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v53/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v53/methods/messages_editChatAdmin.md b/old_docs/API_docs_v53/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v53/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v53/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_editChatPhoto.md b/old_docs/API_docs_v53/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v53/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v53/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_editChatTitle.md b/old_docs/API_docs_v53/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v53/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v53/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v53/methods/messages_editInlineBotMessage.md index 73c8a2c4..4729b52a 100644 --- a/old_docs/API_docs_v53/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v53/methods/messages_editInlineBotMessage.md @@ -12,11 +12,11 @@ Edit a sent inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,14 +25,6 @@ Edit a sent inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| - - ### MadelineProto Example: @@ -120,3 +112,11 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v53/methods/messages_editMessage.md b/old_docs/API_docs_v53/methods/messages_editMessage.md index ad639325..4380aba6 100644 --- a/old_docs/API_docs_v53/methods/messages_editMessage.md +++ b/old_docs/API_docs_v53/methods/messages_editMessage.md @@ -12,12 +12,12 @@ Edit a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -26,22 +26,6 @@ Edit a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -129,3 +113,19 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v53/methods/messages_exportChatInvite.md b/old_docs/API_docs_v53/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v53/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v53/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_forwardMessage.md b/old_docs/API_docs_v53/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v53/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v53/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v53/methods/messages_forwardMessages.md b/old_docs/API_docs_v53/methods/messages_forwardMessages.md index 8922a1ea..7371e80c 100644 --- a/old_docs/API_docs_v53/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v53/methods/messages_forwardMessages.md @@ -12,10 +12,10 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -24,34 +24,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -105,3 +77,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({silent=Bool, background=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/messages_getAllStickers.md b/old_docs/API_docs_v53/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v53/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v53/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v53/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v53/methods/messages_getBotCallbackAnswer.md index 01ae3ac9..9325dc2b 100644 --- a/old_docs/API_docs_v53/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v53/methods/messages_getBotCallbackAnswer.md @@ -13,8 +13,8 @@ Get the callback answer of a bot (after clicking a button) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|data|[CLICK ME bytes](../types/bytes.md) | Yes|The data to send to the bot| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Yes|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) @@ -22,17 +22,6 @@ Get the callback answer of a bot (after clicking a button) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|DATA_INVALID|Encrypted data invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -73,3 +62,14 @@ Or, if you're into Lua: messages_BotCallbackAnswer = messages.getBotCallbackAnswer({peer=InputPeer, msg_id=int, data='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/messages_getChats.md b/old_docs/API_docs_v53/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v53/methods/messages_getChats.md +++ b/old_docs/API_docs_v53/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_getDialogs.md b/old_docs/API_docs_v53/methods/messages_getDialogs.md index bd3ef681..623f002a 100644 --- a/old_docs/API_docs_v53/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v53/methods/messages_getDialogs.md @@ -12,10 +12,10 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -23,16 +23,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v53/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v53/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v53/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_getHistory.md b/old_docs/API_docs_v53/methods/messages_getHistory.md index 851d2680..86a744cf 100644 --- a/old_docs/API_docs_v53/methods/messages_getHistory.md +++ b/old_docs/API_docs_v53/methods/messages_getHistory.md @@ -13,12 +13,12 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -26,18 +26,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v53/methods/messages_getInlineBotResults.md index 4d86caf5..207624a7 100644 --- a/old_docs/API_docs_v53/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v53/methods/messages_getInlineBotResults.md @@ -14,9 +14,9 @@ Call inline bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -24,16 +24,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/messages_getMessageEditData.md b/old_docs/API_docs_v53/methods/messages_getMessageEditData.md index 34f8534f..00c63d28 100644 --- a/old_docs/API_docs_v53/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v53/methods/messages_getMessageEditData.md @@ -13,7 +13,7 @@ Check if about to edit a message or a media caption | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) @@ -21,14 +21,6 @@ Check if about to edit a message or a media caption ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v53/methods/messages_getMessages.md b/old_docs/API_docs_v53/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v53/methods/messages_getMessages.md +++ b/old_docs/API_docs_v53/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v53/methods/messages_getMessagesViews.md b/old_docs/API_docs_v53/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v53/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v53/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v53/methods/messages_getPeerDialogs.md index 063b6e7d..000e8eb6 100644 --- a/old_docs/API_docs_v53/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v53/methods/messages_getPeerDialogs.md @@ -20,14 +20,6 @@ Get dialog info of peers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: messages_PeerDialogs = messages.getPeerDialogs({peers={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_getPeerSettings.md b/old_docs/API_docs_v53/methods/messages_getPeerSettings.md index a18126f0..5a3e9349 100644 --- a/old_docs/API_docs_v53/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v53/methods/messages_getPeerSettings.md @@ -20,14 +20,6 @@ Get the settings of apeer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: PeerSettings = messages.getPeerSettings({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_getSavedGifs.md b/old_docs/API_docs_v53/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v53/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v53/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v53/methods/messages_getStickerSet.md b/old_docs/API_docs_v53/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v53/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v53/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_getStickers.md b/old_docs/API_docs_v53/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v53/methods/messages_getStickers.md +++ b/old_docs/API_docs_v53/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v53/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v53/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v53/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v53/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v53/methods/messages_hideReportSpam.md b/old_docs/API_docs_v53/methods/messages_hideReportSpam.md index 30523f2a..0bf711ea 100644 --- a/old_docs/API_docs_v53/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v53/methods/messages_hideReportSpam.md @@ -20,13 +20,6 @@ Hide report spam popup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.hideReportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_importChatInvite.md b/old_docs/API_docs_v53/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v53/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v53/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v53/methods/messages_installStickerSet.md b/old_docs/API_docs_v53/methods/messages_installStickerSet.md index 77c5a2a5..c807ba66 100644 --- a/old_docs/API_docs_v53/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v53/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|Disable stickerset?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.installStickerSet({stickerset=InputStickerSet, disabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_migrateChat.md b/old_docs/API_docs_v53/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v53/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v53/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v53/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v53/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v53/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v53/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v53/methods/messages_readHistory.md b/old_docs/API_docs_v53/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v53/methods/messages_readHistory.md +++ b/old_docs/API_docs_v53/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/messages_readMessageContents.md b/old_docs/API_docs_v53/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v53/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v53/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v53/methods/messages_receivedMessages.md b/old_docs/API_docs_v53/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v53/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v53/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v53/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v53/methods/messages_reorderStickerSets.md index 90913e5d..53930d4f 100644 --- a/old_docs/API_docs_v53/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v53/methods/messages_reorderStickerSets.md @@ -12,7 +12,7 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_reportSpam.md b/old_docs/API_docs_v53/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v53/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v53/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_saveDraft.md b/old_docs/API_docs_v53/methods/messages_saveDraft.md index 59b33b03..60d72c1e 100644 --- a/old_docs/API_docs_v53/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v53/methods/messages_saveDraft.md @@ -12,11 +12,11 @@ Save a message draft | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,13 +25,6 @@ Save a message draft ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -104,3 +97,10 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_saveGif.md b/old_docs/API_docs_v53/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v53/methods/messages_saveGif.md +++ b/old_docs/API_docs_v53/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_search.md b/old_docs/API_docs_v53/methods/messages_search.md index 735ddf47..63d58b40 100644 --- a/old_docs/API_docs_v53/methods/messages_search.md +++ b/old_docs/API_docs_v53/methods/messages_search.md @@ -13,13 +13,13 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,19 +27,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -90,3 +77,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_searchGifs.md b/old_docs/API_docs_v53/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v53/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v53/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v53/methods/messages_searchGlobal.md b/old_docs/API_docs_v53/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v53/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v53/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v53/methods/messages_sendBroadcast.md b/old_docs/API_docs_v53/methods/messages_sendBroadcast.md index 6cff8b29..8eca8090 100644 --- a/old_docs/API_docs_v53/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v53/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v53/methods/messages_sendEncrypted.md b/old_docs/API_docs_v53/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v53/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v53/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v53/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v53/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v53/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v53/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v53/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v53/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v53/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v53/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v53/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v53/methods/messages_sendInlineBotResult.md index 758aa97f..d1f9fbd0 100644 --- a/old_docs/API_docs_v53/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v53/methods/messages_sendInlineBotResult.md @@ -12,13 +12,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -26,18 +26,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v53/methods/messages_sendMedia.md b/old_docs/API_docs_v53/methods/messages_sendMedia.md index 770d1b65..94e27b83 100644 --- a/old_docs/API_docs_v53/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v53/methods/messages_sendMedia.md @@ -12,13 +12,13 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -26,34 +26,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -117,3 +89,31 @@ Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, pe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/messages_sendMessage.md b/old_docs/API_docs_v53/methods/messages_sendMessage.md index 83dc6c8b..ba76f230 100644 --- a/old_docs/API_docs_v53/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v53/methods/messages_sendMessage.md @@ -12,15 +12,15 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,33 +29,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -143,3 +116,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v53/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v53/methods/messages_setBotCallbackAnswer.md index f15699a0..66e3bc0e 100644 --- a/old_docs/API_docs_v53/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v53/methods/messages_setBotCallbackAnswer.md @@ -12,9 +12,9 @@ Bots only: set the callback answer (after a button was clicked) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|message|[CLICK ME string](../types/string.md) | Optional|The message| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set the callback answer (after a button was clicked) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v53/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v53/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v53/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v53/methods/messages_setInlineBotResults.md index d4ba6e65..e46598e2 100644 --- a/old_docs/API_docs_v53/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v53/methods/messages_setInlineBotResults.md @@ -12,13 +12,13 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) @@ -26,23 +26,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -100,3 +83,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v53/methods/messages_setTyping.md b/old_docs/API_docs_v53/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v53/methods/messages_setTyping.md +++ b/old_docs/API_docs_v53/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v53/methods/messages_startBot.md b/old_docs/API_docs_v53/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v53/methods/messages_startBot.md +++ b/old_docs/API_docs_v53/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v53/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v53/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v53/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v53/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v53/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v53/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v53/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v53/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v53/methods/photos_getUserPhotos.md b/old_docs/API_docs_v53/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v53/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v53/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v53/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v53/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v53/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v53/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v53/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v53/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v53/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v53/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v53/methods/users_getUsers.md b/old_docs/API_docs_v53/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v53/methods/users_getUsers.md +++ b/old_docs/API_docs_v53/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/account_changePhone.md b/old_docs/API_docs_v55/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v55/methods/account_changePhone.md +++ b/old_docs/API_docs_v55/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_checkUsername.md b/old_docs/API_docs_v55/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v55/methods/account_checkUsername.md +++ b/old_docs/API_docs_v55/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v55/methods/account_confirmPhone.md b/old_docs/API_docs_v55/methods/account_confirmPhone.md index 68490f35..7ffabc24 100644 --- a/old_docs/API_docs_v55/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v55/methods/account_confirmPhone.md @@ -12,8 +12,8 @@ Confirm this phone number is associated to this account, obtain phone_code_hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| +|phone\_code\_hash|[string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Confirm this phone number is associated to this account, obtain phone_code_hash ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_HASH_INVALID|Code hash invalid| -|PHONE_CODE_EMPTY|phone_code is missing| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_HASH_INVALID|Code hash invalid| +|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/old_docs/API_docs_v55/methods/account_deleteAccount.md b/old_docs/API_docs_v55/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v55/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v55/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/account_getNotifySettings.md b/old_docs/API_docs_v55/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v55/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v55/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_getPasswordSettings.md b/old_docs/API_docs_v55/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v55/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v55/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_getPrivacy.md b/old_docs/API_docs_v55/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v55/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v55/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_registerDevice.md b/old_docs/API_docs_v55/methods/account_registerDevice.md index 4e148a7f..cbac71d3 100644 --- a/old_docs/API_docs_v55/methods/account_registerDevice.md +++ b/old_docs/API_docs_v55/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_reportPeer.md b/old_docs/API_docs_v55/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v55/methods/account_reportPeer.md +++ b/old_docs/API_docs_v55/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_resetAuthorization.md b/old_docs/API_docs_v55/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v55/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v55/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v55/methods/account_sendChangePhoneCode.md index bdf7331f..476b6d79 100644 --- a/old_docs/API_docs_v55/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v55/methods/account_sendChangePhoneCode.md @@ -12,9 +12,9 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|Current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v55/methods/account_sendConfirmPhoneCode.md index 86035d19..8917355f 100644 --- a/old_docs/API_docs_v55/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v55/methods/account_sendConfirmPhoneCode.md @@ -12,9 +12,9 @@ Send confirmation phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| -|hash|[CLICK ME string](../types/string.md) | Yes|The hash| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|The current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| +|hash|[string](../types/string.md) | Yes|The hash| +|current\_number|[Bool](../types/Bool.md) | Optional|The current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Send confirmation phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendConfirmPhoneCode({allow_flashcall=Bool, hash='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_setAccountTTL.md b/old_docs/API_docs_v55/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v55/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v55/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_setPrivacy.md b/old_docs/API_docs_v55/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v55/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v55/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_unregisterDevice.md b/old_docs/API_docs_v55/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v55/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v55/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v55/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v55/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v55/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/account_updateNotifySettings.md b/old_docs/API_docs_v55/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v55/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v55/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v55/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v55/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v55/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_updateProfile.md b/old_docs/API_docs_v55/methods/account_updateProfile.md index 59629188..ef19dc00 100644 --- a/old_docs/API_docs_v55/methods/account_updateProfile.md +++ b/old_docs/API_docs_v55/methods/account_updateProfile.md @@ -12,9 +12,9 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Optional|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Optional|The last name| -|about|[CLICK ME string](../types/string.md) | Optional|The bio/about field| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| ### Return type: [User](../types/User.md) @@ -22,14 +22,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v55/methods/account_updateStatus.md b/old_docs/API_docs_v55/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v55/methods/account_updateStatus.md +++ b/old_docs/API_docs_v55/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v55/methods/account_updateUsername.md b/old_docs/API_docs_v55/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v55/methods/account_updateUsername.md +++ b/old_docs/API_docs_v55/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v55/methods/auth_cancelCode.md b/old_docs/API_docs_v55/methods/auth_cancelCode.md index 52b85d4c..84401c62 100644 --- a/old_docs/API_docs_v55/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v55/methods/auth_cancelCode.md @@ -12,8 +12,8 @@ Invalidate sent phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invalidate sent phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v55/methods/auth_checkPhone.md b/old_docs/API_docs_v55/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v55/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v55/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v55/methods/auth_recoverPassword.md b/old_docs/API_docs_v55/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v55/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v55/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v55/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v55/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v55/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v55/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v55/methods/auth_resendCode.md b/old_docs/API_docs_v55/methods/auth_resendCode.md index 253480a3..4402bfe6 100644 --- a/old_docs/API_docs_v55/methods/auth_resendCode.md +++ b/old_docs/API_docs_v55/methods/auth_resendCode.md @@ -12,8 +12,8 @@ Resend the SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -21,13 +21,6 @@ Resend the SMS verification code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v55/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v55/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v55/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v55/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/auth_sendInvites.md b/old_docs/API_docs_v55/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v55/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v55/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v55/methods/channels_checkUsername.md b/old_docs/API_docs_v55/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v55/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v55/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v55/methods/channels_createChannel.md b/old_docs/API_docs_v55/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v55/methods/channels_createChannel.md +++ b/old_docs/API_docs_v55/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v55/methods/channels_deleteChannel.md b/old_docs/API_docs_v55/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v55/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v55/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v55/methods/channels_deleteMessages.md b/old_docs/API_docs_v55/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v55/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v55/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v55/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v55/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v55/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v55/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v55/methods/channels_editAbout.md b/old_docs/API_docs_v55/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v55/methods/channels_editAbout.md +++ b/old_docs/API_docs_v55/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v55/methods/channels_editAdmin.md b/old_docs/API_docs_v55/methods/channels_editAdmin.md index 7b6cc0f1..62f1fdaa 100644 --- a/old_docs/API_docs_v55/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v55/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v55/methods/channels_editPhoto.md b/old_docs/API_docs_v55/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v55/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v55/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v55/methods/channels_editTitle.md b/old_docs/API_docs_v55/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v55/methods/channels_editTitle.md +++ b/old_docs/API_docs_v55/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v55/methods/channels_exportInvite.md b/old_docs/API_docs_v55/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v55/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v55/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v55/methods/channels_exportMessageLink.md b/old_docs/API_docs_v55/methods/channels_exportMessageLink.md index b4a3c645..20f6e998 100644 --- a/old_docs/API_docs_v55/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v55/methods/channels_exportMessageLink.md @@ -13,7 +13,7 @@ Get the link of a message in a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| +|id|[int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -21,13 +21,6 @@ Get the link of a message in a channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v55/methods/channels_getChannels.md b/old_docs/API_docs_v55/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v55/methods/channels_getChannels.md +++ b/old_docs/API_docs_v55/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v55/methods/channels_getMessages.md b/old_docs/API_docs_v55/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v55/methods/channels_getMessages.md +++ b/old_docs/API_docs_v55/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v55/methods/channels_getParticipant.md b/old_docs/API_docs_v55/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v55/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v55/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v55/methods/channels_getParticipants.md b/old_docs/API_docs_v55/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v55/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v55/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/channels_inviteToChannel.md b/old_docs/API_docs_v55/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v55/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v55/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v55/methods/channels_joinChannel.md b/old_docs/API_docs_v55/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v55/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v55/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v55/methods/channels_kickFromChannel.md b/old_docs/API_docs_v55/methods/channels_kickFromChannel.md index 8f6c92be..0c6c0258 100644 --- a/old_docs/API_docs_v55/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v55/methods/channels_kickFromChannel.md @@ -14,7 +14,7 @@ Kick user from channel |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick| -|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|Kick or unkick?| +|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_leaveChannel.md b/old_docs/API_docs_v55/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v55/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v55/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v55/methods/channels_readHistory.md b/old_docs/API_docs_v55/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v55/methods/channels_readHistory.md +++ b/old_docs/API_docs_v55/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v55/methods/channels_reportSpam.md b/old_docs/API_docs_v55/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v55/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v55/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v55/methods/channels_toggleInvites.md b/old_docs/API_docs_v55/methods/channels_toggleInvites.md index e9e6450d..d437682f 100644 --- a/old_docs/API_docs_v55/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v55/methods/channels_toggleInvites.md @@ -13,7 +13,7 @@ Allow or disallow any user to invite users to this channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Allow or disallow any user to invite users to this channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v55/methods/channels_toggleSignatures.md b/old_docs/API_docs_v55/methods/channels_toggleSignatures.md index 36d1eccb..d40bf67b 100644 --- a/old_docs/API_docs_v55/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v55/methods/channels_toggleSignatures.md @@ -13,7 +13,7 @@ Toggle channel signatures | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Toggle channel signatures ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v55/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v55/methods/channels_updatePinnedMessage.md index f8d10ece..aa2cc783 100644 --- a/old_docs/API_docs_v55/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v55/methods/channels_updatePinnedMessage.md @@ -12,9 +12,9 @@ Set the pinned message of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Set the pinned message of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -81,3 +71,13 @@ Or, if you're into Lua: Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v55/methods/channels_updateUsername.md b/old_docs/API_docs_v55/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v55/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v55/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v55/methods/contacts_block.md b/old_docs/API_docs_v55/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v55/methods/contacts_block.md +++ b/old_docs/API_docs_v55/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v55/methods/contacts_deleteContact.md b/old_docs/API_docs_v55/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v55/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v55/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v55/methods/contacts_deleteContacts.md b/old_docs/API_docs_v55/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v55/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v55/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/contacts_getBlocked.md b/old_docs/API_docs_v55/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v55/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v55/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v55/methods/contacts_getContacts.md b/old_docs/API_docs_v55/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v55/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v55/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v55/methods/contacts_getTopPeers.md b/old_docs/API_docs_v55/methods/contacts_getTopPeers.md index 8d39809c..b5108fd2 100644 --- a/old_docs/API_docs_v55/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v55/methods/contacts_getTopPeers.md @@ -12,14 +12,14 @@ Get most used chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|correspondents|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch users?| -|bots\_pm|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch bots?| -|bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| -|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| -|channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| +|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?| +|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?| +|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?| +|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?| +|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| +|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|limit|[int](../types/int.md) | Yes|How many results to fetch| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| ### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) @@ -27,13 +27,6 @@ Get most used chats ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TYPES_EMPTY|The types field is empty| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ Or, if you're into Lua: contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field is empty| + + diff --git a/old_docs/API_docs_v55/methods/contacts_importCard.md b/old_docs/API_docs_v55/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v55/methods/contacts_importCard.md +++ b/old_docs/API_docs_v55/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v55/methods/contacts_importContacts.md b/old_docs/API_docs_v55/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v55/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v55/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v55/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v55/methods/contacts_resetTopPeerRating.md index 4b5e96f1..15b07f96 100644 --- a/old_docs/API_docs_v55/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v55/methods/contacts_resetTopPeerRating.md @@ -12,7 +12,7 @@ Reset top peer rating for a certain category/peer | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| @@ -21,13 +21,6 @@ Reset top peer rating for a certain category/peer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/contacts_search.md b/old_docs/API_docs_v55/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v55/methods/contacts_search.md +++ b/old_docs/API_docs_v55/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/contacts_unblock.md b/old_docs/API_docs_v55/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v55/methods/contacts_unblock.md +++ b/old_docs/API_docs_v55/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v55/methods/help_getConfig.md b/old_docs/API_docs_v55/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v55/methods/help_getConfig.md +++ b/old_docs/API_docs_v55/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/help_saveAppLog.md b/old_docs/API_docs_v55/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v55/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v55/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/initConnection.md b/old_docs/API_docs_v55/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v55/methods/initConnection.md +++ b/old_docs/API_docs_v55/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v55/methods/invokeAfterMsg.md b/old_docs/API_docs_v55/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v55/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v55/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v55/methods/invokeAfterMsgs.md b/old_docs/API_docs_v55/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v55/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v55/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v55/methods/invokeWithLayer.md b/old_docs/API_docs_v55/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v55/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v55/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v55/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v55/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v55/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v55/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v55/methods/messages_addChatUser.md b/old_docs/API_docs_v55/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v55/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v55/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v55/methods/messages_checkChatInvite.md b/old_docs/API_docs_v55/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v55/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v55/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_createChat.md b/old_docs/API_docs_v55/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v55/methods/messages_createChat.md +++ b/old_docs/API_docs_v55/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v55/methods/messages_deleteChatUser.md b/old_docs/API_docs_v55/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v55/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v55/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v55/methods/messages_deleteHistory.md b/old_docs/API_docs_v55/methods/messages_deleteHistory.md index 45e9890d..601d1876 100644 --- a/old_docs/API_docs_v55/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v55/methods/messages_deleteHistory.md @@ -12,9 +12,9 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|just\_clear|[CLICK ME Bool](../types/Bool.md) | Optional|Only clear it from your side| +|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,13 +22,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_deleteMessages.md b/old_docs/API_docs_v55/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v55/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v55/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v55/methods/messages_editChatAdmin.md b/old_docs/API_docs_v55/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v55/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v55/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_editChatPhoto.md b/old_docs/API_docs_v55/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v55/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v55/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_editChatTitle.md b/old_docs/API_docs_v55/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v55/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v55/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v55/methods/messages_editInlineBotMessage.md index 73c8a2c4..4729b52a 100644 --- a/old_docs/API_docs_v55/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v55/methods/messages_editInlineBotMessage.md @@ -12,11 +12,11 @@ Edit a sent inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,14 +25,6 @@ Edit a sent inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| - - ### MadelineProto Example: @@ -120,3 +112,11 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v55/methods/messages_editMessage.md b/old_docs/API_docs_v55/methods/messages_editMessage.md index ad639325..4380aba6 100644 --- a/old_docs/API_docs_v55/methods/messages_editMessage.md +++ b/old_docs/API_docs_v55/methods/messages_editMessage.md @@ -12,12 +12,12 @@ Edit a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -26,22 +26,6 @@ Edit a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -129,3 +113,19 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v55/methods/messages_exportChatInvite.md b/old_docs/API_docs_v55/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v55/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v55/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_forwardMessage.md b/old_docs/API_docs_v55/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v55/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v55/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v55/methods/messages_forwardMessages.md b/old_docs/API_docs_v55/methods/messages_forwardMessages.md index 8922a1ea..7371e80c 100644 --- a/old_docs/API_docs_v55/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v55/methods/messages_forwardMessages.md @@ -12,10 +12,10 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -24,34 +24,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -105,3 +77,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({silent=Bool, background=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/messages_getAllStickers.md b/old_docs/API_docs_v55/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v55/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v55/methods/messages_getArchivedStickers.md index 3dfe8f2c..9f0387ec 100644 --- a/old_docs/API_docs_v55/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getArchivedStickers.md @@ -12,8 +12,8 @@ Get all archived stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| +|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| +|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v55/methods/messages_getBotCallbackAnswer.md index 01ae3ac9..9325dc2b 100644 --- a/old_docs/API_docs_v55/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v55/methods/messages_getBotCallbackAnswer.md @@ -13,8 +13,8 @@ Get the callback answer of a bot (after clicking a button) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|data|[CLICK ME bytes](../types/bytes.md) | Yes|The data to send to the bot| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Yes|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) @@ -22,17 +22,6 @@ Get the callback answer of a bot (after clicking a button) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|DATA_INVALID|Encrypted data invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -73,3 +62,14 @@ Or, if you're into Lua: messages_BotCallbackAnswer = messages.getBotCallbackAnswer({peer=InputPeer, msg_id=int, data='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/messages_getChats.md b/old_docs/API_docs_v55/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v55/methods/messages_getChats.md +++ b/old_docs/API_docs_v55/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_getDialogs.md b/old_docs/API_docs_v55/methods/messages_getDialogs.md index bd3ef681..623f002a 100644 --- a/old_docs/API_docs_v55/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v55/methods/messages_getDialogs.md @@ -12,10 +12,10 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -23,16 +23,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v55/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v55/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v55/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v55/methods/messages_getFeaturedStickers.md index 8e49e1ef..af7f69a0 100644 --- a/old_docs/API_docs_v55/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getFeaturedStickers.md @@ -12,7 +12,7 @@ Get featured stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getHistory.md b/old_docs/API_docs_v55/methods/messages_getHistory.md index 851d2680..86a744cf 100644 --- a/old_docs/API_docs_v55/methods/messages_getHistory.md +++ b/old_docs/API_docs_v55/methods/messages_getHistory.md @@ -13,12 +13,12 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -26,18 +26,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v55/methods/messages_getInlineBotResults.md index 4d86caf5..207624a7 100644 --- a/old_docs/API_docs_v55/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v55/methods/messages_getInlineBotResults.md @@ -14,9 +14,9 @@ Call inline bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -24,16 +24,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/messages_getMessageEditData.md b/old_docs/API_docs_v55/methods/messages_getMessageEditData.md index 34f8534f..00c63d28 100644 --- a/old_docs/API_docs_v55/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v55/methods/messages_getMessageEditData.md @@ -13,7 +13,7 @@ Check if about to edit a message or a media caption | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) @@ -21,14 +21,6 @@ Check if about to edit a message or a media caption ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v55/methods/messages_getMessages.md b/old_docs/API_docs_v55/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v55/methods/messages_getMessages.md +++ b/old_docs/API_docs_v55/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v55/methods/messages_getMessagesViews.md b/old_docs/API_docs_v55/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v55/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v55/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v55/methods/messages_getPeerDialogs.md index 063b6e7d..000e8eb6 100644 --- a/old_docs/API_docs_v55/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v55/methods/messages_getPeerDialogs.md @@ -20,14 +20,6 @@ Get dialog info of peers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: messages_PeerDialogs = messages.getPeerDialogs({peers={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_getPeerSettings.md b/old_docs/API_docs_v55/methods/messages_getPeerSettings.md index a18126f0..5a3e9349 100644 --- a/old_docs/API_docs_v55/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v55/methods/messages_getPeerSettings.md @@ -20,14 +20,6 @@ Get the settings of apeer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: PeerSettings = messages.getPeerSettings({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_getRecentStickers.md b/old_docs/API_docs_v55/methods/messages_getRecentStickers.md index d58efb1b..6c726ce5 100644 --- a/old_docs/API_docs_v55/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getRecentStickers.md @@ -12,7 +12,7 @@ Get recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getSavedGifs.md b/old_docs/API_docs_v55/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v55/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v55/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v55/methods/messages_getStickerSet.md b/old_docs/API_docs_v55/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v55/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v55/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_getStickers.md b/old_docs/API_docs_v55/methods/messages_getStickers.md index d2ea57cf..685e1b06 100644 --- a/old_docs/API_docs_v55/methods/messages_getStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getStickers.md @@ -12,8 +12,8 @@ Get stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| -|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getUnusedStickers.md b/old_docs/API_docs_v55/methods/messages_getUnusedStickers.md index 6ccf59a4..5b003c88 100644 --- a/old_docs/API_docs_v55/methods/messages_getUnusedStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getUnusedStickers.md @@ -12,7 +12,7 @@ Get unused stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v55/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v55/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v55/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v55/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v55/methods/messages_hideReportSpam.md b/old_docs/API_docs_v55/methods/messages_hideReportSpam.md index 30523f2a..0bf711ea 100644 --- a/old_docs/API_docs_v55/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v55/methods/messages_hideReportSpam.md @@ -20,13 +20,6 @@ Hide report spam popup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.hideReportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_importChatInvite.md b/old_docs/API_docs_v55/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v55/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v55/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v55/methods/messages_installStickerSet.md b/old_docs/API_docs_v55/methods/messages_installStickerSet.md index 20f90b71..d6caf555 100644 --- a/old_docs/API_docs_v55/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v55/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_migrateChat.md b/old_docs/API_docs_v55/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v55/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v55/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v55/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v55/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v55/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v55/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v55/methods/messages_readHistory.md b/old_docs/API_docs_v55/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v55/methods/messages_readHistory.md +++ b/old_docs/API_docs_v55/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/messages_readMessageContents.md b/old_docs/API_docs_v55/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v55/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v55/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v55/methods/messages_receivedMessages.md b/old_docs/API_docs_v55/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v55/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v55/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v55/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v55/methods/messages_reorderStickerSets.md index 90913e5d..53930d4f 100644 --- a/old_docs/API_docs_v55/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v55/methods/messages_reorderStickerSets.md @@ -12,7 +12,7 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_reportSpam.md b/old_docs/API_docs_v55/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v55/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v55/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_saveDraft.md b/old_docs/API_docs_v55/methods/messages_saveDraft.md index 59b33b03..60d72c1e 100644 --- a/old_docs/API_docs_v55/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v55/methods/messages_saveDraft.md @@ -12,11 +12,11 @@ Save a message draft | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,13 +25,6 @@ Save a message draft ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -104,3 +97,10 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_saveGif.md b/old_docs/API_docs_v55/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v55/methods/messages_saveGif.md +++ b/old_docs/API_docs_v55/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v55/methods/messages_saveRecentSticker.md index e3c5ef54..99db3966 100644 --- a/old_docs/API_docs_v55/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v55/methods/messages_saveRecentSticker.md @@ -13,7 +13,7 @@ Add a sticker to recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker to recent stickers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveRecentSticker({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_search.md b/old_docs/API_docs_v55/methods/messages_search.md index 735ddf47..63d58b40 100644 --- a/old_docs/API_docs_v55/methods/messages_search.md +++ b/old_docs/API_docs_v55/methods/messages_search.md @@ -13,13 +13,13 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,19 +27,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -90,3 +77,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_searchGifs.md b/old_docs/API_docs_v55/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v55/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v55/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v55/methods/messages_searchGlobal.md b/old_docs/API_docs_v55/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v55/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v55/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v55/methods/messages_sendBroadcast.md b/old_docs/API_docs_v55/methods/messages_sendBroadcast.md index 6cff8b29..8eca8090 100644 --- a/old_docs/API_docs_v55/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v55/methods/messages_sendBroadcast.md @@ -13,7 +13,7 @@ Send a message to all users in the chat list | Name | Type | Required | Description | |----------|---------------|----------|-------------| |contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[CLICK ME string](../types/string.md) | Yes|The message| +|message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| diff --git a/old_docs/API_docs_v55/methods/messages_sendEncrypted.md b/old_docs/API_docs_v55/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v55/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v55/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v55/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v55/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v55/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v55/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v55/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v55/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v55/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v55/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v55/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v55/methods/messages_sendInlineBotResult.md index 758aa97f..d1f9fbd0 100644 --- a/old_docs/API_docs_v55/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v55/methods/messages_sendInlineBotResult.md @@ -12,13 +12,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -26,18 +26,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v55/methods/messages_sendMedia.md b/old_docs/API_docs_v55/methods/messages_sendMedia.md index 770d1b65..94e27b83 100644 --- a/old_docs/API_docs_v55/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v55/methods/messages_sendMedia.md @@ -12,13 +12,13 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -26,34 +26,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -117,3 +89,31 @@ Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, pe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/messages_sendMessage.md b/old_docs/API_docs_v55/methods/messages_sendMessage.md index 83dc6c8b..ba76f230 100644 --- a/old_docs/API_docs_v55/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v55/methods/messages_sendMessage.md @@ -12,15 +12,15 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,33 +29,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -143,3 +116,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v55/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v55/methods/messages_setBotCallbackAnswer.md index b9993826..3d73a778 100644 --- a/old_docs/API_docs_v55/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v55/methods/messages_setBotCallbackAnswer.md @@ -12,10 +12,10 @@ Bots only: set the callback answer (after a button was clicked) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|message|[CLICK ME string](../types/string.md) | Optional|The message| -|url|[CLICK ME string](../types/string.md) | Optional|The URL| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| +|url|[string](../types/string.md) | Optional|The URL| ### Return type: [Bool](../types/Bool.md) @@ -23,13 +23,6 @@ Bots only: set the callback answer (after a button was clicked) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -87,3 +80,10 @@ Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v55/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v55/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v55/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v55/methods/messages_setInlineBotResults.md index d4ba6e65..e46598e2 100644 --- a/old_docs/API_docs_v55/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v55/methods/messages_setInlineBotResults.md @@ -12,13 +12,13 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) @@ -26,23 +26,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -100,3 +83,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v55/methods/messages_setTyping.md b/old_docs/API_docs_v55/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v55/methods/messages_setTyping.md +++ b/old_docs/API_docs_v55/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v55/methods/messages_startBot.md b/old_docs/API_docs_v55/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v55/methods/messages_startBot.md +++ b/old_docs/API_docs_v55/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v55/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v55/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v55/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v55/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v55/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v55/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v55/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v55/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v55/methods/photos_getUserPhotos.md b/old_docs/API_docs_v55/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v55/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v55/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v55/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v55/methods/photos_updateProfilePhoto.md index 4c5c517f..65423f2b 100644 --- a/old_docs/API_docs_v55/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v55/methods/photos_updateProfilePhoto.md @@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v55/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v55/methods/photos_uploadProfilePhoto.md index 3d7d301b..b0412f27 100644 --- a/old_docs/API_docs_v55/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v55/methods/photos_uploadProfilePhoto.md @@ -13,9 +13,9 @@ Upload profile photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[CLICK ME string](../types/string.md) | Yes|Caption type| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +|caption|[string](../types/string.md) | Yes|Caption type| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| ### Return type: [photos\_Photo](../types/photos_Photo.md) @@ -23,16 +23,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v55/methods/users_getUsers.md b/old_docs/API_docs_v55/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v55/methods/users_getUsers.md +++ b/old_docs/API_docs_v55/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/account_changePhone.md b/old_docs/API_docs_v57/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v57/methods/account_changePhone.md +++ b/old_docs/API_docs_v57/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_checkUsername.md b/old_docs/API_docs_v57/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v57/methods/account_checkUsername.md +++ b/old_docs/API_docs_v57/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v57/methods/account_confirmPhone.md b/old_docs/API_docs_v57/methods/account_confirmPhone.md index 68490f35..7ffabc24 100644 --- a/old_docs/API_docs_v57/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v57/methods/account_confirmPhone.md @@ -12,8 +12,8 @@ Confirm this phone number is associated to this account, obtain phone_code_hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| +|phone\_code\_hash|[string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Confirm this phone number is associated to this account, obtain phone_code_hash ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_HASH_INVALID|Code hash invalid| -|PHONE_CODE_EMPTY|phone_code is missing| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_HASH_INVALID|Code hash invalid| +|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/old_docs/API_docs_v57/methods/account_deleteAccount.md b/old_docs/API_docs_v57/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v57/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v57/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/account_getNotifySettings.md b/old_docs/API_docs_v57/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v57/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v57/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_getPasswordSettings.md b/old_docs/API_docs_v57/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v57/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v57/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_getPrivacy.md b/old_docs/API_docs_v57/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v57/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v57/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_registerDevice.md b/old_docs/API_docs_v57/methods/account_registerDevice.md index 4e148a7f..cbac71d3 100644 --- a/old_docs/API_docs_v57/methods/account_registerDevice.md +++ b/old_docs/API_docs_v57/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_reportPeer.md b/old_docs/API_docs_v57/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v57/methods/account_reportPeer.md +++ b/old_docs/API_docs_v57/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_resetAuthorization.md b/old_docs/API_docs_v57/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v57/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v57/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v57/methods/account_sendChangePhoneCode.md index bdf7331f..476b6d79 100644 --- a/old_docs/API_docs_v57/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v57/methods/account_sendChangePhoneCode.md @@ -12,9 +12,9 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|Current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v57/methods/account_sendConfirmPhoneCode.md index 86035d19..8917355f 100644 --- a/old_docs/API_docs_v57/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v57/methods/account_sendConfirmPhoneCode.md @@ -12,9 +12,9 @@ Send confirmation phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| -|hash|[CLICK ME string](../types/string.md) | Yes|The hash| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|The current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| +|hash|[string](../types/string.md) | Yes|The hash| +|current\_number|[Bool](../types/Bool.md) | Optional|The current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Send confirmation phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendConfirmPhoneCode({allow_flashcall=Bool, hash='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_setAccountTTL.md b/old_docs/API_docs_v57/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v57/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v57/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_setPrivacy.md b/old_docs/API_docs_v57/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v57/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v57/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_unregisterDevice.md b/old_docs/API_docs_v57/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v57/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v57/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v57/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v57/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v57/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/account_updateNotifySettings.md b/old_docs/API_docs_v57/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v57/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v57/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v57/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v57/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v57/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_updateProfile.md b/old_docs/API_docs_v57/methods/account_updateProfile.md index 59629188..ef19dc00 100644 --- a/old_docs/API_docs_v57/methods/account_updateProfile.md +++ b/old_docs/API_docs_v57/methods/account_updateProfile.md @@ -12,9 +12,9 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Optional|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Optional|The last name| -|about|[CLICK ME string](../types/string.md) | Optional|The bio/about field| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| ### Return type: [User](../types/User.md) @@ -22,14 +22,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v57/methods/account_updateStatus.md b/old_docs/API_docs_v57/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v57/methods/account_updateStatus.md +++ b/old_docs/API_docs_v57/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v57/methods/account_updateUsername.md b/old_docs/API_docs_v57/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v57/methods/account_updateUsername.md +++ b/old_docs/API_docs_v57/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v57/methods/auth_cancelCode.md b/old_docs/API_docs_v57/methods/auth_cancelCode.md index 52b85d4c..84401c62 100644 --- a/old_docs/API_docs_v57/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v57/methods/auth_cancelCode.md @@ -12,8 +12,8 @@ Invalidate sent phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invalidate sent phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v57/methods/auth_checkPhone.md b/old_docs/API_docs_v57/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v57/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v57/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v57/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v57/methods/auth_dropTempAuthKeys.md index 5aa98b3b..537afbc1 100644 --- a/old_docs/API_docs_v57/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v57/methods/auth_dropTempAuthKeys.md @@ -12,7 +12,7 @@ Delete all temporary authorization keys except the ones provided | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_auth\_keys|Array of [CLICK ME long](../types/long.md) | Yes|The temporary authorization keys to keep| +|except\_auth\_keys|Array of [long](../types/long.md) | Yes|The temporary authorization keys to keep| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/auth_recoverPassword.md b/old_docs/API_docs_v57/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v57/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v57/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v57/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v57/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v57/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v57/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v57/methods/auth_resendCode.md b/old_docs/API_docs_v57/methods/auth_resendCode.md index 253480a3..4402bfe6 100644 --- a/old_docs/API_docs_v57/methods/auth_resendCode.md +++ b/old_docs/API_docs_v57/methods/auth_resendCode.md @@ -12,8 +12,8 @@ Resend the SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -21,13 +21,6 @@ Resend the SMS verification code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v57/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v57/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v57/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v57/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/auth_sendInvites.md b/old_docs/API_docs_v57/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v57/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v57/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v57/methods/channels_checkUsername.md b/old_docs/API_docs_v57/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v57/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v57/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v57/methods/channels_createChannel.md b/old_docs/API_docs_v57/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v57/methods/channels_createChannel.md +++ b/old_docs/API_docs_v57/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v57/methods/channels_deleteChannel.md b/old_docs/API_docs_v57/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v57/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v57/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v57/methods/channels_deleteMessages.md b/old_docs/API_docs_v57/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v57/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v57/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v57/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v57/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v57/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v57/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v57/methods/channels_editAbout.md b/old_docs/API_docs_v57/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v57/methods/channels_editAbout.md +++ b/old_docs/API_docs_v57/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v57/methods/channels_editAdmin.md b/old_docs/API_docs_v57/methods/channels_editAdmin.md index 7b6cc0f1..62f1fdaa 100644 --- a/old_docs/API_docs_v57/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v57/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v57/methods/channels_editPhoto.md b/old_docs/API_docs_v57/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v57/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v57/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v57/methods/channels_editTitle.md b/old_docs/API_docs_v57/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v57/methods/channels_editTitle.md +++ b/old_docs/API_docs_v57/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v57/methods/channels_exportInvite.md b/old_docs/API_docs_v57/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v57/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v57/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v57/methods/channels_exportMessageLink.md b/old_docs/API_docs_v57/methods/channels_exportMessageLink.md index b4a3c645..20f6e998 100644 --- a/old_docs/API_docs_v57/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v57/methods/channels_exportMessageLink.md @@ -13,7 +13,7 @@ Get the link of a message in a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| +|id|[int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -21,13 +21,6 @@ Get the link of a message in a channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v57/methods/channels_getChannels.md b/old_docs/API_docs_v57/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v57/methods/channels_getChannels.md +++ b/old_docs/API_docs_v57/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v57/methods/channels_getMessages.md b/old_docs/API_docs_v57/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v57/methods/channels_getMessages.md +++ b/old_docs/API_docs_v57/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v57/methods/channels_getParticipant.md b/old_docs/API_docs_v57/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v57/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v57/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v57/methods/channels_getParticipants.md b/old_docs/API_docs_v57/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v57/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v57/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/channels_inviteToChannel.md b/old_docs/API_docs_v57/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v57/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v57/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v57/methods/channels_joinChannel.md b/old_docs/API_docs_v57/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v57/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v57/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v57/methods/channels_kickFromChannel.md b/old_docs/API_docs_v57/methods/channels_kickFromChannel.md index 8f6c92be..0c6c0258 100644 --- a/old_docs/API_docs_v57/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v57/methods/channels_kickFromChannel.md @@ -14,7 +14,7 @@ Kick user from channel |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick| -|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|Kick or unkick?| +|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_leaveChannel.md b/old_docs/API_docs_v57/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v57/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v57/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v57/methods/channels_readHistory.md b/old_docs/API_docs_v57/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v57/methods/channels_readHistory.md +++ b/old_docs/API_docs_v57/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v57/methods/channels_reportSpam.md b/old_docs/API_docs_v57/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v57/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v57/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v57/methods/channels_toggleInvites.md b/old_docs/API_docs_v57/methods/channels_toggleInvites.md index e9e6450d..d437682f 100644 --- a/old_docs/API_docs_v57/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v57/methods/channels_toggleInvites.md @@ -13,7 +13,7 @@ Allow or disallow any user to invite users to this channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Allow or disallow any user to invite users to this channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v57/methods/channels_toggleSignatures.md b/old_docs/API_docs_v57/methods/channels_toggleSignatures.md index 36d1eccb..d40bf67b 100644 --- a/old_docs/API_docs_v57/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v57/methods/channels_toggleSignatures.md @@ -13,7 +13,7 @@ Toggle channel signatures | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Toggle channel signatures ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v57/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v57/methods/channels_updatePinnedMessage.md index f8d10ece..aa2cc783 100644 --- a/old_docs/API_docs_v57/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v57/methods/channels_updatePinnedMessage.md @@ -12,9 +12,9 @@ Set the pinned message of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Set the pinned message of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -81,3 +71,13 @@ Or, if you're into Lua: Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v57/methods/channels_updateUsername.md b/old_docs/API_docs_v57/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v57/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v57/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v57/methods/contacts_block.md b/old_docs/API_docs_v57/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v57/methods/contacts_block.md +++ b/old_docs/API_docs_v57/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v57/methods/contacts_deleteContact.md b/old_docs/API_docs_v57/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v57/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v57/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v57/methods/contacts_deleteContacts.md b/old_docs/API_docs_v57/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v57/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v57/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/contacts_getBlocked.md b/old_docs/API_docs_v57/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v57/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v57/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v57/methods/contacts_getContacts.md b/old_docs/API_docs_v57/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v57/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v57/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v57/methods/contacts_getTopPeers.md b/old_docs/API_docs_v57/methods/contacts_getTopPeers.md index 8d39809c..b5108fd2 100644 --- a/old_docs/API_docs_v57/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v57/methods/contacts_getTopPeers.md @@ -12,14 +12,14 @@ Get most used chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|correspondents|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch users?| -|bots\_pm|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch bots?| -|bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| -|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| -|channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| +|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?| +|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?| +|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?| +|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?| +|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| +|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|limit|[int](../types/int.md) | Yes|How many results to fetch| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| ### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) @@ -27,13 +27,6 @@ Get most used chats ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TYPES_EMPTY|The types field is empty| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ Or, if you're into Lua: contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field is empty| + + diff --git a/old_docs/API_docs_v57/methods/contacts_importCard.md b/old_docs/API_docs_v57/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v57/methods/contacts_importCard.md +++ b/old_docs/API_docs_v57/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v57/methods/contacts_importContacts.md b/old_docs/API_docs_v57/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v57/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v57/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v57/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v57/methods/contacts_resetTopPeerRating.md index 4b5e96f1..15b07f96 100644 --- a/old_docs/API_docs_v57/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v57/methods/contacts_resetTopPeerRating.md @@ -12,7 +12,7 @@ Reset top peer rating for a certain category/peer | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| @@ -21,13 +21,6 @@ Reset top peer rating for a certain category/peer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/contacts_search.md b/old_docs/API_docs_v57/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v57/methods/contacts_search.md +++ b/old_docs/API_docs_v57/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/contacts_unblock.md b/old_docs/API_docs_v57/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v57/methods/contacts_unblock.md +++ b/old_docs/API_docs_v57/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v57/methods/help_getConfig.md b/old_docs/API_docs_v57/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v57/methods/help_getConfig.md +++ b/old_docs/API_docs_v57/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/help_saveAppLog.md b/old_docs/API_docs_v57/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v57/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v57/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/initConnection.md b/old_docs/API_docs_v57/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v57/methods/initConnection.md +++ b/old_docs/API_docs_v57/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v57/methods/invokeAfterMsg.md b/old_docs/API_docs_v57/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v57/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v57/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v57/methods/invokeAfterMsgs.md b/old_docs/API_docs_v57/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v57/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v57/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v57/methods/invokeWithLayer.md b/old_docs/API_docs_v57/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v57/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v57/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v57/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v57/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v57/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v57/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v57/methods/messages_addChatUser.md b/old_docs/API_docs_v57/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v57/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v57/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v57/methods/messages_checkChatInvite.md b/old_docs/API_docs_v57/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v57/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v57/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v57/methods/messages_clearRecentStickers.md index 1d6ec8c9..72c4844b 100644 --- a/old_docs/API_docs_v57/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v57/methods/messages_clearRecentStickers.md @@ -12,7 +12,7 @@ Clear all recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_createChat.md b/old_docs/API_docs_v57/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v57/methods/messages_createChat.md +++ b/old_docs/API_docs_v57/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v57/methods/messages_deleteChatUser.md b/old_docs/API_docs_v57/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v57/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v57/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v57/methods/messages_deleteHistory.md b/old_docs/API_docs_v57/methods/messages_deleteHistory.md index 45e9890d..601d1876 100644 --- a/old_docs/API_docs_v57/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v57/methods/messages_deleteHistory.md @@ -12,9 +12,9 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|just\_clear|[CLICK ME Bool](../types/Bool.md) | Optional|Only clear it from your side| +|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,13 +22,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_deleteMessages.md b/old_docs/API_docs_v57/methods/messages_deleteMessages.md index fa043e1c..c2d782ba 100644 --- a/old_docs/API_docs_v57/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v57/methods/messages_deleteMessages.md @@ -12,7 +12,7 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -20,13 +20,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v57/methods/messages_editChatAdmin.md b/old_docs/API_docs_v57/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v57/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v57/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_editChatPhoto.md b/old_docs/API_docs_v57/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v57/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v57/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_editChatTitle.md b/old_docs/API_docs_v57/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v57/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v57/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v57/methods/messages_editInlineBotMessage.md index 73c8a2c4..4729b52a 100644 --- a/old_docs/API_docs_v57/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v57/methods/messages_editInlineBotMessage.md @@ -12,11 +12,11 @@ Edit a sent inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,14 +25,6 @@ Edit a sent inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| - - ### MadelineProto Example: @@ -120,3 +112,11 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v57/methods/messages_editMessage.md b/old_docs/API_docs_v57/methods/messages_editMessage.md index ad639325..4380aba6 100644 --- a/old_docs/API_docs_v57/methods/messages_editMessage.md +++ b/old_docs/API_docs_v57/methods/messages_editMessage.md @@ -12,12 +12,12 @@ Edit a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -26,22 +26,6 @@ Edit a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -129,3 +113,19 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v57/methods/messages_exportChatInvite.md b/old_docs/API_docs_v57/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v57/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v57/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_forwardMessage.md b/old_docs/API_docs_v57/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v57/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v57/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v57/methods/messages_forwardMessages.md b/old_docs/API_docs_v57/methods/messages_forwardMessages.md index b99e1d31..2a0455e4 100644 --- a/old_docs/API_docs_v57/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v57/methods/messages_forwardMessages.md @@ -12,11 +12,11 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[CLICK ME Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| +|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -25,34 +25,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -108,3 +80,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/messages_getAllStickers.md b/old_docs/API_docs_v57/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v57/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v57/methods/messages_getArchivedStickers.md index ee36b542..dfd5c006 100644 --- a/old_docs/API_docs_v57/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getArchivedStickers.md @@ -12,9 +12,9 @@ Get all archived stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| +|masks|[Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| +|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v57/methods/messages_getAttachedStickers.md index 9f8a66c5..8f51f38d 100644 --- a/old_docs/API_docs_v57/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getAttachedStickers.md @@ -12,7 +12,7 @@ Get stickers attachable to images | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v57/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v57/methods/messages_getBotCallbackAnswer.md index 0136227f..4b8887ad 100644 --- a/old_docs/API_docs_v57/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v57/methods/messages_getBotCallbackAnswer.md @@ -12,10 +12,10 @@ Get the callback answer of a bot (after clicking a button) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|game|[Bool](../types/Bool.md) | Optional|Is this a game?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) @@ -23,17 +23,6 @@ Get the callback answer of a bot (after clicking a button) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|DATA_INVALID|Encrypted data invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: messages_BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/messages_getChats.md b/old_docs/API_docs_v57/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v57/methods/messages_getChats.md +++ b/old_docs/API_docs_v57/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_getDialogs.md b/old_docs/API_docs_v57/methods/messages_getDialogs.md index bd3ef681..623f002a 100644 --- a/old_docs/API_docs_v57/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v57/methods/messages_getDialogs.md @@ -12,10 +12,10 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -23,16 +23,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v57/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v57/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v57/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v57/methods/messages_getFeaturedStickers.md index 8e49e1ef..af7f69a0 100644 --- a/old_docs/API_docs_v57/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getFeaturedStickers.md @@ -12,7 +12,7 @@ Get featured stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getGameHighScores.md b/old_docs/API_docs_v57/methods/messages_getGameHighScores.md index 113e4647..af3f3915 100644 --- a/old_docs/API_docs_v57/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v57/methods/messages_getGameHighScores.md @@ -13,7 +13,7 @@ Get high scores of a game | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -22,14 +22,6 @@ Get high scores of a game ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -79,3 +71,11 @@ Or, if you're into Lua: messages_HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v57/methods/messages_getHistory.md b/old_docs/API_docs_v57/methods/messages_getHistory.md index 851d2680..86a744cf 100644 --- a/old_docs/API_docs_v57/methods/messages_getHistory.md +++ b/old_docs/API_docs_v57/methods/messages_getHistory.md @@ -13,12 +13,12 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -26,18 +26,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v57/methods/messages_getInlineBotResults.md index 4d86caf5..207624a7 100644 --- a/old_docs/API_docs_v57/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v57/methods/messages_getInlineBotResults.md @@ -14,9 +14,9 @@ Call inline bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -24,16 +24,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v57/methods/messages_getInlineGameHighScores.md index d5a80005..e03bc273 100644 --- a/old_docs/API_docs_v57/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v57/methods/messages_getInlineGameHighScores.md @@ -12,7 +12,7 @@ Get high scores of a game sent in an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -21,14 +21,6 @@ Get high scores of a game sent in an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v57/methods/messages_getMaskStickers.md b/old_docs/API_docs_v57/methods/messages_getMaskStickers.md index 70e2e6d4..1fbd9346 100644 --- a/old_docs/API_docs_v57/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getMaskStickers.md @@ -12,7 +12,7 @@ Get masks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getMessageEditData.md b/old_docs/API_docs_v57/methods/messages_getMessageEditData.md index 34f8534f..00c63d28 100644 --- a/old_docs/API_docs_v57/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v57/methods/messages_getMessageEditData.md @@ -13,7 +13,7 @@ Check if about to edit a message or a media caption | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) @@ -21,14 +21,6 @@ Check if about to edit a message or a media caption ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v57/methods/messages_getMessages.md b/old_docs/API_docs_v57/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v57/methods/messages_getMessages.md +++ b/old_docs/API_docs_v57/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v57/methods/messages_getMessagesViews.md b/old_docs/API_docs_v57/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v57/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v57/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v57/methods/messages_getPeerDialogs.md index 063b6e7d..000e8eb6 100644 --- a/old_docs/API_docs_v57/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v57/methods/messages_getPeerDialogs.md @@ -20,14 +20,6 @@ Get dialog info of peers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: messages_PeerDialogs = messages.getPeerDialogs({peers={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_getPeerSettings.md b/old_docs/API_docs_v57/methods/messages_getPeerSettings.md index a18126f0..5a3e9349 100644 --- a/old_docs/API_docs_v57/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v57/methods/messages_getPeerSettings.md @@ -20,14 +20,6 @@ Get the settings of apeer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: PeerSettings = messages.getPeerSettings({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_getRecentStickers.md b/old_docs/API_docs_v57/methods/messages_getRecentStickers.md index 0c5ae0c6..629a2bda 100644 --- a/old_docs/API_docs_v57/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getRecentStickers.md @@ -12,8 +12,8 @@ Get recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getSavedGifs.md b/old_docs/API_docs_v57/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v57/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v57/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v57/methods/messages_getStickerSet.md b/old_docs/API_docs_v57/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v57/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v57/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v57/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v57/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v57/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v57/methods/messages_hideReportSpam.md b/old_docs/API_docs_v57/methods/messages_hideReportSpam.md index 30523f2a..0bf711ea 100644 --- a/old_docs/API_docs_v57/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v57/methods/messages_hideReportSpam.md @@ -20,13 +20,6 @@ Hide report spam popup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.hideReportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_importChatInvite.md b/old_docs/API_docs_v57/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v57/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v57/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v57/methods/messages_installStickerSet.md b/old_docs/API_docs_v57/methods/messages_installStickerSet.md index 20f90b71..d6caf555 100644 --- a/old_docs/API_docs_v57/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v57/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_migrateChat.md b/old_docs/API_docs_v57/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v57/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v57/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v57/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v57/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v57/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v57/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v57/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v57/methods/messages_readFeaturedStickers.md index 050371da..3b01171b 100644 --- a/old_docs/API_docs_v57/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v57/methods/messages_readFeaturedStickers.md @@ -12,7 +12,7 @@ Mark new featured stickers as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| +|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_readHistory.md b/old_docs/API_docs_v57/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v57/methods/messages_readHistory.md +++ b/old_docs/API_docs_v57/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/messages_readMessageContents.md b/old_docs/API_docs_v57/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v57/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v57/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v57/methods/messages_receivedMessages.md b/old_docs/API_docs_v57/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v57/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v57/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v57/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v57/methods/messages_reorderStickerSets.md index 66f5e682..6a71da86 100644 --- a/old_docs/API_docs_v57/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v57/methods/messages_reorderStickerSets.md @@ -12,8 +12,8 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_reportSpam.md b/old_docs/API_docs_v57/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v57/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v57/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_saveDraft.md b/old_docs/API_docs_v57/methods/messages_saveDraft.md index 59b33b03..60d72c1e 100644 --- a/old_docs/API_docs_v57/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v57/methods/messages_saveDraft.md @@ -12,11 +12,11 @@ Save a message draft | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,13 +25,6 @@ Save a message draft ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -104,3 +97,10 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_saveGif.md b/old_docs/API_docs_v57/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v57/methods/messages_saveGif.md +++ b/old_docs/API_docs_v57/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v57/methods/messages_saveRecentSticker.md index 55757080..d2418881 100644 --- a/old_docs/API_docs_v57/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v57/methods/messages_saveRecentSticker.md @@ -12,9 +12,9 @@ Add a sticker to recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Add a sticker to recent stickers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.saveRecentSticker({attached=Bool, id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_search.md b/old_docs/API_docs_v57/methods/messages_search.md index 735ddf47..63d58b40 100644 --- a/old_docs/API_docs_v57/methods/messages_search.md +++ b/old_docs/API_docs_v57/methods/messages_search.md @@ -13,13 +13,13 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,19 +27,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -90,3 +77,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_searchGifs.md b/old_docs/API_docs_v57/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v57/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v57/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v57/methods/messages_searchGlobal.md b/old_docs/API_docs_v57/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v57/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v57/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v57/methods/messages_sendEncrypted.md b/old_docs/API_docs_v57/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v57/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v57/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v57/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v57/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v57/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v57/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v57/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v57/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v57/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v57/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v57/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v57/methods/messages_sendInlineBotResult.md index 758aa97f..d1f9fbd0 100644 --- a/old_docs/API_docs_v57/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v57/methods/messages_sendInlineBotResult.md @@ -12,13 +12,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -26,18 +26,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v57/methods/messages_sendMedia.md b/old_docs/API_docs_v57/methods/messages_sendMedia.md index 770d1b65..94e27b83 100644 --- a/old_docs/API_docs_v57/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v57/methods/messages_sendMedia.md @@ -12,13 +12,13 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -26,34 +26,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -117,3 +89,31 @@ Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, pe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/messages_sendMessage.md b/old_docs/API_docs_v57/methods/messages_sendMessage.md index 83dc6c8b..ba76f230 100644 --- a/old_docs/API_docs_v57/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v57/methods/messages_sendMessage.md @@ -12,15 +12,15 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,33 +29,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -143,3 +116,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v57/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v57/methods/messages_setBotCallbackAnswer.md index b9993826..3d73a778 100644 --- a/old_docs/API_docs_v57/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v57/methods/messages_setBotCallbackAnswer.md @@ -12,10 +12,10 @@ Bots only: set the callback answer (after a button was clicked) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|message|[CLICK ME string](../types/string.md) | Optional|The message| -|url|[CLICK ME string](../types/string.md) | Optional|The URL| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| +|url|[string](../types/string.md) | Optional|The URL| ### Return type: [Bool](../types/Bool.md) @@ -23,13 +23,6 @@ Bots only: set the callback answer (after a button was clicked) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -87,3 +80,10 @@ Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v57/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v57/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v57/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_setGameScore.md b/old_docs/API_docs_v57/methods/messages_setGameScore.md index 8d671f1f..dc6e37f1 100644 --- a/old_docs/API_docs_v57/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v57/methods/messages_setGameScore.md @@ -12,11 +12,11 @@ Set the game score | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) @@ -24,14 +24,6 @@ Set the game score ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -85,3 +77,11 @@ Or, if you're into Lua: Updates = messages.setGameScore({edit_message=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v57/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v57/methods/messages_setInlineBotResults.md index d4ba6e65..e46598e2 100644 --- a/old_docs/API_docs_v57/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v57/methods/messages_setInlineBotResults.md @@ -12,13 +12,13 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) @@ -26,23 +26,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -100,3 +83,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v57/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v57/methods/messages_setInlineGameScore.md index f16f00bb..9bce4952 100644 --- a/old_docs/API_docs_v57/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v57/methods/messages_setInlineGameScore.md @@ -12,10 +12,10 @@ Set the game score of an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) @@ -23,14 +23,6 @@ Set the game score of an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: Bool = messages.setInlineGameScore({edit_message=Bool, id=InputBotInlineMessageID, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v57/methods/messages_setTyping.md b/old_docs/API_docs_v57/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v57/methods/messages_setTyping.md +++ b/old_docs/API_docs_v57/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v57/methods/messages_startBot.md b/old_docs/API_docs_v57/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v57/methods/messages_startBot.md +++ b/old_docs/API_docs_v57/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v57/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v57/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v57/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v57/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v57/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v57/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v57/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v57/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v57/methods/photos_getUserPhotos.md b/old_docs/API_docs_v57/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v57/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v57/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v57/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v57/methods/photos_uploadProfilePhoto.md index c7ec3063..0c994ffe 100644 --- a/old_docs/API_docs_v57/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v57/methods/photos_uploadProfilePhoto.md @@ -20,16 +20,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -66,3 +56,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v57/methods/users_getUsers.md b/old_docs/API_docs_v57/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v57/methods/users_getUsers.md +++ b/old_docs/API_docs_v57/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/account_changePhone.md b/old_docs/API_docs_v62/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v62/methods/account_changePhone.md +++ b/old_docs/API_docs_v62/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_checkUsername.md b/old_docs/API_docs_v62/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v62/methods/account_checkUsername.md +++ b/old_docs/API_docs_v62/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v62/methods/account_confirmPhone.md b/old_docs/API_docs_v62/methods/account_confirmPhone.md index 68490f35..7ffabc24 100644 --- a/old_docs/API_docs_v62/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v62/methods/account_confirmPhone.md @@ -12,8 +12,8 @@ Confirm this phone number is associated to this account, obtain phone_code_hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| +|phone\_code\_hash|[string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Confirm this phone number is associated to this account, obtain phone_code_hash ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_HASH_INVALID|Code hash invalid| -|PHONE_CODE_EMPTY|phone_code is missing| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_HASH_INVALID|Code hash invalid| +|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/old_docs/API_docs_v62/methods/account_deleteAccount.md b/old_docs/API_docs_v62/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v62/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v62/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/account_getNotifySettings.md b/old_docs/API_docs_v62/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v62/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v62/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_getPasswordSettings.md b/old_docs/API_docs_v62/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v62/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v62/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_getPrivacy.md b/old_docs/API_docs_v62/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v62/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v62/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_registerDevice.md b/old_docs/API_docs_v62/methods/account_registerDevice.md index 4e148a7f..cbac71d3 100644 --- a/old_docs/API_docs_v62/methods/account_registerDevice.md +++ b/old_docs/API_docs_v62/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_reportPeer.md b/old_docs/API_docs_v62/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v62/methods/account_reportPeer.md +++ b/old_docs/API_docs_v62/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_resetAuthorization.md b/old_docs/API_docs_v62/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v62/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v62/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v62/methods/account_sendChangePhoneCode.md index bdf7331f..476b6d79 100644 --- a/old_docs/API_docs_v62/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v62/methods/account_sendChangePhoneCode.md @@ -12,9 +12,9 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|Current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v62/methods/account_sendConfirmPhoneCode.md index 86035d19..8917355f 100644 --- a/old_docs/API_docs_v62/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v62/methods/account_sendConfirmPhoneCode.md @@ -12,9 +12,9 @@ Send confirmation phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| -|hash|[CLICK ME string](../types/string.md) | Yes|The hash| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|The current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| +|hash|[string](../types/string.md) | Yes|The hash| +|current\_number|[Bool](../types/Bool.md) | Optional|The current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Send confirmation phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendConfirmPhoneCode({allow_flashcall=Bool, hash='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_setAccountTTL.md b/old_docs/API_docs_v62/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v62/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v62/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_setPrivacy.md b/old_docs/API_docs_v62/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v62/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v62/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_unregisterDevice.md b/old_docs/API_docs_v62/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v62/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v62/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v62/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v62/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v62/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/account_updateNotifySettings.md b/old_docs/API_docs_v62/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v62/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v62/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v62/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v62/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v62/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_updateProfile.md b/old_docs/API_docs_v62/methods/account_updateProfile.md index 59629188..ef19dc00 100644 --- a/old_docs/API_docs_v62/methods/account_updateProfile.md +++ b/old_docs/API_docs_v62/methods/account_updateProfile.md @@ -12,9 +12,9 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Optional|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Optional|The last name| -|about|[CLICK ME string](../types/string.md) | Optional|The bio/about field| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| ### Return type: [User](../types/User.md) @@ -22,14 +22,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v62/methods/account_updateStatus.md b/old_docs/API_docs_v62/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v62/methods/account_updateStatus.md +++ b/old_docs/API_docs_v62/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v62/methods/account_updateUsername.md b/old_docs/API_docs_v62/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v62/methods/account_updateUsername.md +++ b/old_docs/API_docs_v62/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v62/methods/auth_cancelCode.md b/old_docs/API_docs_v62/methods/auth_cancelCode.md index 52b85d4c..84401c62 100644 --- a/old_docs/API_docs_v62/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v62/methods/auth_cancelCode.md @@ -12,8 +12,8 @@ Invalidate sent phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invalidate sent phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v62/methods/auth_checkPhone.md b/old_docs/API_docs_v62/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v62/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v62/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v62/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v62/methods/auth_dropTempAuthKeys.md index 5aa98b3b..537afbc1 100644 --- a/old_docs/API_docs_v62/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v62/methods/auth_dropTempAuthKeys.md @@ -12,7 +12,7 @@ Delete all temporary authorization keys except the ones provided | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_auth\_keys|Array of [CLICK ME long](../types/long.md) | Yes|The temporary authorization keys to keep| +|except\_auth\_keys|Array of [long](../types/long.md) | Yes|The temporary authorization keys to keep| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/auth_recoverPassword.md b/old_docs/API_docs_v62/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v62/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v62/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v62/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v62/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v62/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v62/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v62/methods/auth_resendCode.md b/old_docs/API_docs_v62/methods/auth_resendCode.md index 253480a3..4402bfe6 100644 --- a/old_docs/API_docs_v62/methods/auth_resendCode.md +++ b/old_docs/API_docs_v62/methods/auth_resendCode.md @@ -12,8 +12,8 @@ Resend the SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -21,13 +21,6 @@ Resend the SMS verification code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v62/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v62/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v62/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v62/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/auth_sendInvites.md b/old_docs/API_docs_v62/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v62/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v62/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v62/methods/channels_checkUsername.md b/old_docs/API_docs_v62/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v62/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v62/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v62/methods/channels_createChannel.md b/old_docs/API_docs_v62/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v62/methods/channels_createChannel.md +++ b/old_docs/API_docs_v62/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v62/methods/channels_deleteChannel.md b/old_docs/API_docs_v62/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v62/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v62/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v62/methods/channels_deleteMessages.md b/old_docs/API_docs_v62/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v62/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v62/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v62/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v62/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v62/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v62/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v62/methods/channels_editAbout.md b/old_docs/API_docs_v62/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v62/methods/channels_editAbout.md +++ b/old_docs/API_docs_v62/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v62/methods/channels_editAdmin.md b/old_docs/API_docs_v62/methods/channels_editAdmin.md index 7b6cc0f1..62f1fdaa 100644 --- a/old_docs/API_docs_v62/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v62/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v62/methods/channels_editPhoto.md b/old_docs/API_docs_v62/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v62/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v62/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v62/methods/channels_editTitle.md b/old_docs/API_docs_v62/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v62/methods/channels_editTitle.md +++ b/old_docs/API_docs_v62/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v62/methods/channels_exportInvite.md b/old_docs/API_docs_v62/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v62/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v62/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v62/methods/channels_exportMessageLink.md b/old_docs/API_docs_v62/methods/channels_exportMessageLink.md index b4a3c645..20f6e998 100644 --- a/old_docs/API_docs_v62/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v62/methods/channels_exportMessageLink.md @@ -13,7 +13,7 @@ Get the link of a message in a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| +|id|[int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -21,13 +21,6 @@ Get the link of a message in a channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v62/methods/channels_getChannels.md b/old_docs/API_docs_v62/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v62/methods/channels_getChannels.md +++ b/old_docs/API_docs_v62/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v62/methods/channels_getMessages.md b/old_docs/API_docs_v62/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v62/methods/channels_getMessages.md +++ b/old_docs/API_docs_v62/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v62/methods/channels_getParticipant.md b/old_docs/API_docs_v62/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v62/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v62/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v62/methods/channels_getParticipants.md b/old_docs/API_docs_v62/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v62/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v62/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/channels_inviteToChannel.md b/old_docs/API_docs_v62/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v62/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v62/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v62/methods/channels_joinChannel.md b/old_docs/API_docs_v62/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v62/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v62/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v62/methods/channels_kickFromChannel.md b/old_docs/API_docs_v62/methods/channels_kickFromChannel.md index 8f6c92be..0c6c0258 100644 --- a/old_docs/API_docs_v62/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v62/methods/channels_kickFromChannel.md @@ -14,7 +14,7 @@ Kick user from channel |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick| -|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|Kick or unkick?| +|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_leaveChannel.md b/old_docs/API_docs_v62/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v62/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v62/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v62/methods/channels_readHistory.md b/old_docs/API_docs_v62/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v62/methods/channels_readHistory.md +++ b/old_docs/API_docs_v62/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v62/methods/channels_reportSpam.md b/old_docs/API_docs_v62/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v62/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v62/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v62/methods/channels_toggleInvites.md b/old_docs/API_docs_v62/methods/channels_toggleInvites.md index e9e6450d..d437682f 100644 --- a/old_docs/API_docs_v62/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v62/methods/channels_toggleInvites.md @@ -13,7 +13,7 @@ Allow or disallow any user to invite users to this channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Allow or disallow any user to invite users to this channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v62/methods/channels_toggleSignatures.md b/old_docs/API_docs_v62/methods/channels_toggleSignatures.md index 36d1eccb..d40bf67b 100644 --- a/old_docs/API_docs_v62/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v62/methods/channels_toggleSignatures.md @@ -13,7 +13,7 @@ Toggle channel signatures | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Toggle channel signatures ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v62/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v62/methods/channels_updatePinnedMessage.md index f8d10ece..aa2cc783 100644 --- a/old_docs/API_docs_v62/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v62/methods/channels_updatePinnedMessage.md @@ -12,9 +12,9 @@ Set the pinned message of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Set the pinned message of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -81,3 +71,13 @@ Or, if you're into Lua: Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v62/methods/channels_updateUsername.md b/old_docs/API_docs_v62/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v62/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v62/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v62/methods/contacts_block.md b/old_docs/API_docs_v62/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v62/methods/contacts_block.md +++ b/old_docs/API_docs_v62/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v62/methods/contacts_deleteContact.md b/old_docs/API_docs_v62/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v62/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v62/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v62/methods/contacts_deleteContacts.md b/old_docs/API_docs_v62/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v62/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v62/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/contacts_getBlocked.md b/old_docs/API_docs_v62/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v62/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v62/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v62/methods/contacts_getContacts.md b/old_docs/API_docs_v62/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v62/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v62/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v62/methods/contacts_getTopPeers.md b/old_docs/API_docs_v62/methods/contacts_getTopPeers.md index 8d39809c..b5108fd2 100644 --- a/old_docs/API_docs_v62/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v62/methods/contacts_getTopPeers.md @@ -12,14 +12,14 @@ Get most used chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|correspondents|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch users?| -|bots\_pm|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch bots?| -|bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| -|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| -|channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| +|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?| +|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?| +|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?| +|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?| +|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| +|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|limit|[int](../types/int.md) | Yes|How many results to fetch| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| ### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) @@ -27,13 +27,6 @@ Get most used chats ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TYPES_EMPTY|The types field is empty| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ Or, if you're into Lua: contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field is empty| + + diff --git a/old_docs/API_docs_v62/methods/contacts_importCard.md b/old_docs/API_docs_v62/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v62/methods/contacts_importCard.md +++ b/old_docs/API_docs_v62/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v62/methods/contacts_importContacts.md b/old_docs/API_docs_v62/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v62/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v62/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v62/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v62/methods/contacts_resetTopPeerRating.md index 4b5e96f1..15b07f96 100644 --- a/old_docs/API_docs_v62/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v62/methods/contacts_resetTopPeerRating.md @@ -12,7 +12,7 @@ Reset top peer rating for a certain category/peer | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| @@ -21,13 +21,6 @@ Reset top peer rating for a certain category/peer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/contacts_search.md b/old_docs/API_docs_v62/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v62/methods/contacts_search.md +++ b/old_docs/API_docs_v62/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/contacts_unblock.md b/old_docs/API_docs_v62/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v62/methods/contacts_unblock.md +++ b/old_docs/API_docs_v62/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v62/methods/help_getConfig.md b/old_docs/API_docs_v62/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v62/methods/help_getConfig.md +++ b/old_docs/API_docs_v62/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/help_saveAppLog.md b/old_docs/API_docs_v62/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v62/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v62/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v62/methods/help_setBotUpdatesStatus.md index a1a3ab1b..1766ee14 100644 --- a/old_docs/API_docs_v62/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v62/methods/help_setBotUpdatesStatus.md @@ -12,8 +12,8 @@ Set the update status of webhook | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| -|message|[CLICK ME string](../types/string.md) | Yes|Message| +|pending\_updates\_count|[int](../types/int.md) | Yes|Pending update count| +|message|[string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/initConnection.md b/old_docs/API_docs_v62/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v62/methods/initConnection.md +++ b/old_docs/API_docs_v62/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v62/methods/invokeAfterMsg.md b/old_docs/API_docs_v62/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v62/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v62/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v62/methods/invokeAfterMsgs.md b/old_docs/API_docs_v62/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v62/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v62/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v62/methods/invokeWithLayer.md b/old_docs/API_docs_v62/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v62/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v62/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v62/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v62/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v62/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v62/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v62/methods/messages_addChatUser.md b/old_docs/API_docs_v62/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v62/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v62/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v62/methods/messages_checkChatInvite.md b/old_docs/API_docs_v62/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v62/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v62/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v62/methods/messages_clearRecentStickers.md index 1d6ec8c9..72c4844b 100644 --- a/old_docs/API_docs_v62/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v62/methods/messages_clearRecentStickers.md @@ -12,7 +12,7 @@ Clear all recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_createChat.md b/old_docs/API_docs_v62/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v62/methods/messages_createChat.md +++ b/old_docs/API_docs_v62/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v62/methods/messages_deleteChatUser.md b/old_docs/API_docs_v62/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v62/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v62/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v62/methods/messages_deleteHistory.md b/old_docs/API_docs_v62/methods/messages_deleteHistory.md index 45e9890d..601d1876 100644 --- a/old_docs/API_docs_v62/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v62/methods/messages_deleteHistory.md @@ -12,9 +12,9 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|just\_clear|[CLICK ME Bool](../types/Bool.md) | Optional|Only clear it from your side| +|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,13 +22,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_deleteMessages.md b/old_docs/API_docs_v62/methods/messages_deleteMessages.md index c8670444..900e9d0e 100644 --- a/old_docs/API_docs_v62/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v62/methods/messages_deleteMessages.md @@ -12,8 +12,8 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|revoke|[CLICK ME Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,13 +21,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({revoke=Bool, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v62/methods/messages_editChatAdmin.md b/old_docs/API_docs_v62/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v62/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v62/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_editChatPhoto.md b/old_docs/API_docs_v62/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v62/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v62/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_editChatTitle.md b/old_docs/API_docs_v62/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v62/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v62/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v62/methods/messages_editInlineBotMessage.md index 73c8a2c4..4729b52a 100644 --- a/old_docs/API_docs_v62/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v62/methods/messages_editInlineBotMessage.md @@ -12,11 +12,11 @@ Edit a sent inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,14 +25,6 @@ Edit a sent inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| - - ### MadelineProto Example: @@ -120,3 +112,11 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v62/methods/messages_editMessage.md b/old_docs/API_docs_v62/methods/messages_editMessage.md index ad639325..4380aba6 100644 --- a/old_docs/API_docs_v62/methods/messages_editMessage.md +++ b/old_docs/API_docs_v62/methods/messages_editMessage.md @@ -12,12 +12,12 @@ Edit a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -26,22 +26,6 @@ Edit a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -129,3 +113,19 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v62/methods/messages_exportChatInvite.md b/old_docs/API_docs_v62/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v62/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v62/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_forwardMessage.md b/old_docs/API_docs_v62/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v62/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v62/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v62/methods/messages_forwardMessages.md b/old_docs/API_docs_v62/methods/messages_forwardMessages.md index b99e1d31..2a0455e4 100644 --- a/old_docs/API_docs_v62/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v62/methods/messages_forwardMessages.md @@ -12,11 +12,11 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[CLICK ME Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| +|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -25,34 +25,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -108,3 +80,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/messages_getAllChats.md b/old_docs/API_docs_v62/methods/messages_getAllChats.md index 513fc06f..c4851369 100644 --- a/old_docs/API_docs_v62/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v62/methods/messages_getAllChats.md @@ -12,7 +12,7 @@ Get all chats (not supergroups or channels) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v62/methods/messages_getAllStickers.md b/old_docs/API_docs_v62/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v62/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v62/methods/messages_getArchivedStickers.md index ee36b542..dfd5c006 100644 --- a/old_docs/API_docs_v62/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getArchivedStickers.md @@ -12,9 +12,9 @@ Get all archived stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| +|masks|[Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| +|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v62/methods/messages_getAttachedStickers.md index 9f8a66c5..8f51f38d 100644 --- a/old_docs/API_docs_v62/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getAttachedStickers.md @@ -12,7 +12,7 @@ Get stickers attachable to images | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v62/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v62/methods/messages_getBotCallbackAnswer.md index 0136227f..4b8887ad 100644 --- a/old_docs/API_docs_v62/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v62/methods/messages_getBotCallbackAnswer.md @@ -12,10 +12,10 @@ Get the callback answer of a bot (after clicking a button) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|game|[Bool](../types/Bool.md) | Optional|Is this a game?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) @@ -23,17 +23,6 @@ Get the callback answer of a bot (after clicking a button) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|DATA_INVALID|Encrypted data invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: messages_BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/messages_getChats.md b/old_docs/API_docs_v62/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v62/methods/messages_getChats.md +++ b/old_docs/API_docs_v62/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_getCommonChats.md b/old_docs/API_docs_v62/methods/messages_getCommonChats.md index 15ed6713..6ffa0948 100644 --- a/old_docs/API_docs_v62/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v62/methods/messages_getCommonChats.md @@ -13,8 +13,8 @@ Get chats in common with a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -22,13 +22,6 @@ Get chats in common with a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_Chats = messages.getCommonChats({user_id=InputUser, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_getDialogs.md b/old_docs/API_docs_v62/methods/messages_getDialogs.md index 53f9ac62..1035e8ce 100644 --- a/old_docs/API_docs_v62/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v62/methods/messages_getDialogs.md @@ -12,11 +12,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|exclude\_pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -24,16 +24,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v62/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v62/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v62/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v62/methods/messages_getFeaturedStickers.md index 8e49e1ef..af7f69a0 100644 --- a/old_docs/API_docs_v62/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getFeaturedStickers.md @@ -12,7 +12,7 @@ Get featured stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getGameHighScores.md b/old_docs/API_docs_v62/methods/messages_getGameHighScores.md index 113e4647..af3f3915 100644 --- a/old_docs/API_docs_v62/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v62/methods/messages_getGameHighScores.md @@ -13,7 +13,7 @@ Get high scores of a game | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -22,14 +22,6 @@ Get high scores of a game ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -79,3 +71,11 @@ Or, if you're into Lua: messages_HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v62/methods/messages_getHistory.md b/old_docs/API_docs_v62/methods/messages_getHistory.md index 851d2680..86a744cf 100644 --- a/old_docs/API_docs_v62/methods/messages_getHistory.md +++ b/old_docs/API_docs_v62/methods/messages_getHistory.md @@ -13,12 +13,12 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -26,18 +26,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v62/methods/messages_getInlineBotResults.md index 4d86caf5..207624a7 100644 --- a/old_docs/API_docs_v62/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v62/methods/messages_getInlineBotResults.md @@ -14,9 +14,9 @@ Call inline bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -24,16 +24,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v62/methods/messages_getInlineGameHighScores.md index d5a80005..e03bc273 100644 --- a/old_docs/API_docs_v62/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v62/methods/messages_getInlineGameHighScores.md @@ -12,7 +12,7 @@ Get high scores of a game sent in an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -21,14 +21,6 @@ Get high scores of a game sent in an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v62/methods/messages_getMaskStickers.md b/old_docs/API_docs_v62/methods/messages_getMaskStickers.md index 70e2e6d4..1fbd9346 100644 --- a/old_docs/API_docs_v62/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getMaskStickers.md @@ -12,7 +12,7 @@ Get masks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getMessageEditData.md b/old_docs/API_docs_v62/methods/messages_getMessageEditData.md index 34f8534f..00c63d28 100644 --- a/old_docs/API_docs_v62/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v62/methods/messages_getMessageEditData.md @@ -13,7 +13,7 @@ Check if about to edit a message or a media caption | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) @@ -21,14 +21,6 @@ Check if about to edit a message or a media caption ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v62/methods/messages_getMessages.md b/old_docs/API_docs_v62/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v62/methods/messages_getMessages.md +++ b/old_docs/API_docs_v62/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v62/methods/messages_getMessagesViews.md b/old_docs/API_docs_v62/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v62/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v62/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v62/methods/messages_getPeerDialogs.md index 063b6e7d..000e8eb6 100644 --- a/old_docs/API_docs_v62/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v62/methods/messages_getPeerDialogs.md @@ -20,14 +20,6 @@ Get dialog info of peers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: messages_PeerDialogs = messages.getPeerDialogs({peers={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_getPeerSettings.md b/old_docs/API_docs_v62/methods/messages_getPeerSettings.md index a18126f0..5a3e9349 100644 --- a/old_docs/API_docs_v62/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v62/methods/messages_getPeerSettings.md @@ -20,14 +20,6 @@ Get the settings of apeer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: PeerSettings = messages.getPeerSettings({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_getRecentStickers.md b/old_docs/API_docs_v62/methods/messages_getRecentStickers.md index 0c5ae0c6..629a2bda 100644 --- a/old_docs/API_docs_v62/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getRecentStickers.md @@ -12,8 +12,8 @@ Get recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getSavedGifs.md b/old_docs/API_docs_v62/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v62/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v62/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v62/methods/messages_getStickerSet.md b/old_docs/API_docs_v62/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v62/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v62/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_getWebPage.md b/old_docs/API_docs_v62/methods/messages_getWebPage.md index 19ca94b9..1b533ebd 100644 --- a/old_docs/API_docs_v62/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v62/methods/messages_getWebPage.md @@ -12,8 +12,8 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|url|[CLICK ME string](../types/string.md) | Yes|URL| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|url|[string](../types/string.md) | Yes|URL| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) @@ -21,13 +21,6 @@ Get webpage preview ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|WC_CONVERT_URL_INVALID|WC convert URL invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: WebPage = messages.getWebPage({url='string', hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|WC_CONVERT_URL_INVALID|WC convert URL invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v62/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v62/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v62/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v62/methods/messages_hideReportSpam.md b/old_docs/API_docs_v62/methods/messages_hideReportSpam.md index 30523f2a..0bf711ea 100644 --- a/old_docs/API_docs_v62/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v62/methods/messages_hideReportSpam.md @@ -20,13 +20,6 @@ Hide report spam popup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.hideReportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_importChatInvite.md b/old_docs/API_docs_v62/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v62/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v62/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v62/methods/messages_installStickerSet.md b/old_docs/API_docs_v62/methods/messages_installStickerSet.md index 20f90b71..d6caf555 100644 --- a/old_docs/API_docs_v62/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v62/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_migrateChat.md b/old_docs/API_docs_v62/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v62/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v62/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v62/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v62/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v62/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v62/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v62/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v62/methods/messages_readFeaturedStickers.md index 050371da..3b01171b 100644 --- a/old_docs/API_docs_v62/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v62/methods/messages_readFeaturedStickers.md @@ -12,7 +12,7 @@ Mark new featured stickers as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| +|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_readHistory.md b/old_docs/API_docs_v62/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v62/methods/messages_readHistory.md +++ b/old_docs/API_docs_v62/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/messages_readMessageContents.md b/old_docs/API_docs_v62/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v62/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v62/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v62/methods/messages_receivedMessages.md b/old_docs/API_docs_v62/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v62/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v62/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v62/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v62/methods/messages_reorderPinnedDialogs.md index 94d3b2d4..232117e8 100644 --- a/old_docs/API_docs_v62/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v62/methods/messages_reorderPinnedDialogs.md @@ -12,7 +12,7 @@ Reorder pinned dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|force|[Bool](../types/Bool.md) | Optional|Force reordering| |order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| @@ -21,13 +21,6 @@ Reorder pinned dialogs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.reorderPinnedDialogs({force=Bool, order={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v62/methods/messages_reorderStickerSets.md index 66f5e682..6a71da86 100644 --- a/old_docs/API_docs_v62/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v62/methods/messages_reorderStickerSets.md @@ -12,8 +12,8 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v62/methods/messages_reportEncryptedSpam.md index cd03c35c..988e0101 100644 --- a/old_docs/API_docs_v62/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v62/methods/messages_reportEncryptedSpam.md @@ -20,13 +20,6 @@ Report for spam a secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportEncryptedSpam({peer=InputEncryptedChat, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_reportSpam.md b/old_docs/API_docs_v62/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v62/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v62/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_saveDraft.md b/old_docs/API_docs_v62/methods/messages_saveDraft.md index 59b33b03..60d72c1e 100644 --- a/old_docs/API_docs_v62/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v62/methods/messages_saveDraft.md @@ -12,11 +12,11 @@ Save a message draft | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,13 +25,6 @@ Save a message draft ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -104,3 +97,10 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_saveGif.md b/old_docs/API_docs_v62/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v62/methods/messages_saveGif.md +++ b/old_docs/API_docs_v62/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v62/methods/messages_saveRecentSticker.md index 55757080..d2418881 100644 --- a/old_docs/API_docs_v62/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v62/methods/messages_saveRecentSticker.md @@ -12,9 +12,9 @@ Add a sticker to recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Add a sticker to recent stickers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.saveRecentSticker({attached=Bool, id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_search.md b/old_docs/API_docs_v62/methods/messages_search.md index 735ddf47..63d58b40 100644 --- a/old_docs/API_docs_v62/methods/messages_search.md +++ b/old_docs/API_docs_v62/methods/messages_search.md @@ -13,13 +13,13 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,19 +27,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -90,3 +77,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_searchGifs.md b/old_docs/API_docs_v62/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v62/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v62/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v62/methods/messages_searchGlobal.md b/old_docs/API_docs_v62/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v62/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v62/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v62/methods/messages_sendEncrypted.md b/old_docs/API_docs_v62/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v62/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v62/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v62/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v62/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v62/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v62/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v62/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v62/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v62/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v62/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v62/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v62/methods/messages_sendInlineBotResult.md index 758aa97f..d1f9fbd0 100644 --- a/old_docs/API_docs_v62/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v62/methods/messages_sendInlineBotResult.md @@ -12,13 +12,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -26,18 +26,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v62/methods/messages_sendMedia.md b/old_docs/API_docs_v62/methods/messages_sendMedia.md index 770d1b65..94e27b83 100644 --- a/old_docs/API_docs_v62/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v62/methods/messages_sendMedia.md @@ -12,13 +12,13 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -26,34 +26,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -117,3 +89,31 @@ Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, pe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/messages_sendMessage.md b/old_docs/API_docs_v62/methods/messages_sendMessage.md index 83dc6c8b..ba76f230 100644 --- a/old_docs/API_docs_v62/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v62/methods/messages_sendMessage.md @@ -12,15 +12,15 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,33 +29,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -143,3 +116,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v62/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v62/methods/messages_setBotCallbackAnswer.md index e221ccca..34c7bb16 100644 --- a/old_docs/API_docs_v62/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v62/methods/messages_setBotCallbackAnswer.md @@ -12,11 +12,11 @@ Bots only: set the callback answer (after a button was clicked) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|message|[CLICK ME string](../types/string.md) | Optional|The message| -|url|[CLICK ME string](../types/string.md) | Optional|The URL| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| +|url|[string](../types/string.md) | Optional|The URL| +|cache\_time|[int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) @@ -24,13 +24,6 @@ Bots only: set the callback answer (after a button was clicked) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -90,3 +83,10 @@ Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v62/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v62/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v62/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_setGameScore.md b/old_docs/API_docs_v62/methods/messages_setGameScore.md index 90594a1d..c3d5a2c7 100644 --- a/old_docs/API_docs_v62/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v62/methods/messages_setGameScore.md @@ -12,12 +12,12 @@ Set the game score | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) @@ -25,14 +25,6 @@ Set the game score ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: Updates = messages.setGameScore({edit_message=Bool, force=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v62/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v62/methods/messages_setInlineBotResults.md index d4ba6e65..e46598e2 100644 --- a/old_docs/API_docs_v62/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v62/methods/messages_setInlineBotResults.md @@ -12,13 +12,13 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) @@ -26,23 +26,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -100,3 +83,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v62/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v62/methods/messages_setInlineGameScore.md index 2b7326f3..d33da5ef 100644 --- a/old_docs/API_docs_v62/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v62/methods/messages_setInlineGameScore.md @@ -12,11 +12,11 @@ Set the game score of an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) @@ -24,14 +24,6 @@ Set the game score of an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -85,3 +77,11 @@ Or, if you're into Lua: Bool = messages.setInlineGameScore({edit_message=Bool, force=Bool, id=InputBotInlineMessageID, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v62/methods/messages_setTyping.md b/old_docs/API_docs_v62/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v62/methods/messages_setTyping.md +++ b/old_docs/API_docs_v62/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v62/methods/messages_startBot.md b/old_docs/API_docs_v62/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v62/methods/messages_startBot.md +++ b/old_docs/API_docs_v62/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v62/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v62/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v62/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v62/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v62/methods/messages_toggleDialogPin.md index 14332533..6c57ce0a 100644 --- a/old_docs/API_docs_v62/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v62/methods/messages_toggleDialogPin.md @@ -12,7 +12,7 @@ Pin or unpin dialog | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| @@ -21,13 +21,6 @@ Pin or unpin dialog ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.toggleDialogPin({pinned=Bool, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v62/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v62/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v62/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v62/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v62/methods/phone_receivedCall.md b/old_docs/API_docs_v62/methods/phone_receivedCall.md index 17095622..6141a0ab 100644 --- a/old_docs/API_docs_v62/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v62/methods/phone_receivedCall.md @@ -12,7 +12,7 @@ Notify server that you received a call (server will refuse all incoming calls un | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| ### Return type: [Bool](../types/Bool.md) @@ -20,14 +20,6 @@ Notify server that you received a call (server will refuse all incoming calls un ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_ALREADY_DECLINED|The call was already declined| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = phone.receivedCall({peer=InputPhoneCall, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_ALREADY_DECLINED|The call was already declined| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v62/methods/photos_getUserPhotos.md b/old_docs/API_docs_v62/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v62/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v62/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v62/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v62/methods/photos_uploadProfilePhoto.md index c7ec3063..0c994ffe 100644 --- a/old_docs/API_docs_v62/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v62/methods/photos_uploadProfilePhoto.md @@ -20,16 +20,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -66,3 +56,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v62/methods/users_getUsers.md b/old_docs/API_docs_v62/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v62/methods/users_getUsers.md +++ b/old_docs/API_docs_v62/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/account_changePhone.md b/old_docs/API_docs_v65/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v65/methods/account_changePhone.md +++ b/old_docs/API_docs_v65/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_checkUsername.md b/old_docs/API_docs_v65/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v65/methods/account_checkUsername.md +++ b/old_docs/API_docs_v65/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v65/methods/account_confirmPhone.md b/old_docs/API_docs_v65/methods/account_confirmPhone.md index 68490f35..7ffabc24 100644 --- a/old_docs/API_docs_v65/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v65/methods/account_confirmPhone.md @@ -12,8 +12,8 @@ Confirm this phone number is associated to this account, obtain phone_code_hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| +|phone\_code\_hash|[string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Confirm this phone number is associated to this account, obtain phone_code_hash ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_HASH_INVALID|Code hash invalid| -|PHONE_CODE_EMPTY|phone_code is missing| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_HASH_INVALID|Code hash invalid| +|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/old_docs/API_docs_v65/methods/account_deleteAccount.md b/old_docs/API_docs_v65/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v65/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v65/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/account_getNotifySettings.md b/old_docs/API_docs_v65/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v65/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v65/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_getPasswordSettings.md b/old_docs/API_docs_v65/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v65/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v65/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_getPrivacy.md b/old_docs/API_docs_v65/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v65/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v65/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_getTmpPassword.md b/old_docs/API_docs_v65/methods/account_getTmpPassword.md index 01b1ebfc..c82ff37a 100644 --- a/old_docs/API_docs_v65/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v65/methods/account_getTmpPassword.md @@ -12,8 +12,8 @@ Get temporary password for buying products through bots | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|The password hash| -|period|[CLICK ME int](../types/int.md) | Yes|The validity period| +|password\_hash|[bytes](../types/bytes.md) | Yes|The password hash| +|period|[int](../types/int.md) | Yes|The validity period| ### Return type: [account\_TmpPassword](../types/account_TmpPassword.md) @@ -21,14 +21,6 @@ Get temporary password for buying products through bots ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| -|TMP_PASSWORD_DISABLED|The temporary password is disabled| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: account_TmpPassword = account.getTmpPassword({password_hash='bytes', period=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|TMP_PASSWORD_DISABLED|The temporary password is disabled| + + diff --git a/old_docs/API_docs_v65/methods/account_registerDevice.md b/old_docs/API_docs_v65/methods/account_registerDevice.md index 4e148a7f..cbac71d3 100644 --- a/old_docs/API_docs_v65/methods/account_registerDevice.md +++ b/old_docs/API_docs_v65/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_reportPeer.md b/old_docs/API_docs_v65/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v65/methods/account_reportPeer.md +++ b/old_docs/API_docs_v65/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_resetAuthorization.md b/old_docs/API_docs_v65/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v65/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v65/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v65/methods/account_sendChangePhoneCode.md index bdf7331f..476b6d79 100644 --- a/old_docs/API_docs_v65/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v65/methods/account_sendChangePhoneCode.md @@ -12,9 +12,9 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|Current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v65/methods/account_sendConfirmPhoneCode.md index 86035d19..8917355f 100644 --- a/old_docs/API_docs_v65/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v65/methods/account_sendConfirmPhoneCode.md @@ -12,9 +12,9 @@ Send confirmation phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| -|hash|[CLICK ME string](../types/string.md) | Yes|The hash| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|The current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| +|hash|[string](../types/string.md) | Yes|The hash| +|current\_number|[Bool](../types/Bool.md) | Optional|The current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Send confirmation phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendConfirmPhoneCode({allow_flashcall=Bool, hash='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_setAccountTTL.md b/old_docs/API_docs_v65/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v65/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v65/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_setPrivacy.md b/old_docs/API_docs_v65/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v65/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v65/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_unregisterDevice.md b/old_docs/API_docs_v65/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v65/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v65/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v65/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v65/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v65/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/account_updateNotifySettings.md b/old_docs/API_docs_v65/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v65/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v65/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v65/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v65/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v65/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_updateProfile.md b/old_docs/API_docs_v65/methods/account_updateProfile.md index 59629188..ef19dc00 100644 --- a/old_docs/API_docs_v65/methods/account_updateProfile.md +++ b/old_docs/API_docs_v65/methods/account_updateProfile.md @@ -12,9 +12,9 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Optional|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Optional|The last name| -|about|[CLICK ME string](../types/string.md) | Optional|The bio/about field| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| ### Return type: [User](../types/User.md) @@ -22,14 +22,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v65/methods/account_updateStatus.md b/old_docs/API_docs_v65/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v65/methods/account_updateStatus.md +++ b/old_docs/API_docs_v65/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v65/methods/account_updateUsername.md b/old_docs/API_docs_v65/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v65/methods/account_updateUsername.md +++ b/old_docs/API_docs_v65/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v65/methods/auth_cancelCode.md b/old_docs/API_docs_v65/methods/auth_cancelCode.md index 52b85d4c..84401c62 100644 --- a/old_docs/API_docs_v65/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v65/methods/auth_cancelCode.md @@ -12,8 +12,8 @@ Invalidate sent phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invalidate sent phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v65/methods/auth_checkPhone.md b/old_docs/API_docs_v65/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v65/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v65/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v65/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v65/methods/auth_dropTempAuthKeys.md index 5aa98b3b..537afbc1 100644 --- a/old_docs/API_docs_v65/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v65/methods/auth_dropTempAuthKeys.md @@ -12,7 +12,7 @@ Delete all temporary authorization keys except the ones provided | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_auth\_keys|Array of [CLICK ME long](../types/long.md) | Yes|The temporary authorization keys to keep| +|except\_auth\_keys|Array of [long](../types/long.md) | Yes|The temporary authorization keys to keep| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/auth_recoverPassword.md b/old_docs/API_docs_v65/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v65/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v65/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v65/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v65/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v65/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v65/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v65/methods/auth_resendCode.md b/old_docs/API_docs_v65/methods/auth_resendCode.md index 253480a3..4402bfe6 100644 --- a/old_docs/API_docs_v65/methods/auth_resendCode.md +++ b/old_docs/API_docs_v65/methods/auth_resendCode.md @@ -12,8 +12,8 @@ Resend the SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -21,13 +21,6 @@ Resend the SMS verification code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v65/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v65/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v65/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v65/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/auth_sendInvites.md b/old_docs/API_docs_v65/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v65/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v65/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v65/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v65/methods/bots_answerWebhookJSONQuery.md index 40cb0477..3dbf62ef 100644 --- a/old_docs/API_docs_v65/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v65/methods/bots_answerWebhookJSONQuery.md @@ -12,8 +12,8 @@ Send webhook request via bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|data|[DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Send webhook request via bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Bool = bots.answerWebhookJSONQuery({query_id=long, data=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v65/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v65/methods/bots_sendCustomRequest.md index 5a7f4e86..cb7c32e2 100644 --- a/old_docs/API_docs_v65/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v65/methods/bots_sendCustomRequest.md @@ -12,8 +12,8 @@ Send a custom request to the bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| +|custom\_method|[string](../types/string.md) | Yes|The method to call| +|params|[DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) @@ -21,13 +21,6 @@ Send a custom request to the bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: DataJSON = bots.sendCustomRequest({custom_method='string', params=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v65/methods/channels_checkUsername.md b/old_docs/API_docs_v65/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v65/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v65/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v65/methods/channels_createChannel.md b/old_docs/API_docs_v65/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v65/methods/channels_createChannel.md +++ b/old_docs/API_docs_v65/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v65/methods/channels_deleteChannel.md b/old_docs/API_docs_v65/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v65/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v65/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v65/methods/channels_deleteMessages.md b/old_docs/API_docs_v65/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v65/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v65/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v65/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v65/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v65/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v65/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v65/methods/channels_editAbout.md b/old_docs/API_docs_v65/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v65/methods/channels_editAbout.md +++ b/old_docs/API_docs_v65/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v65/methods/channels_editAdmin.md b/old_docs/API_docs_v65/methods/channels_editAdmin.md index 7b6cc0f1..62f1fdaa 100644 --- a/old_docs/API_docs_v65/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v65/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v65/methods/channels_editPhoto.md b/old_docs/API_docs_v65/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v65/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v65/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v65/methods/channels_editTitle.md b/old_docs/API_docs_v65/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v65/methods/channels_editTitle.md +++ b/old_docs/API_docs_v65/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v65/methods/channels_exportInvite.md b/old_docs/API_docs_v65/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v65/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v65/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v65/methods/channels_exportMessageLink.md b/old_docs/API_docs_v65/methods/channels_exportMessageLink.md index b4a3c645..20f6e998 100644 --- a/old_docs/API_docs_v65/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v65/methods/channels_exportMessageLink.md @@ -13,7 +13,7 @@ Get the link of a message in a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| +|id|[int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -21,13 +21,6 @@ Get the link of a message in a channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v65/methods/channels_getChannels.md b/old_docs/API_docs_v65/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v65/methods/channels_getChannels.md +++ b/old_docs/API_docs_v65/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v65/methods/channels_getMessages.md b/old_docs/API_docs_v65/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v65/methods/channels_getMessages.md +++ b/old_docs/API_docs_v65/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v65/methods/channels_getParticipant.md b/old_docs/API_docs_v65/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v65/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v65/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v65/methods/channels_getParticipants.md b/old_docs/API_docs_v65/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v65/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v65/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/channels_inviteToChannel.md b/old_docs/API_docs_v65/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v65/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v65/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v65/methods/channels_joinChannel.md b/old_docs/API_docs_v65/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v65/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v65/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v65/methods/channels_kickFromChannel.md b/old_docs/API_docs_v65/methods/channels_kickFromChannel.md index 8f6c92be..0c6c0258 100644 --- a/old_docs/API_docs_v65/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v65/methods/channels_kickFromChannel.md @@ -14,7 +14,7 @@ Kick user from channel |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick| -|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|Kick or unkick?| +|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_leaveChannel.md b/old_docs/API_docs_v65/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v65/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v65/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v65/methods/channels_readHistory.md b/old_docs/API_docs_v65/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v65/methods/channels_readHistory.md +++ b/old_docs/API_docs_v65/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v65/methods/channels_reportSpam.md b/old_docs/API_docs_v65/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v65/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v65/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v65/methods/channels_toggleInvites.md b/old_docs/API_docs_v65/methods/channels_toggleInvites.md index e9e6450d..d437682f 100644 --- a/old_docs/API_docs_v65/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v65/methods/channels_toggleInvites.md @@ -13,7 +13,7 @@ Allow or disallow any user to invite users to this channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Allow or disallow any user to invite users to this channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v65/methods/channels_toggleSignatures.md b/old_docs/API_docs_v65/methods/channels_toggleSignatures.md index 36d1eccb..d40bf67b 100644 --- a/old_docs/API_docs_v65/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v65/methods/channels_toggleSignatures.md @@ -13,7 +13,7 @@ Toggle channel signatures | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Toggle channel signatures ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v65/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v65/methods/channels_updatePinnedMessage.md index f8d10ece..aa2cc783 100644 --- a/old_docs/API_docs_v65/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v65/methods/channels_updatePinnedMessage.md @@ -12,9 +12,9 @@ Set the pinned message of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Set the pinned message of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -81,3 +71,13 @@ Or, if you're into Lua: Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v65/methods/channels_updateUsername.md b/old_docs/API_docs_v65/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v65/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v65/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v65/methods/contacts_block.md b/old_docs/API_docs_v65/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v65/methods/contacts_block.md +++ b/old_docs/API_docs_v65/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v65/methods/contacts_deleteContact.md b/old_docs/API_docs_v65/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v65/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v65/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v65/methods/contacts_deleteContacts.md b/old_docs/API_docs_v65/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v65/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v65/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/contacts_getBlocked.md b/old_docs/API_docs_v65/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v65/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v65/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v65/methods/contacts_getContacts.md b/old_docs/API_docs_v65/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v65/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v65/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v65/methods/contacts_getTopPeers.md b/old_docs/API_docs_v65/methods/contacts_getTopPeers.md index 8d39809c..b5108fd2 100644 --- a/old_docs/API_docs_v65/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v65/methods/contacts_getTopPeers.md @@ -12,14 +12,14 @@ Get most used chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|correspondents|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch users?| -|bots\_pm|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch bots?| -|bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| -|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| -|channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| +|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?| +|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?| +|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?| +|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?| +|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| +|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|limit|[int](../types/int.md) | Yes|How many results to fetch| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| ### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) @@ -27,13 +27,6 @@ Get most used chats ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TYPES_EMPTY|The types field is empty| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ Or, if you're into Lua: contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field is empty| + + diff --git a/old_docs/API_docs_v65/methods/contacts_importCard.md b/old_docs/API_docs_v65/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v65/methods/contacts_importCard.md +++ b/old_docs/API_docs_v65/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v65/methods/contacts_importContacts.md b/old_docs/API_docs_v65/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v65/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v65/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v65/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v65/methods/contacts_resetTopPeerRating.md index 4b5e96f1..15b07f96 100644 --- a/old_docs/API_docs_v65/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v65/methods/contacts_resetTopPeerRating.md @@ -12,7 +12,7 @@ Reset top peer rating for a certain category/peer | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| @@ -21,13 +21,6 @@ Reset top peer rating for a certain category/peer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/contacts_search.md b/old_docs/API_docs_v65/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v65/methods/contacts_search.md +++ b/old_docs/API_docs_v65/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/contacts_unblock.md b/old_docs/API_docs_v65/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v65/methods/contacts_unblock.md +++ b/old_docs/API_docs_v65/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v65/methods/contest_saveDeveloperInfo.md b/old_docs/API_docs_v65/methods/contest_saveDeveloperInfo.md index 5d82a4be..de23c472 100644 --- a/old_docs/API_docs_v65/methods/contest_saveDeveloperInfo.md +++ b/old_docs/API_docs_v65/methods/contest_saveDeveloperInfo.md @@ -12,11 +12,11 @@ Save developer info for telegram contest | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|vk\_id|[CLICK ME int](../types/int.md) | Yes|VK user ID| -|name|[CLICK ME string](../types/string.md) | Yes|Name| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|age|[CLICK ME int](../types/int.md) | Yes|Age| -|city|[CLICK ME string](../types/string.md) | Yes|City| +|vk\_id|[int](../types/int.md) | Yes|VK user ID| +|name|[string](../types/string.md) | Yes|Name| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|age|[int](../types/int.md) | Yes|Age| +|city|[string](../types/string.md) | Yes|City| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/destroy_session.md b/old_docs/API_docs_v65/methods/destroy_session.md index b74fbd11..c4187ce0 100644 --- a/old_docs/API_docs_v65/methods/destroy_session.md +++ b/old_docs/API_docs_v65/methods/destroy_session.md @@ -12,7 +12,7 @@ Destroy the current MTProto session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|session\_id|[CLICK ME long](../types/long.md) | Yes|The session to destroy| +|session\_id|[long](../types/long.md) | Yes|The session to destroy| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/old_docs/API_docs_v65/methods/get_future_salts.md b/old_docs/API_docs_v65/methods/get_future_salts.md index e8451015..7f5fc18c 100644 --- a/old_docs/API_docs_v65/methods/get_future_salts.md +++ b/old_docs/API_docs_v65/methods/get_future_salts.md @@ -12,7 +12,7 @@ Get future salts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|num|[CLICK ME int](../types/int.md) | Yes|How many salts should be fetched| +|num|[int](../types/int.md) | Yes|How many salts should be fetched| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/old_docs/API_docs_v65/methods/help_getAppChangelog.md b/old_docs/API_docs_v65/methods/help_getAppChangelog.md index eda473a6..183ebb8c 100644 --- a/old_docs/API_docs_v65/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v65/methods/help_getAppChangelog.md @@ -12,7 +12,7 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| +|prev\_app\_version|[string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/help_getConfig.md b/old_docs/API_docs_v65/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v65/methods/help_getConfig.md +++ b/old_docs/API_docs_v65/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/help_saveAppLog.md b/old_docs/API_docs_v65/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v65/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v65/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v65/methods/help_setBotUpdatesStatus.md index a1a3ab1b..1766ee14 100644 --- a/old_docs/API_docs_v65/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v65/methods/help_setBotUpdatesStatus.md @@ -12,8 +12,8 @@ Set the update status of webhook | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| -|message|[CLICK ME string](../types/string.md) | Yes|Message| +|pending\_updates\_count|[int](../types/int.md) | Yes|Pending update count| +|message|[string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/initConnection.md b/old_docs/API_docs_v65/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v65/methods/initConnection.md +++ b/old_docs/API_docs_v65/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v65/methods/invokeAfterMsg.md b/old_docs/API_docs_v65/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v65/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v65/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v65/methods/invokeAfterMsgs.md b/old_docs/API_docs_v65/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v65/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v65/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v65/methods/invokeWithLayer.md b/old_docs/API_docs_v65/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v65/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v65/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v65/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v65/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v65/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v65/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v65/methods/messages_addChatUser.md b/old_docs/API_docs_v65/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v65/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v65/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v65/methods/messages_checkChatInvite.md b/old_docs/API_docs_v65/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v65/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v65/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v65/methods/messages_clearRecentStickers.md index 1d6ec8c9..72c4844b 100644 --- a/old_docs/API_docs_v65/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v65/methods/messages_clearRecentStickers.md @@ -12,7 +12,7 @@ Clear all recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_createChat.md b/old_docs/API_docs_v65/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v65/methods/messages_createChat.md +++ b/old_docs/API_docs_v65/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v65/methods/messages_deleteChatUser.md b/old_docs/API_docs_v65/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v65/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v65/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v65/methods/messages_deleteHistory.md b/old_docs/API_docs_v65/methods/messages_deleteHistory.md index 45e9890d..601d1876 100644 --- a/old_docs/API_docs_v65/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v65/methods/messages_deleteHistory.md @@ -12,9 +12,9 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|just\_clear|[CLICK ME Bool](../types/Bool.md) | Optional|Only clear it from your side| +|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,13 +22,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_deleteMessages.md b/old_docs/API_docs_v65/methods/messages_deleteMessages.md index c8670444..900e9d0e 100644 --- a/old_docs/API_docs_v65/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v65/methods/messages_deleteMessages.md @@ -12,8 +12,8 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|revoke|[CLICK ME Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,13 +21,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({revoke=Bool, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v65/methods/messages_editChatAdmin.md b/old_docs/API_docs_v65/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v65/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v65/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_editChatPhoto.md b/old_docs/API_docs_v65/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v65/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v65/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_editChatTitle.md b/old_docs/API_docs_v65/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v65/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v65/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v65/methods/messages_editInlineBotMessage.md index 73c8a2c4..4729b52a 100644 --- a/old_docs/API_docs_v65/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v65/methods/messages_editInlineBotMessage.md @@ -12,11 +12,11 @@ Edit a sent inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,14 +25,6 @@ Edit a sent inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| - - ### MadelineProto Example: @@ -120,3 +112,11 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v65/methods/messages_editMessage.md b/old_docs/API_docs_v65/methods/messages_editMessage.md index ad639325..4380aba6 100644 --- a/old_docs/API_docs_v65/methods/messages_editMessage.md +++ b/old_docs/API_docs_v65/methods/messages_editMessage.md @@ -12,12 +12,12 @@ Edit a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -26,22 +26,6 @@ Edit a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -129,3 +113,19 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v65/methods/messages_exportChatInvite.md b/old_docs/API_docs_v65/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v65/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v65/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_forwardMessage.md b/old_docs/API_docs_v65/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v65/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v65/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v65/methods/messages_forwardMessages.md b/old_docs/API_docs_v65/methods/messages_forwardMessages.md index b99e1d31..2a0455e4 100644 --- a/old_docs/API_docs_v65/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v65/methods/messages_forwardMessages.md @@ -12,11 +12,11 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[CLICK ME Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| +|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -25,34 +25,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -108,3 +80,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/messages_getAllChats.md b/old_docs/API_docs_v65/methods/messages_getAllChats.md index 513fc06f..c4851369 100644 --- a/old_docs/API_docs_v65/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v65/methods/messages_getAllChats.md @@ -12,7 +12,7 @@ Get all chats (not supergroups or channels) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v65/methods/messages_getAllStickers.md b/old_docs/API_docs_v65/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v65/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v65/methods/messages_getArchivedStickers.md index ee36b542..dfd5c006 100644 --- a/old_docs/API_docs_v65/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getArchivedStickers.md @@ -12,9 +12,9 @@ Get all archived stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| +|masks|[Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| +|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v65/methods/messages_getAttachedStickers.md index 9f8a66c5..8f51f38d 100644 --- a/old_docs/API_docs_v65/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getAttachedStickers.md @@ -12,7 +12,7 @@ Get stickers attachable to images | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v65/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v65/methods/messages_getBotCallbackAnswer.md index 0136227f..4b8887ad 100644 --- a/old_docs/API_docs_v65/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v65/methods/messages_getBotCallbackAnswer.md @@ -12,10 +12,10 @@ Get the callback answer of a bot (after clicking a button) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|game|[Bool](../types/Bool.md) | Optional|Is this a game?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) @@ -23,17 +23,6 @@ Get the callback answer of a bot (after clicking a button) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|DATA_INVALID|Encrypted data invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: messages_BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/messages_getChats.md b/old_docs/API_docs_v65/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v65/methods/messages_getChats.md +++ b/old_docs/API_docs_v65/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_getCommonChats.md b/old_docs/API_docs_v65/methods/messages_getCommonChats.md index 15ed6713..6ffa0948 100644 --- a/old_docs/API_docs_v65/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v65/methods/messages_getCommonChats.md @@ -13,8 +13,8 @@ Get chats in common with a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -22,13 +22,6 @@ Get chats in common with a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_Chats = messages.getCommonChats({user_id=InputUser, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_getDialogs.md b/old_docs/API_docs_v65/methods/messages_getDialogs.md index 53f9ac62..1035e8ce 100644 --- a/old_docs/API_docs_v65/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v65/methods/messages_getDialogs.md @@ -12,11 +12,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|exclude\_pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -24,16 +24,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v65/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v65/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v65/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v65/methods/messages_getFeaturedStickers.md index 8e49e1ef..af7f69a0 100644 --- a/old_docs/API_docs_v65/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getFeaturedStickers.md @@ -12,7 +12,7 @@ Get featured stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getGameHighScores.md b/old_docs/API_docs_v65/methods/messages_getGameHighScores.md index 113e4647..af3f3915 100644 --- a/old_docs/API_docs_v65/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v65/methods/messages_getGameHighScores.md @@ -13,7 +13,7 @@ Get high scores of a game | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -22,14 +22,6 @@ Get high scores of a game ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -79,3 +71,11 @@ Or, if you're into Lua: messages_HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v65/methods/messages_getHistory.md b/old_docs/API_docs_v65/methods/messages_getHistory.md index 851d2680..86a744cf 100644 --- a/old_docs/API_docs_v65/methods/messages_getHistory.md +++ b/old_docs/API_docs_v65/methods/messages_getHistory.md @@ -13,12 +13,12 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -26,18 +26,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v65/methods/messages_getInlineBotResults.md index 4d86caf5..207624a7 100644 --- a/old_docs/API_docs_v65/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v65/methods/messages_getInlineBotResults.md @@ -14,9 +14,9 @@ Call inline bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -24,16 +24,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v65/methods/messages_getInlineGameHighScores.md index d5a80005..e03bc273 100644 --- a/old_docs/API_docs_v65/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v65/methods/messages_getInlineGameHighScores.md @@ -12,7 +12,7 @@ Get high scores of a game sent in an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -21,14 +21,6 @@ Get high scores of a game sent in an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v65/methods/messages_getMaskStickers.md b/old_docs/API_docs_v65/methods/messages_getMaskStickers.md index 70e2e6d4..1fbd9346 100644 --- a/old_docs/API_docs_v65/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getMaskStickers.md @@ -12,7 +12,7 @@ Get masks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getMessageEditData.md b/old_docs/API_docs_v65/methods/messages_getMessageEditData.md index 34f8534f..00c63d28 100644 --- a/old_docs/API_docs_v65/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v65/methods/messages_getMessageEditData.md @@ -13,7 +13,7 @@ Check if about to edit a message or a media caption | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) @@ -21,14 +21,6 @@ Check if about to edit a message or a media caption ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v65/methods/messages_getMessages.md b/old_docs/API_docs_v65/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v65/methods/messages_getMessages.md +++ b/old_docs/API_docs_v65/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v65/methods/messages_getMessagesViews.md b/old_docs/API_docs_v65/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v65/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v65/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v65/methods/messages_getPeerDialogs.md index 063b6e7d..000e8eb6 100644 --- a/old_docs/API_docs_v65/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v65/methods/messages_getPeerDialogs.md @@ -20,14 +20,6 @@ Get dialog info of peers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: messages_PeerDialogs = messages.getPeerDialogs({peers={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_getPeerSettings.md b/old_docs/API_docs_v65/methods/messages_getPeerSettings.md index a18126f0..5a3e9349 100644 --- a/old_docs/API_docs_v65/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v65/methods/messages_getPeerSettings.md @@ -20,14 +20,6 @@ Get the settings of apeer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: PeerSettings = messages.getPeerSettings({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_getRecentStickers.md b/old_docs/API_docs_v65/methods/messages_getRecentStickers.md index 0c5ae0c6..629a2bda 100644 --- a/old_docs/API_docs_v65/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getRecentStickers.md @@ -12,8 +12,8 @@ Get recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getSavedGifs.md b/old_docs/API_docs_v65/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v65/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v65/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v65/methods/messages_getStickerSet.md b/old_docs/API_docs_v65/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v65/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v65/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_getWebPage.md b/old_docs/API_docs_v65/methods/messages_getWebPage.md index 19ca94b9..1b533ebd 100644 --- a/old_docs/API_docs_v65/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v65/methods/messages_getWebPage.md @@ -12,8 +12,8 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|url|[CLICK ME string](../types/string.md) | Yes|URL| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|url|[string](../types/string.md) | Yes|URL| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) @@ -21,13 +21,6 @@ Get webpage preview ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|WC_CONVERT_URL_INVALID|WC convert URL invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: WebPage = messages.getWebPage({url='string', hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|WC_CONVERT_URL_INVALID|WC convert URL invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v65/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v65/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v65/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v65/methods/messages_hideReportSpam.md b/old_docs/API_docs_v65/methods/messages_hideReportSpam.md index 30523f2a..0bf711ea 100644 --- a/old_docs/API_docs_v65/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v65/methods/messages_hideReportSpam.md @@ -20,13 +20,6 @@ Hide report spam popup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.hideReportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_importChatInvite.md b/old_docs/API_docs_v65/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v65/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v65/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v65/methods/messages_installStickerSet.md b/old_docs/API_docs_v65/methods/messages_installStickerSet.md index 20f90b71..d6caf555 100644 --- a/old_docs/API_docs_v65/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v65/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_migrateChat.md b/old_docs/API_docs_v65/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v65/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v65/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v65/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v65/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v65/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v65/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v65/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v65/methods/messages_readFeaturedStickers.md index 050371da..3b01171b 100644 --- a/old_docs/API_docs_v65/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v65/methods/messages_readFeaturedStickers.md @@ -12,7 +12,7 @@ Mark new featured stickers as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| +|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_readHistory.md b/old_docs/API_docs_v65/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v65/methods/messages_readHistory.md +++ b/old_docs/API_docs_v65/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/messages_readMessageContents.md b/old_docs/API_docs_v65/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v65/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v65/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v65/methods/messages_receivedMessages.md b/old_docs/API_docs_v65/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v65/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v65/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v65/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v65/methods/messages_reorderPinnedDialogs.md index 94d3b2d4..232117e8 100644 --- a/old_docs/API_docs_v65/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v65/methods/messages_reorderPinnedDialogs.md @@ -12,7 +12,7 @@ Reorder pinned dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|force|[Bool](../types/Bool.md) | Optional|Force reordering| |order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| @@ -21,13 +21,6 @@ Reorder pinned dialogs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.reorderPinnedDialogs({force=Bool, order={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v65/methods/messages_reorderStickerSets.md index 66f5e682..6a71da86 100644 --- a/old_docs/API_docs_v65/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v65/methods/messages_reorderStickerSets.md @@ -12,8 +12,8 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v65/methods/messages_reportEncryptedSpam.md index cd03c35c..988e0101 100644 --- a/old_docs/API_docs_v65/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v65/methods/messages_reportEncryptedSpam.md @@ -20,13 +20,6 @@ Report for spam a secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportEncryptedSpam({peer=InputEncryptedChat, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_reportSpam.md b/old_docs/API_docs_v65/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v65/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v65/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_saveDraft.md b/old_docs/API_docs_v65/methods/messages_saveDraft.md index 59b33b03..60d72c1e 100644 --- a/old_docs/API_docs_v65/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v65/methods/messages_saveDraft.md @@ -12,11 +12,11 @@ Save a message draft | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,13 +25,6 @@ Save a message draft ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -104,3 +97,10 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_saveGif.md b/old_docs/API_docs_v65/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v65/methods/messages_saveGif.md +++ b/old_docs/API_docs_v65/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v65/methods/messages_saveRecentSticker.md index 55757080..d2418881 100644 --- a/old_docs/API_docs_v65/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v65/methods/messages_saveRecentSticker.md @@ -12,9 +12,9 @@ Add a sticker to recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Add a sticker to recent stickers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.saveRecentSticker({attached=Bool, id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_search.md b/old_docs/API_docs_v65/methods/messages_search.md index 735ddf47..63d58b40 100644 --- a/old_docs/API_docs_v65/methods/messages_search.md +++ b/old_docs/API_docs_v65/methods/messages_search.md @@ -13,13 +13,13 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,19 +27,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -90,3 +77,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_searchGifs.md b/old_docs/API_docs_v65/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v65/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v65/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v65/methods/messages_searchGlobal.md b/old_docs/API_docs_v65/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v65/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v65/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v65/methods/messages_sendEncrypted.md b/old_docs/API_docs_v65/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v65/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v65/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v65/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v65/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v65/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v65/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v65/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v65/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v65/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v65/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v65/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v65/methods/messages_sendInlineBotResult.md index 758aa97f..d1f9fbd0 100644 --- a/old_docs/API_docs_v65/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v65/methods/messages_sendInlineBotResult.md @@ -12,13 +12,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -26,18 +26,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v65/methods/messages_sendMedia.md b/old_docs/API_docs_v65/methods/messages_sendMedia.md index 770d1b65..94e27b83 100644 --- a/old_docs/API_docs_v65/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v65/methods/messages_sendMedia.md @@ -12,13 +12,13 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -26,34 +26,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -117,3 +89,31 @@ Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, pe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/messages_sendMessage.md b/old_docs/API_docs_v65/methods/messages_sendMessage.md index 83dc6c8b..ba76f230 100644 --- a/old_docs/API_docs_v65/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v65/methods/messages_sendMessage.md @@ -12,15 +12,15 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,33 +29,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -143,3 +116,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v65/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v65/methods/messages_setBotCallbackAnswer.md index e221ccca..34c7bb16 100644 --- a/old_docs/API_docs_v65/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v65/methods/messages_setBotCallbackAnswer.md @@ -12,11 +12,11 @@ Bots only: set the callback answer (after a button was clicked) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|message|[CLICK ME string](../types/string.md) | Optional|The message| -|url|[CLICK ME string](../types/string.md) | Optional|The URL| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| +|url|[string](../types/string.md) | Optional|The URL| +|cache\_time|[int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) @@ -24,13 +24,6 @@ Bots only: set the callback answer (after a button was clicked) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -90,3 +83,10 @@ Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v65/methods/messages_setBotPrecheckoutResults.md index 7e3fc3c2..f631bf0c 100644 --- a/old_docs/API_docs_v65/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v65/methods/messages_setBotPrecheckoutResults.md @@ -12,9 +12,9 @@ Bots only: set precheckout results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| +|success|[Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set precheckout results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ERROR_TEXT_EMPTY|The provided error message is empty| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotPrecheckoutResults({success=Bool, query_id=long, error='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ERROR_TEXT_EMPTY|The provided error message is empty| + + diff --git a/old_docs/API_docs_v65/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v65/methods/messages_setBotShippingResults.md index 3d9f0ae2..915cfebf 100644 --- a/old_docs/API_docs_v65/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v65/methods/messages_setBotShippingResults.md @@ -12,9 +12,9 @@ Bots only: set shipping results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set shipping results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotShippingResults({query_id=long, error='string', shipping_options={ShippingOption}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v65/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v65/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v65/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_setGameScore.md b/old_docs/API_docs_v65/methods/messages_setGameScore.md index 90594a1d..c3d5a2c7 100644 --- a/old_docs/API_docs_v65/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v65/methods/messages_setGameScore.md @@ -12,12 +12,12 @@ Set the game score | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) @@ -25,14 +25,6 @@ Set the game score ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: Updates = messages.setGameScore({edit_message=Bool, force=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v65/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v65/methods/messages_setInlineBotResults.md index d4ba6e65..e46598e2 100644 --- a/old_docs/API_docs_v65/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v65/methods/messages_setInlineBotResults.md @@ -12,13 +12,13 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) @@ -26,23 +26,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -100,3 +83,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v65/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v65/methods/messages_setInlineGameScore.md index 2b7326f3..d33da5ef 100644 --- a/old_docs/API_docs_v65/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v65/methods/messages_setInlineGameScore.md @@ -12,11 +12,11 @@ Set the game score of an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) @@ -24,14 +24,6 @@ Set the game score of an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -85,3 +77,11 @@ Or, if you're into Lua: Bool = messages.setInlineGameScore({edit_message=Bool, force=Bool, id=InputBotInlineMessageID, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v65/methods/messages_setTyping.md b/old_docs/API_docs_v65/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v65/methods/messages_setTyping.md +++ b/old_docs/API_docs_v65/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v65/methods/messages_startBot.md b/old_docs/API_docs_v65/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v65/methods/messages_startBot.md +++ b/old_docs/API_docs_v65/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v65/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v65/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v65/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v65/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v65/methods/messages_toggleDialogPin.md index 14332533..6c57ce0a 100644 --- a/old_docs/API_docs_v65/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v65/methods/messages_toggleDialogPin.md @@ -12,7 +12,7 @@ Pin or unpin dialog | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| @@ -21,13 +21,6 @@ Pin or unpin dialog ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.toggleDialogPin({pinned=Bool, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v65/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v65/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v65/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v65/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v65/methods/payments_clearSavedInfo.md index 8b83266f..117db209 100644 --- a/old_docs/API_docs_v65/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v65/methods/payments_clearSavedInfo.md @@ -12,8 +12,8 @@ Clear saved payments info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| +|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/payments_getPaymentForm.md b/old_docs/API_docs_v65/methods/payments_getPaymentForm.md index 3bdb9ff2..f68aa039 100644 --- a/old_docs/API_docs_v65/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v65/methods/payments_getPaymentForm.md @@ -12,7 +12,7 @@ Get payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|msg\_id|[int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) @@ -20,13 +20,6 @@ Get payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentForm = payments.getPaymentForm({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v65/methods/payments_getPaymentReceipt.md index a881aeb7..13073925 100644 --- a/old_docs/API_docs_v65/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v65/methods/payments_getPaymentReceipt.md @@ -12,7 +12,7 @@ Get payment receipt | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|msg\_id|[int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) @@ -20,13 +20,6 @@ Get payment receipt ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentReceipt = payments.getPaymentReceipt({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v65/methods/payments_sendPaymentForm.md index 79758b56..678b749b 100644 --- a/old_docs/API_docs_v65/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v65/methods/payments_sendPaymentForm.md @@ -12,10 +12,10 @@ Bots only: send payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +|msg\_id|[int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) @@ -23,13 +23,6 @@ Bots only: send payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: payments_PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v65/methods/payments_validateRequestedInfo.md index d473f97c..df6a9ba9 100644 --- a/old_docs/API_docs_v65/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v65/methods/payments_validateRequestedInfo.md @@ -12,9 +12,9 @@ Validate requested payment info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +|save|[Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) @@ -22,13 +22,6 @@ Validate requested payment info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: payments_ValidatedRequestedInfo = payments.validateRequestedInfo({save=Bool, msg_id=int, info=PaymentRequestedInfo, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v65/methods/phone_receivedCall.md b/old_docs/API_docs_v65/methods/phone_receivedCall.md index 17095622..6141a0ab 100644 --- a/old_docs/API_docs_v65/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v65/methods/phone_receivedCall.md @@ -12,7 +12,7 @@ Notify server that you received a call (server will refuse all incoming calls un | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| ### Return type: [Bool](../types/Bool.md) @@ -20,14 +20,6 @@ Notify server that you received a call (server will refuse all incoming calls un ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_ALREADY_DECLINED|The call was already declined| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = phone.receivedCall({peer=InputPhoneCall, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_ALREADY_DECLINED|The call was already declined| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v65/methods/phone_saveCallDebug.md b/old_docs/API_docs_v65/methods/phone_saveCallDebug.md index 0ff049a8..9f3daa18 100644 --- a/old_docs/API_docs_v65/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v65/methods/phone_saveCallDebug.md @@ -12,8 +12,8 @@ Save call debugging info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Debugging info| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| +|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Save call debugging info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| -|DATA_JSON_INVALID|The provided JSON data is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = phone.saveCallDebug({peer=InputPhoneCall, debug=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| +|DATA_JSON_INVALID|The provided JSON data is invalid| + + diff --git a/old_docs/API_docs_v65/methods/phone_setCallRating.md b/old_docs/API_docs_v65/methods/phone_setCallRating.md index d0aab7e0..d9833492 100644 --- a/old_docs/API_docs_v65/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v65/methods/phone_setCallRating.md @@ -12,9 +12,9 @@ Set phone call rating | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[CLICK ME int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[CLICK ME string](../types/string.md) | Yes|An optional comment| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| +|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| +|comment|[string](../types/string.md) | Yes|An optional comment| ### Return type: [Updates](../types/Updates.md) @@ -22,13 +22,6 @@ Set phone call rating ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Updates = phone.setCallRating({peer=InputPhoneCall, rating=int, comment='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v65/methods/photos_getUserPhotos.md b/old_docs/API_docs_v65/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v65/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v65/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v65/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v65/methods/photos_uploadProfilePhoto.md index c7ec3063..0c994ffe 100644 --- a/old_docs/API_docs_v65/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v65/methods/photos_uploadProfilePhoto.md @@ -20,16 +20,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -66,3 +56,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v65/methods/ping.md b/old_docs/API_docs_v65/methods/ping.md index f987ae89..daf1cc65 100644 --- a/old_docs/API_docs_v65/methods/ping.md +++ b/old_docs/API_docs_v65/methods/ping.md @@ -12,7 +12,7 @@ pings the server | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v65/methods/ping_delay_disconnect.md b/old_docs/API_docs_v65/methods/ping_delay_disconnect.md index 5b1c115d..66cc3704 100644 --- a/old_docs/API_docs_v65/methods/ping_delay_disconnect.md +++ b/old_docs/API_docs_v65/methods/ping_delay_disconnect.md @@ -12,8 +12,8 @@ Pings the server and causes disconection if the same method is not called within | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[CLICK ME int](../types/int.md) | Yes|Disconection delay| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| +|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v65/methods/req_DH_params.md b/old_docs/API_docs_v65/methods/req_DH_params.md index f0b45851..a426c699 100644 --- a/old_docs/API_docs_v65/methods/req_DH_params.md +++ b/old_docs/API_docs_v65/methods/req_DH_params.md @@ -12,12 +12,12 @@ Requests Diffie-hellman parameters for key exchange | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[CLICK ME string](../types/string.md) | Yes|factorized p from pq| -|q|[CLICK ME string](../types/string.md) | Yes|factorized q from pq| -|public\_key\_fingerprint|[CLICK ME long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[CLICK ME string](../types/string.md) | Yes|Encrypted message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|p|[string](../types/string.md) | Yes|factorized p from pq| +|q|[string](../types/string.md) | Yes|factorized q from pq| +|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| +|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/old_docs/API_docs_v65/methods/req_pq.md b/old_docs/API_docs_v65/methods/req_pq.md index 0873d9a2..d273a0b9 100644 --- a/old_docs/API_docs_v65/methods/req_pq.md +++ b/old_docs/API_docs_v65/methods/req_pq.md @@ -12,7 +12,7 @@ Requests PQ for factorization | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/old_docs/API_docs_v65/methods/rpc_drop_answer.md b/old_docs/API_docs_v65/methods/rpc_drop_answer.md index 27f98bca..34b355f3 100644 --- a/old_docs/API_docs_v65/methods/rpc_drop_answer.md +++ b/old_docs/API_docs_v65/methods/rpc_drop_answer.md @@ -12,7 +12,7 @@ Do not send answer to provided request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|req\_msg\_id|[CLICK ME long](../types/long.md) | Yes|The message ID of the request| +|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/old_docs/API_docs_v65/methods/set_client_DH_params.md b/old_docs/API_docs_v65/methods/set_client_DH_params.md index cf8ab321..5a173688 100644 --- a/old_docs/API_docs_v65/methods/set_client_DH_params.md +++ b/old_docs/API_docs_v65/methods/set_client_DH_params.md @@ -12,9 +12,9 @@ Sets client diffie-hellman parameters | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[CLICK ME string](../types/string.md) | Yes|Encrypted message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/old_docs/API_docs_v65/methods/upload_getWebFile.md b/old_docs/API_docs_v65/methods/upload_getWebFile.md index 11634633..f869519a 100644 --- a/old_docs/API_docs_v65/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v65/methods/upload_getWebFile.md @@ -12,9 +12,9 @@ Download a file through telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[int](../types/int.md) | Yes|The offset in bytes| +|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) @@ -22,13 +22,6 @@ Download a file through telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LOCATION_INVALID|The provided location is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: upload_WebFile = upload.getWebFile({location=InputWebFileLocation, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LOCATION_INVALID|The provided location is invalid| + + diff --git a/old_docs/API_docs_v65/methods/users_getUsers.md b/old_docs/API_docs_v65/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v65/methods/users_getUsers.md +++ b/old_docs/API_docs_v65/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/account_changePhone.md b/old_docs/API_docs_v66/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v66/methods/account_changePhone.md +++ b/old_docs/API_docs_v66/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_checkUsername.md b/old_docs/API_docs_v66/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v66/methods/account_checkUsername.md +++ b/old_docs/API_docs_v66/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v66/methods/account_confirmPhone.md b/old_docs/API_docs_v66/methods/account_confirmPhone.md index 68490f35..7ffabc24 100644 --- a/old_docs/API_docs_v66/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v66/methods/account_confirmPhone.md @@ -12,8 +12,8 @@ Confirm this phone number is associated to this account, obtain phone_code_hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| +|phone\_code\_hash|[string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Confirm this phone number is associated to this account, obtain phone_code_hash ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_HASH_INVALID|Code hash invalid| -|PHONE_CODE_EMPTY|phone_code is missing| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_HASH_INVALID|Code hash invalid| +|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/old_docs/API_docs_v66/methods/account_deleteAccount.md b/old_docs/API_docs_v66/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v66/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v66/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/account_getNotifySettings.md b/old_docs/API_docs_v66/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v66/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v66/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_getPasswordSettings.md b/old_docs/API_docs_v66/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v66/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v66/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_getPrivacy.md b/old_docs/API_docs_v66/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v66/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v66/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_getTmpPassword.md b/old_docs/API_docs_v66/methods/account_getTmpPassword.md index 01b1ebfc..c82ff37a 100644 --- a/old_docs/API_docs_v66/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v66/methods/account_getTmpPassword.md @@ -12,8 +12,8 @@ Get temporary password for buying products through bots | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|The password hash| -|period|[CLICK ME int](../types/int.md) | Yes|The validity period| +|password\_hash|[bytes](../types/bytes.md) | Yes|The password hash| +|period|[int](../types/int.md) | Yes|The validity period| ### Return type: [account\_TmpPassword](../types/account_TmpPassword.md) @@ -21,14 +21,6 @@ Get temporary password for buying products through bots ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| -|TMP_PASSWORD_DISABLED|The temporary password is disabled| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: account_TmpPassword = account.getTmpPassword({password_hash='bytes', period=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|TMP_PASSWORD_DISABLED|The temporary password is disabled| + + diff --git a/old_docs/API_docs_v66/methods/account_registerDevice.md b/old_docs/API_docs_v66/methods/account_registerDevice.md index 4e148a7f..cbac71d3 100644 --- a/old_docs/API_docs_v66/methods/account_registerDevice.md +++ b/old_docs/API_docs_v66/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_reportPeer.md b/old_docs/API_docs_v66/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v66/methods/account_reportPeer.md +++ b/old_docs/API_docs_v66/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_resetAuthorization.md b/old_docs/API_docs_v66/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v66/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v66/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v66/methods/account_sendChangePhoneCode.md index bdf7331f..476b6d79 100644 --- a/old_docs/API_docs_v66/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v66/methods/account_sendChangePhoneCode.md @@ -12,9 +12,9 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|Current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v66/methods/account_sendConfirmPhoneCode.md index 86035d19..8917355f 100644 --- a/old_docs/API_docs_v66/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v66/methods/account_sendConfirmPhoneCode.md @@ -12,9 +12,9 @@ Send confirmation phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| -|hash|[CLICK ME string](../types/string.md) | Yes|The hash| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|The current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| +|hash|[string](../types/string.md) | Yes|The hash| +|current\_number|[Bool](../types/Bool.md) | Optional|The current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Send confirmation phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendConfirmPhoneCode({allow_flashcall=Bool, hash='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_setAccountTTL.md b/old_docs/API_docs_v66/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v66/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v66/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_setPrivacy.md b/old_docs/API_docs_v66/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v66/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v66/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_unregisterDevice.md b/old_docs/API_docs_v66/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v66/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v66/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v66/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v66/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v66/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/account_updateNotifySettings.md b/old_docs/API_docs_v66/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v66/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v66/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v66/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v66/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v66/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_updateProfile.md b/old_docs/API_docs_v66/methods/account_updateProfile.md index 59629188..ef19dc00 100644 --- a/old_docs/API_docs_v66/methods/account_updateProfile.md +++ b/old_docs/API_docs_v66/methods/account_updateProfile.md @@ -12,9 +12,9 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Optional|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Optional|The last name| -|about|[CLICK ME string](../types/string.md) | Optional|The bio/about field| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| ### Return type: [User](../types/User.md) @@ -22,14 +22,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v66/methods/account_updateStatus.md b/old_docs/API_docs_v66/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v66/methods/account_updateStatus.md +++ b/old_docs/API_docs_v66/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v66/methods/account_updateUsername.md b/old_docs/API_docs_v66/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v66/methods/account_updateUsername.md +++ b/old_docs/API_docs_v66/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v66/methods/auth_cancelCode.md b/old_docs/API_docs_v66/methods/auth_cancelCode.md index 52b85d4c..84401c62 100644 --- a/old_docs/API_docs_v66/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v66/methods/auth_cancelCode.md @@ -12,8 +12,8 @@ Invalidate sent phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invalidate sent phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v66/methods/auth_checkPhone.md b/old_docs/API_docs_v66/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v66/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v66/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v66/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v66/methods/auth_dropTempAuthKeys.md index 5aa98b3b..537afbc1 100644 --- a/old_docs/API_docs_v66/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v66/methods/auth_dropTempAuthKeys.md @@ -12,7 +12,7 @@ Delete all temporary authorization keys except the ones provided | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_auth\_keys|Array of [CLICK ME long](../types/long.md) | Yes|The temporary authorization keys to keep| +|except\_auth\_keys|Array of [long](../types/long.md) | Yes|The temporary authorization keys to keep| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/auth_recoverPassword.md b/old_docs/API_docs_v66/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v66/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v66/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v66/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v66/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v66/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v66/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v66/methods/auth_resendCode.md b/old_docs/API_docs_v66/methods/auth_resendCode.md index 253480a3..4402bfe6 100644 --- a/old_docs/API_docs_v66/methods/auth_resendCode.md +++ b/old_docs/API_docs_v66/methods/auth_resendCode.md @@ -12,8 +12,8 @@ Resend the SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -21,13 +21,6 @@ Resend the SMS verification code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v66/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v66/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v66/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v66/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/auth_sendInvites.md b/old_docs/API_docs_v66/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v66/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v66/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v66/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v66/methods/bots_answerWebhookJSONQuery.md index 40cb0477..3dbf62ef 100644 --- a/old_docs/API_docs_v66/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v66/methods/bots_answerWebhookJSONQuery.md @@ -12,8 +12,8 @@ Send webhook request via bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|data|[DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Send webhook request via bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Bool = bots.answerWebhookJSONQuery({query_id=long, data=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v66/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v66/methods/bots_sendCustomRequest.md index 5a7f4e86..cb7c32e2 100644 --- a/old_docs/API_docs_v66/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v66/methods/bots_sendCustomRequest.md @@ -12,8 +12,8 @@ Send a custom request to the bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| +|custom\_method|[string](../types/string.md) | Yes|The method to call| +|params|[DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) @@ -21,13 +21,6 @@ Send a custom request to the bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: DataJSON = bots.sendCustomRequest({custom_method='string', params=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v66/methods/channels_checkUsername.md b/old_docs/API_docs_v66/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v66/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v66/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v66/methods/channels_createChannel.md b/old_docs/API_docs_v66/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v66/methods/channels_createChannel.md +++ b/old_docs/API_docs_v66/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v66/methods/channels_deleteChannel.md b/old_docs/API_docs_v66/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v66/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v66/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v66/methods/channels_deleteMessages.md b/old_docs/API_docs_v66/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v66/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v66/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v66/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v66/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v66/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v66/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v66/methods/channels_editAbout.md b/old_docs/API_docs_v66/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v66/methods/channels_editAbout.md +++ b/old_docs/API_docs_v66/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v66/methods/channels_editAdmin.md b/old_docs/API_docs_v66/methods/channels_editAdmin.md index 7b6cc0f1..62f1fdaa 100644 --- a/old_docs/API_docs_v66/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v66/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v66/methods/channels_editPhoto.md b/old_docs/API_docs_v66/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v66/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v66/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v66/methods/channels_editTitle.md b/old_docs/API_docs_v66/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v66/methods/channels_editTitle.md +++ b/old_docs/API_docs_v66/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v66/methods/channels_exportInvite.md b/old_docs/API_docs_v66/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v66/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v66/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v66/methods/channels_exportMessageLink.md b/old_docs/API_docs_v66/methods/channels_exportMessageLink.md index b4a3c645..20f6e998 100644 --- a/old_docs/API_docs_v66/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v66/methods/channels_exportMessageLink.md @@ -13,7 +13,7 @@ Get the link of a message in a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| +|id|[int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -21,13 +21,6 @@ Get the link of a message in a channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v66/methods/channels_getChannels.md b/old_docs/API_docs_v66/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v66/methods/channels_getChannels.md +++ b/old_docs/API_docs_v66/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v66/methods/channels_getMessages.md b/old_docs/API_docs_v66/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v66/methods/channels_getMessages.md +++ b/old_docs/API_docs_v66/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v66/methods/channels_getParticipant.md b/old_docs/API_docs_v66/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v66/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v66/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v66/methods/channels_getParticipants.md b/old_docs/API_docs_v66/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v66/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v66/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/channels_inviteToChannel.md b/old_docs/API_docs_v66/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v66/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v66/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v66/methods/channels_joinChannel.md b/old_docs/API_docs_v66/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v66/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v66/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v66/methods/channels_kickFromChannel.md b/old_docs/API_docs_v66/methods/channels_kickFromChannel.md index 8f6c92be..0c6c0258 100644 --- a/old_docs/API_docs_v66/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v66/methods/channels_kickFromChannel.md @@ -14,7 +14,7 @@ Kick user from channel |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick| -|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|Kick or unkick?| +|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_leaveChannel.md b/old_docs/API_docs_v66/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v66/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v66/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v66/methods/channels_readHistory.md b/old_docs/API_docs_v66/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v66/methods/channels_readHistory.md +++ b/old_docs/API_docs_v66/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v66/methods/channels_reportSpam.md b/old_docs/API_docs_v66/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v66/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v66/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v66/methods/channels_toggleInvites.md b/old_docs/API_docs_v66/methods/channels_toggleInvites.md index e9e6450d..d437682f 100644 --- a/old_docs/API_docs_v66/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v66/methods/channels_toggleInvites.md @@ -13,7 +13,7 @@ Allow or disallow any user to invite users to this channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Allow or disallow any user to invite users to this channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v66/methods/channels_toggleSignatures.md b/old_docs/API_docs_v66/methods/channels_toggleSignatures.md index 36d1eccb..d40bf67b 100644 --- a/old_docs/API_docs_v66/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v66/methods/channels_toggleSignatures.md @@ -13,7 +13,7 @@ Toggle channel signatures | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Toggle channel signatures ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v66/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v66/methods/channels_updatePinnedMessage.md index f8d10ece..aa2cc783 100644 --- a/old_docs/API_docs_v66/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v66/methods/channels_updatePinnedMessage.md @@ -12,9 +12,9 @@ Set the pinned message of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Set the pinned message of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -81,3 +71,13 @@ Or, if you're into Lua: Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v66/methods/channels_updateUsername.md b/old_docs/API_docs_v66/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v66/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v66/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v66/methods/contacts_block.md b/old_docs/API_docs_v66/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v66/methods/contacts_block.md +++ b/old_docs/API_docs_v66/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v66/methods/contacts_deleteContact.md b/old_docs/API_docs_v66/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v66/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v66/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v66/methods/contacts_deleteContacts.md b/old_docs/API_docs_v66/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v66/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v66/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/contacts_getBlocked.md b/old_docs/API_docs_v66/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v66/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v66/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v66/methods/contacts_getContacts.md b/old_docs/API_docs_v66/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v66/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v66/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v66/methods/contacts_getTopPeers.md b/old_docs/API_docs_v66/methods/contacts_getTopPeers.md index 8d39809c..b5108fd2 100644 --- a/old_docs/API_docs_v66/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v66/methods/contacts_getTopPeers.md @@ -12,14 +12,14 @@ Get most used chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|correspondents|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch users?| -|bots\_pm|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch bots?| -|bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| -|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| -|channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| +|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?| +|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?| +|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?| +|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?| +|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| +|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|limit|[int](../types/int.md) | Yes|How many results to fetch| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| ### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) @@ -27,13 +27,6 @@ Get most used chats ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TYPES_EMPTY|The types field is empty| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ Or, if you're into Lua: contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field is empty| + + diff --git a/old_docs/API_docs_v66/methods/contacts_importCard.md b/old_docs/API_docs_v66/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v66/methods/contacts_importCard.md +++ b/old_docs/API_docs_v66/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v66/methods/contacts_importContacts.md b/old_docs/API_docs_v66/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v66/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v66/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v66/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v66/methods/contacts_resetTopPeerRating.md index 4b5e96f1..15b07f96 100644 --- a/old_docs/API_docs_v66/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v66/methods/contacts_resetTopPeerRating.md @@ -12,7 +12,7 @@ Reset top peer rating for a certain category/peer | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| @@ -21,13 +21,6 @@ Reset top peer rating for a certain category/peer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/contacts_search.md b/old_docs/API_docs_v66/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v66/methods/contacts_search.md +++ b/old_docs/API_docs_v66/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/contacts_unblock.md b/old_docs/API_docs_v66/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v66/methods/contacts_unblock.md +++ b/old_docs/API_docs_v66/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v66/methods/contest_saveDeveloperInfo.md b/old_docs/API_docs_v66/methods/contest_saveDeveloperInfo.md index 5d82a4be..de23c472 100644 --- a/old_docs/API_docs_v66/methods/contest_saveDeveloperInfo.md +++ b/old_docs/API_docs_v66/methods/contest_saveDeveloperInfo.md @@ -12,11 +12,11 @@ Save developer info for telegram contest | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|vk\_id|[CLICK ME int](../types/int.md) | Yes|VK user ID| -|name|[CLICK ME string](../types/string.md) | Yes|Name| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|age|[CLICK ME int](../types/int.md) | Yes|Age| -|city|[CLICK ME string](../types/string.md) | Yes|City| +|vk\_id|[int](../types/int.md) | Yes|VK user ID| +|name|[string](../types/string.md) | Yes|Name| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|age|[int](../types/int.md) | Yes|Age| +|city|[string](../types/string.md) | Yes|City| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/destroy_session.md b/old_docs/API_docs_v66/methods/destroy_session.md index b74fbd11..c4187ce0 100644 --- a/old_docs/API_docs_v66/methods/destroy_session.md +++ b/old_docs/API_docs_v66/methods/destroy_session.md @@ -12,7 +12,7 @@ Destroy the current MTProto session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|session\_id|[CLICK ME long](../types/long.md) | Yes|The session to destroy| +|session\_id|[long](../types/long.md) | Yes|The session to destroy| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/old_docs/API_docs_v66/methods/get_future_salts.md b/old_docs/API_docs_v66/methods/get_future_salts.md index e8451015..7f5fc18c 100644 --- a/old_docs/API_docs_v66/methods/get_future_salts.md +++ b/old_docs/API_docs_v66/methods/get_future_salts.md @@ -12,7 +12,7 @@ Get future salts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|num|[CLICK ME int](../types/int.md) | Yes|How many salts should be fetched| +|num|[int](../types/int.md) | Yes|How many salts should be fetched| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/old_docs/API_docs_v66/methods/help_getAppChangelog.md b/old_docs/API_docs_v66/methods/help_getAppChangelog.md index eda473a6..183ebb8c 100644 --- a/old_docs/API_docs_v66/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v66/methods/help_getAppChangelog.md @@ -12,7 +12,7 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| +|prev\_app\_version|[string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/help_getCdnConfig.md b/old_docs/API_docs_v66/methods/help_getCdnConfig.md index b98949ed..b7af5bb4 100644 --- a/old_docs/API_docs_v66/methods/help_getCdnConfig.md +++ b/old_docs/API_docs_v66/methods/help_getCdnConfig.md @@ -15,13 +15,6 @@ Get CDN configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: CdnConfig = help.getCdnConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/help_getConfig.md b/old_docs/API_docs_v66/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v66/methods/help_getConfig.md +++ b/old_docs/API_docs_v66/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/help_saveAppLog.md b/old_docs/API_docs_v66/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v66/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v66/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v66/methods/help_setBotUpdatesStatus.md index a1a3ab1b..1766ee14 100644 --- a/old_docs/API_docs_v66/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v66/methods/help_setBotUpdatesStatus.md @@ -12,8 +12,8 @@ Set the update status of webhook | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| -|message|[CLICK ME string](../types/string.md) | Yes|Message| +|pending\_updates\_count|[int](../types/int.md) | Yes|Pending update count| +|message|[string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/initConnection.md b/old_docs/API_docs_v66/methods/initConnection.md index 73620276..e1a750cd 100644 --- a/old_docs/API_docs_v66/methods/initConnection.md +++ b/old_docs/API_docs_v66/methods/initConnection.md @@ -12,12 +12,12 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -25,14 +25,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v66/methods/invokeAfterMsg.md b/old_docs/API_docs_v66/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v66/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v66/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v66/methods/invokeAfterMsgs.md b/old_docs/API_docs_v66/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v66/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v66/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v66/methods/invokeWithLayer.md b/old_docs/API_docs_v66/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v66/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v66/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v66/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v66/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v66/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v66/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v66/methods/messages_addChatUser.md b/old_docs/API_docs_v66/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v66/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v66/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v66/methods/messages_checkChatInvite.md b/old_docs/API_docs_v66/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v66/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v66/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v66/methods/messages_clearRecentStickers.md index 1d6ec8c9..72c4844b 100644 --- a/old_docs/API_docs_v66/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v66/methods/messages_clearRecentStickers.md @@ -12,7 +12,7 @@ Clear all recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_createChat.md b/old_docs/API_docs_v66/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v66/methods/messages_createChat.md +++ b/old_docs/API_docs_v66/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v66/methods/messages_deleteChatUser.md b/old_docs/API_docs_v66/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v66/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v66/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v66/methods/messages_deleteHistory.md b/old_docs/API_docs_v66/methods/messages_deleteHistory.md index 45e9890d..601d1876 100644 --- a/old_docs/API_docs_v66/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v66/methods/messages_deleteHistory.md @@ -12,9 +12,9 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|just\_clear|[CLICK ME Bool](../types/Bool.md) | Optional|Only clear it from your side| +|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,13 +22,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_deleteMessages.md b/old_docs/API_docs_v66/methods/messages_deleteMessages.md index c8670444..900e9d0e 100644 --- a/old_docs/API_docs_v66/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v66/methods/messages_deleteMessages.md @@ -12,8 +12,8 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|revoke|[CLICK ME Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,13 +21,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({revoke=Bool, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v66/methods/messages_editChatAdmin.md b/old_docs/API_docs_v66/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v66/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v66/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_editChatPhoto.md b/old_docs/API_docs_v66/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v66/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v66/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_editChatTitle.md b/old_docs/API_docs_v66/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v66/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v66/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v66/methods/messages_editInlineBotMessage.md index 73c8a2c4..4729b52a 100644 --- a/old_docs/API_docs_v66/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v66/methods/messages_editInlineBotMessage.md @@ -12,11 +12,11 @@ Edit a sent inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,14 +25,6 @@ Edit a sent inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| - - ### MadelineProto Example: @@ -120,3 +112,11 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v66/methods/messages_editMessage.md b/old_docs/API_docs_v66/methods/messages_editMessage.md index ad639325..4380aba6 100644 --- a/old_docs/API_docs_v66/methods/messages_editMessage.md +++ b/old_docs/API_docs_v66/methods/messages_editMessage.md @@ -12,12 +12,12 @@ Edit a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -26,22 +26,6 @@ Edit a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -129,3 +113,19 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v66/methods/messages_exportChatInvite.md b/old_docs/API_docs_v66/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v66/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v66/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_forwardMessage.md b/old_docs/API_docs_v66/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v66/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v66/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v66/methods/messages_forwardMessages.md b/old_docs/API_docs_v66/methods/messages_forwardMessages.md index b99e1d31..2a0455e4 100644 --- a/old_docs/API_docs_v66/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v66/methods/messages_forwardMessages.md @@ -12,11 +12,11 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[CLICK ME Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| +|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -25,34 +25,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -108,3 +80,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/messages_getAllChats.md b/old_docs/API_docs_v66/methods/messages_getAllChats.md index 513fc06f..c4851369 100644 --- a/old_docs/API_docs_v66/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v66/methods/messages_getAllChats.md @@ -12,7 +12,7 @@ Get all chats (not supergroups or channels) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v66/methods/messages_getAllStickers.md b/old_docs/API_docs_v66/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v66/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v66/methods/messages_getArchivedStickers.md index ee36b542..dfd5c006 100644 --- a/old_docs/API_docs_v66/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getArchivedStickers.md @@ -12,9 +12,9 @@ Get all archived stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| +|masks|[Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| +|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v66/methods/messages_getAttachedStickers.md index 9f8a66c5..8f51f38d 100644 --- a/old_docs/API_docs_v66/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getAttachedStickers.md @@ -12,7 +12,7 @@ Get stickers attachable to images | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v66/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v66/methods/messages_getBotCallbackAnswer.md index 0136227f..4b8887ad 100644 --- a/old_docs/API_docs_v66/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v66/methods/messages_getBotCallbackAnswer.md @@ -12,10 +12,10 @@ Get the callback answer of a bot (after clicking a button) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|game|[Bool](../types/Bool.md) | Optional|Is this a game?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) @@ -23,17 +23,6 @@ Get the callback answer of a bot (after clicking a button) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|DATA_INVALID|Encrypted data invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: messages_BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/messages_getChats.md b/old_docs/API_docs_v66/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v66/methods/messages_getChats.md +++ b/old_docs/API_docs_v66/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_getCommonChats.md b/old_docs/API_docs_v66/methods/messages_getCommonChats.md index 15ed6713..6ffa0948 100644 --- a/old_docs/API_docs_v66/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v66/methods/messages_getCommonChats.md @@ -13,8 +13,8 @@ Get chats in common with a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -22,13 +22,6 @@ Get chats in common with a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_Chats = messages.getCommonChats({user_id=InputUser, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_getDialogs.md b/old_docs/API_docs_v66/methods/messages_getDialogs.md index 53f9ac62..1035e8ce 100644 --- a/old_docs/API_docs_v66/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v66/methods/messages_getDialogs.md @@ -12,11 +12,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|exclude\_pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -24,16 +24,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v66/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v66/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v66/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v66/methods/messages_getFeaturedStickers.md index 8e49e1ef..af7f69a0 100644 --- a/old_docs/API_docs_v66/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getFeaturedStickers.md @@ -12,7 +12,7 @@ Get featured stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getGameHighScores.md b/old_docs/API_docs_v66/methods/messages_getGameHighScores.md index 113e4647..af3f3915 100644 --- a/old_docs/API_docs_v66/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v66/methods/messages_getGameHighScores.md @@ -13,7 +13,7 @@ Get high scores of a game | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -22,14 +22,6 @@ Get high scores of a game ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -79,3 +71,11 @@ Or, if you're into Lua: messages_HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v66/methods/messages_getHistory.md b/old_docs/API_docs_v66/methods/messages_getHistory.md index 851d2680..86a744cf 100644 --- a/old_docs/API_docs_v66/methods/messages_getHistory.md +++ b/old_docs/API_docs_v66/methods/messages_getHistory.md @@ -13,12 +13,12 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -26,18 +26,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v66/methods/messages_getInlineBotResults.md index 4d86caf5..207624a7 100644 --- a/old_docs/API_docs_v66/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v66/methods/messages_getInlineBotResults.md @@ -14,9 +14,9 @@ Call inline bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -24,16 +24,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v66/methods/messages_getInlineGameHighScores.md index d5a80005..e03bc273 100644 --- a/old_docs/API_docs_v66/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v66/methods/messages_getInlineGameHighScores.md @@ -12,7 +12,7 @@ Get high scores of a game sent in an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -21,14 +21,6 @@ Get high scores of a game sent in an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v66/methods/messages_getMaskStickers.md b/old_docs/API_docs_v66/methods/messages_getMaskStickers.md index 70e2e6d4..1fbd9346 100644 --- a/old_docs/API_docs_v66/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getMaskStickers.md @@ -12,7 +12,7 @@ Get masks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getMessageEditData.md b/old_docs/API_docs_v66/methods/messages_getMessageEditData.md index 34f8534f..00c63d28 100644 --- a/old_docs/API_docs_v66/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v66/methods/messages_getMessageEditData.md @@ -13,7 +13,7 @@ Check if about to edit a message or a media caption | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) @@ -21,14 +21,6 @@ Check if about to edit a message or a media caption ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v66/methods/messages_getMessages.md b/old_docs/API_docs_v66/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v66/methods/messages_getMessages.md +++ b/old_docs/API_docs_v66/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v66/methods/messages_getMessagesViews.md b/old_docs/API_docs_v66/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v66/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v66/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v66/methods/messages_getPeerDialogs.md index 063b6e7d..000e8eb6 100644 --- a/old_docs/API_docs_v66/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v66/methods/messages_getPeerDialogs.md @@ -20,14 +20,6 @@ Get dialog info of peers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: messages_PeerDialogs = messages.getPeerDialogs({peers={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_getPeerSettings.md b/old_docs/API_docs_v66/methods/messages_getPeerSettings.md index a18126f0..5a3e9349 100644 --- a/old_docs/API_docs_v66/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v66/methods/messages_getPeerSettings.md @@ -20,14 +20,6 @@ Get the settings of apeer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: PeerSettings = messages.getPeerSettings({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_getRecentStickers.md b/old_docs/API_docs_v66/methods/messages_getRecentStickers.md index 0c5ae0c6..629a2bda 100644 --- a/old_docs/API_docs_v66/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getRecentStickers.md @@ -12,8 +12,8 @@ Get recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getSavedGifs.md b/old_docs/API_docs_v66/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v66/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v66/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v66/methods/messages_getStickerSet.md b/old_docs/API_docs_v66/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v66/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v66/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_getWebPage.md b/old_docs/API_docs_v66/methods/messages_getWebPage.md index 19ca94b9..1b533ebd 100644 --- a/old_docs/API_docs_v66/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v66/methods/messages_getWebPage.md @@ -12,8 +12,8 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|url|[CLICK ME string](../types/string.md) | Yes|URL| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|url|[string](../types/string.md) | Yes|URL| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) @@ -21,13 +21,6 @@ Get webpage preview ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|WC_CONVERT_URL_INVALID|WC convert URL invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: WebPage = messages.getWebPage({url='string', hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|WC_CONVERT_URL_INVALID|WC convert URL invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v66/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v66/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v66/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v66/methods/messages_hideReportSpam.md b/old_docs/API_docs_v66/methods/messages_hideReportSpam.md index 30523f2a..0bf711ea 100644 --- a/old_docs/API_docs_v66/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v66/methods/messages_hideReportSpam.md @@ -20,13 +20,6 @@ Hide report spam popup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.hideReportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_importChatInvite.md b/old_docs/API_docs_v66/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v66/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v66/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v66/methods/messages_installStickerSet.md b/old_docs/API_docs_v66/methods/messages_installStickerSet.md index 20f90b71..d6caf555 100644 --- a/old_docs/API_docs_v66/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v66/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_migrateChat.md b/old_docs/API_docs_v66/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v66/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v66/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v66/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v66/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v66/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v66/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v66/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v66/methods/messages_readFeaturedStickers.md index 050371da..3b01171b 100644 --- a/old_docs/API_docs_v66/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v66/methods/messages_readFeaturedStickers.md @@ -12,7 +12,7 @@ Mark new featured stickers as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| +|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_readHistory.md b/old_docs/API_docs_v66/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v66/methods/messages_readHistory.md +++ b/old_docs/API_docs_v66/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/messages_readMessageContents.md b/old_docs/API_docs_v66/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v66/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v66/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v66/methods/messages_receivedMessages.md b/old_docs/API_docs_v66/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v66/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v66/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v66/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v66/methods/messages_reorderPinnedDialogs.md index 94d3b2d4..232117e8 100644 --- a/old_docs/API_docs_v66/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v66/methods/messages_reorderPinnedDialogs.md @@ -12,7 +12,7 @@ Reorder pinned dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|force|[Bool](../types/Bool.md) | Optional|Force reordering| |order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| @@ -21,13 +21,6 @@ Reorder pinned dialogs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.reorderPinnedDialogs({force=Bool, order={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v66/methods/messages_reorderStickerSets.md index 66f5e682..6a71da86 100644 --- a/old_docs/API_docs_v66/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v66/methods/messages_reorderStickerSets.md @@ -12,8 +12,8 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v66/methods/messages_reportEncryptedSpam.md index cd03c35c..988e0101 100644 --- a/old_docs/API_docs_v66/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v66/methods/messages_reportEncryptedSpam.md @@ -20,13 +20,6 @@ Report for spam a secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportEncryptedSpam({peer=InputEncryptedChat, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_reportSpam.md b/old_docs/API_docs_v66/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v66/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v66/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_saveDraft.md b/old_docs/API_docs_v66/methods/messages_saveDraft.md index 59b33b03..60d72c1e 100644 --- a/old_docs/API_docs_v66/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v66/methods/messages_saveDraft.md @@ -12,11 +12,11 @@ Save a message draft | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,13 +25,6 @@ Save a message draft ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -104,3 +97,10 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_saveGif.md b/old_docs/API_docs_v66/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v66/methods/messages_saveGif.md +++ b/old_docs/API_docs_v66/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v66/methods/messages_saveRecentSticker.md index 55757080..d2418881 100644 --- a/old_docs/API_docs_v66/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v66/methods/messages_saveRecentSticker.md @@ -12,9 +12,9 @@ Add a sticker to recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Add a sticker to recent stickers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.saveRecentSticker({attached=Bool, id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_search.md b/old_docs/API_docs_v66/methods/messages_search.md index 735ddf47..63d58b40 100644 --- a/old_docs/API_docs_v66/methods/messages_search.md +++ b/old_docs/API_docs_v66/methods/messages_search.md @@ -13,13 +13,13 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|q|[string](../types/string.md) | Yes|What to search| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,19 +27,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -90,3 +77,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_searchGifs.md b/old_docs/API_docs_v66/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v66/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v66/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v66/methods/messages_searchGlobal.md b/old_docs/API_docs_v66/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v66/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v66/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v66/methods/messages_sendEncrypted.md b/old_docs/API_docs_v66/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v66/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v66/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v66/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v66/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v66/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v66/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v66/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v66/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v66/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v66/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v66/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v66/methods/messages_sendInlineBotResult.md index 758aa97f..d1f9fbd0 100644 --- a/old_docs/API_docs_v66/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v66/methods/messages_sendInlineBotResult.md @@ -12,13 +12,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -26,18 +26,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v66/methods/messages_sendMedia.md b/old_docs/API_docs_v66/methods/messages_sendMedia.md index 770d1b65..94e27b83 100644 --- a/old_docs/API_docs_v66/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v66/methods/messages_sendMedia.md @@ -12,13 +12,13 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -26,34 +26,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -117,3 +89,31 @@ Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, pe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/messages_sendMessage.md b/old_docs/API_docs_v66/methods/messages_sendMessage.md index 83dc6c8b..ba76f230 100644 --- a/old_docs/API_docs_v66/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v66/methods/messages_sendMessage.md @@ -12,15 +12,15 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,33 +29,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -143,3 +116,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v66/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v66/methods/messages_setBotCallbackAnswer.md index e221ccca..34c7bb16 100644 --- a/old_docs/API_docs_v66/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v66/methods/messages_setBotCallbackAnswer.md @@ -12,11 +12,11 @@ Bots only: set the callback answer (after a button was clicked) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|message|[CLICK ME string](../types/string.md) | Optional|The message| -|url|[CLICK ME string](../types/string.md) | Optional|The URL| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| +|url|[string](../types/string.md) | Optional|The URL| +|cache\_time|[int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) @@ -24,13 +24,6 @@ Bots only: set the callback answer (after a button was clicked) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -90,3 +83,10 @@ Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v66/methods/messages_setBotPrecheckoutResults.md index 7e3fc3c2..f631bf0c 100644 --- a/old_docs/API_docs_v66/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v66/methods/messages_setBotPrecheckoutResults.md @@ -12,9 +12,9 @@ Bots only: set precheckout results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| +|success|[Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set precheckout results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ERROR_TEXT_EMPTY|The provided error message is empty| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotPrecheckoutResults({success=Bool, query_id=long, error='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ERROR_TEXT_EMPTY|The provided error message is empty| + + diff --git a/old_docs/API_docs_v66/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v66/methods/messages_setBotShippingResults.md index 3d9f0ae2..915cfebf 100644 --- a/old_docs/API_docs_v66/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v66/methods/messages_setBotShippingResults.md @@ -12,9 +12,9 @@ Bots only: set shipping results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set shipping results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotShippingResults({query_id=long, error='string', shipping_options={ShippingOption}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v66/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v66/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v66/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_setGameScore.md b/old_docs/API_docs_v66/methods/messages_setGameScore.md index 90594a1d..c3d5a2c7 100644 --- a/old_docs/API_docs_v66/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v66/methods/messages_setGameScore.md @@ -12,12 +12,12 @@ Set the game score | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) @@ -25,14 +25,6 @@ Set the game score ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: Updates = messages.setGameScore({edit_message=Bool, force=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v66/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v66/methods/messages_setInlineBotResults.md index d4ba6e65..e46598e2 100644 --- a/old_docs/API_docs_v66/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v66/methods/messages_setInlineBotResults.md @@ -12,13 +12,13 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) @@ -26,23 +26,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -100,3 +83,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v66/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v66/methods/messages_setInlineGameScore.md index 2b7326f3..d33da5ef 100644 --- a/old_docs/API_docs_v66/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v66/methods/messages_setInlineGameScore.md @@ -12,11 +12,11 @@ Set the game score of an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) @@ -24,14 +24,6 @@ Set the game score of an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -85,3 +77,11 @@ Or, if you're into Lua: Bool = messages.setInlineGameScore({edit_message=Bool, force=Bool, id=InputBotInlineMessageID, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v66/methods/messages_setTyping.md b/old_docs/API_docs_v66/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v66/methods/messages_setTyping.md +++ b/old_docs/API_docs_v66/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v66/methods/messages_startBot.md b/old_docs/API_docs_v66/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v66/methods/messages_startBot.md +++ b/old_docs/API_docs_v66/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v66/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v66/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v66/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v66/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v66/methods/messages_toggleDialogPin.md index 14332533..6c57ce0a 100644 --- a/old_docs/API_docs_v66/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v66/methods/messages_toggleDialogPin.md @@ -12,7 +12,7 @@ Pin or unpin dialog | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| @@ -21,13 +21,6 @@ Pin or unpin dialog ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.toggleDialogPin({pinned=Bool, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v66/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v66/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v66/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v66/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v66/methods/payments_clearSavedInfo.md index 8b83266f..117db209 100644 --- a/old_docs/API_docs_v66/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v66/methods/payments_clearSavedInfo.md @@ -12,8 +12,8 @@ Clear saved payments info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| +|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/payments_getPaymentForm.md b/old_docs/API_docs_v66/methods/payments_getPaymentForm.md index 3bdb9ff2..f68aa039 100644 --- a/old_docs/API_docs_v66/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v66/methods/payments_getPaymentForm.md @@ -12,7 +12,7 @@ Get payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|msg\_id|[int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) @@ -20,13 +20,6 @@ Get payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentForm = payments.getPaymentForm({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v66/methods/payments_getPaymentReceipt.md index a881aeb7..13073925 100644 --- a/old_docs/API_docs_v66/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v66/methods/payments_getPaymentReceipt.md @@ -12,7 +12,7 @@ Get payment receipt | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|msg\_id|[int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) @@ -20,13 +20,6 @@ Get payment receipt ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentReceipt = payments.getPaymentReceipt({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v66/methods/payments_sendPaymentForm.md index 79758b56..678b749b 100644 --- a/old_docs/API_docs_v66/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v66/methods/payments_sendPaymentForm.md @@ -12,10 +12,10 @@ Bots only: send payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +|msg\_id|[int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) @@ -23,13 +23,6 @@ Bots only: send payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: payments_PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v66/methods/payments_validateRequestedInfo.md index d473f97c..df6a9ba9 100644 --- a/old_docs/API_docs_v66/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v66/methods/payments_validateRequestedInfo.md @@ -12,9 +12,9 @@ Validate requested payment info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +|save|[Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) @@ -22,13 +22,6 @@ Validate requested payment info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: payments_ValidatedRequestedInfo = payments.validateRequestedInfo({save=Bool, msg_id=int, info=PaymentRequestedInfo, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v66/methods/phone_receivedCall.md b/old_docs/API_docs_v66/methods/phone_receivedCall.md index 17095622..6141a0ab 100644 --- a/old_docs/API_docs_v66/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v66/methods/phone_receivedCall.md @@ -12,7 +12,7 @@ Notify server that you received a call (server will refuse all incoming calls un | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| ### Return type: [Bool](../types/Bool.md) @@ -20,14 +20,6 @@ Notify server that you received a call (server will refuse all incoming calls un ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_ALREADY_DECLINED|The call was already declined| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = phone.receivedCall({peer=InputPhoneCall, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_ALREADY_DECLINED|The call was already declined| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v66/methods/phone_saveCallDebug.md b/old_docs/API_docs_v66/methods/phone_saveCallDebug.md index 0ff049a8..9f3daa18 100644 --- a/old_docs/API_docs_v66/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v66/methods/phone_saveCallDebug.md @@ -12,8 +12,8 @@ Save call debugging info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Debugging info| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| +|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Save call debugging info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| -|DATA_JSON_INVALID|The provided JSON data is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = phone.saveCallDebug({peer=InputPhoneCall, debug=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| +|DATA_JSON_INVALID|The provided JSON data is invalid| + + diff --git a/old_docs/API_docs_v66/methods/phone_setCallRating.md b/old_docs/API_docs_v66/methods/phone_setCallRating.md index d0aab7e0..d9833492 100644 --- a/old_docs/API_docs_v66/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v66/methods/phone_setCallRating.md @@ -12,9 +12,9 @@ Set phone call rating | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[CLICK ME int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[CLICK ME string](../types/string.md) | Yes|An optional comment| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| +|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| +|comment|[string](../types/string.md) | Yes|An optional comment| ### Return type: [Updates](../types/Updates.md) @@ -22,13 +22,6 @@ Set phone call rating ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Updates = phone.setCallRating({peer=InputPhoneCall, rating=int, comment='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v66/methods/photos_getUserPhotos.md b/old_docs/API_docs_v66/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v66/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v66/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v66/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v66/methods/photos_uploadProfilePhoto.md index c7ec3063..0c994ffe 100644 --- a/old_docs/API_docs_v66/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v66/methods/photos_uploadProfilePhoto.md @@ -20,16 +20,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -66,3 +56,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v66/methods/ping.md b/old_docs/API_docs_v66/methods/ping.md index f987ae89..daf1cc65 100644 --- a/old_docs/API_docs_v66/methods/ping.md +++ b/old_docs/API_docs_v66/methods/ping.md @@ -12,7 +12,7 @@ pings the server | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v66/methods/ping_delay_disconnect.md b/old_docs/API_docs_v66/methods/ping_delay_disconnect.md index 5b1c115d..66cc3704 100644 --- a/old_docs/API_docs_v66/methods/ping_delay_disconnect.md +++ b/old_docs/API_docs_v66/methods/ping_delay_disconnect.md @@ -12,8 +12,8 @@ Pings the server and causes disconection if the same method is not called within | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[CLICK ME int](../types/int.md) | Yes|Disconection delay| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| +|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v66/methods/req_DH_params.md b/old_docs/API_docs_v66/methods/req_DH_params.md index f0b45851..a426c699 100644 --- a/old_docs/API_docs_v66/methods/req_DH_params.md +++ b/old_docs/API_docs_v66/methods/req_DH_params.md @@ -12,12 +12,12 @@ Requests Diffie-hellman parameters for key exchange | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[CLICK ME string](../types/string.md) | Yes|factorized p from pq| -|q|[CLICK ME string](../types/string.md) | Yes|factorized q from pq| -|public\_key\_fingerprint|[CLICK ME long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[CLICK ME string](../types/string.md) | Yes|Encrypted message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|p|[string](../types/string.md) | Yes|factorized p from pq| +|q|[string](../types/string.md) | Yes|factorized q from pq| +|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| +|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/old_docs/API_docs_v66/methods/req_pq.md b/old_docs/API_docs_v66/methods/req_pq.md index 0873d9a2..d273a0b9 100644 --- a/old_docs/API_docs_v66/methods/req_pq.md +++ b/old_docs/API_docs_v66/methods/req_pq.md @@ -12,7 +12,7 @@ Requests PQ for factorization | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/old_docs/API_docs_v66/methods/rpc_drop_answer.md b/old_docs/API_docs_v66/methods/rpc_drop_answer.md index 27f98bca..34b355f3 100644 --- a/old_docs/API_docs_v66/methods/rpc_drop_answer.md +++ b/old_docs/API_docs_v66/methods/rpc_drop_answer.md @@ -12,7 +12,7 @@ Do not send answer to provided request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|req\_msg\_id|[CLICK ME long](../types/long.md) | Yes|The message ID of the request| +|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/old_docs/API_docs_v66/methods/set_client_DH_params.md b/old_docs/API_docs_v66/methods/set_client_DH_params.md index cf8ab321..5a173688 100644 --- a/old_docs/API_docs_v66/methods/set_client_DH_params.md +++ b/old_docs/API_docs_v66/methods/set_client_DH_params.md @@ -12,9 +12,9 @@ Sets client diffie-hellman parameters | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[CLICK ME string](../types/string.md) | Yes|Encrypted message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/old_docs/API_docs_v66/methods/upload_getWebFile.md b/old_docs/API_docs_v66/methods/upload_getWebFile.md index 11634633..f869519a 100644 --- a/old_docs/API_docs_v66/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v66/methods/upload_getWebFile.md @@ -12,9 +12,9 @@ Download a file through telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[int](../types/int.md) | Yes|The offset in bytes| +|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) @@ -22,13 +22,6 @@ Download a file through telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LOCATION_INVALID|The provided location is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: upload_WebFile = upload.getWebFile({location=InputWebFileLocation, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LOCATION_INVALID|The provided location is invalid| + + diff --git a/old_docs/API_docs_v66/methods/users_getUsers.md b/old_docs/API_docs_v66/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v66/methods/users_getUsers.md +++ b/old_docs/API_docs_v66/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/account_changePhone.md b/old_docs/API_docs_v68/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v68/methods/account_changePhone.md +++ b/old_docs/API_docs_v68/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_checkUsername.md b/old_docs/API_docs_v68/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v68/methods/account_checkUsername.md +++ b/old_docs/API_docs_v68/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v68/methods/account_confirmPhone.md b/old_docs/API_docs_v68/methods/account_confirmPhone.md index 68490f35..7ffabc24 100644 --- a/old_docs/API_docs_v68/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v68/methods/account_confirmPhone.md @@ -12,8 +12,8 @@ Confirm this phone number is associated to this account, obtain phone_code_hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| +|phone\_code\_hash|[string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Confirm this phone number is associated to this account, obtain phone_code_hash ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_HASH_INVALID|Code hash invalid| -|PHONE_CODE_EMPTY|phone_code is missing| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_HASH_INVALID|Code hash invalid| +|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/old_docs/API_docs_v68/methods/account_deleteAccount.md b/old_docs/API_docs_v68/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v68/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v68/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/account_getNotifySettings.md b/old_docs/API_docs_v68/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v68/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v68/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_getPasswordSettings.md b/old_docs/API_docs_v68/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v68/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v68/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_getPrivacy.md b/old_docs/API_docs_v68/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v68/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v68/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_getTmpPassword.md b/old_docs/API_docs_v68/methods/account_getTmpPassword.md index 01b1ebfc..c82ff37a 100644 --- a/old_docs/API_docs_v68/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v68/methods/account_getTmpPassword.md @@ -12,8 +12,8 @@ Get temporary password for buying products through bots | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|The password hash| -|period|[CLICK ME int](../types/int.md) | Yes|The validity period| +|password\_hash|[bytes](../types/bytes.md) | Yes|The password hash| +|period|[int](../types/int.md) | Yes|The validity period| ### Return type: [account\_TmpPassword](../types/account_TmpPassword.md) @@ -21,14 +21,6 @@ Get temporary password for buying products through bots ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| -|TMP_PASSWORD_DISABLED|The temporary password is disabled| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: account_TmpPassword = account.getTmpPassword({password_hash='bytes', period=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|TMP_PASSWORD_DISABLED|The temporary password is disabled| + + diff --git a/old_docs/API_docs_v68/methods/account_registerDevice.md b/old_docs/API_docs_v68/methods/account_registerDevice.md index 4e148a7f..cbac71d3 100644 --- a/old_docs/API_docs_v68/methods/account_registerDevice.md +++ b/old_docs/API_docs_v68/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_reportPeer.md b/old_docs/API_docs_v68/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v68/methods/account_reportPeer.md +++ b/old_docs/API_docs_v68/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_resetAuthorization.md b/old_docs/API_docs_v68/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v68/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v68/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v68/methods/account_sendChangePhoneCode.md index bdf7331f..476b6d79 100644 --- a/old_docs/API_docs_v68/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v68/methods/account_sendChangePhoneCode.md @@ -12,9 +12,9 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|Current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v68/methods/account_sendConfirmPhoneCode.md index 86035d19..8917355f 100644 --- a/old_docs/API_docs_v68/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v68/methods/account_sendConfirmPhoneCode.md @@ -12,9 +12,9 @@ Send confirmation phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| -|hash|[CLICK ME string](../types/string.md) | Yes|The hash| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|The current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| +|hash|[string](../types/string.md) | Yes|The hash| +|current\_number|[Bool](../types/Bool.md) | Optional|The current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Send confirmation phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendConfirmPhoneCode({allow_flashcall=Bool, hash='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_setAccountTTL.md b/old_docs/API_docs_v68/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v68/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v68/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_setPrivacy.md b/old_docs/API_docs_v68/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v68/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v68/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_unregisterDevice.md b/old_docs/API_docs_v68/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v68/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v68/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v68/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v68/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v68/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/account_updateNotifySettings.md b/old_docs/API_docs_v68/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v68/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v68/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v68/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v68/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v68/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_updateProfile.md b/old_docs/API_docs_v68/methods/account_updateProfile.md index 59629188..ef19dc00 100644 --- a/old_docs/API_docs_v68/methods/account_updateProfile.md +++ b/old_docs/API_docs_v68/methods/account_updateProfile.md @@ -12,9 +12,9 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Optional|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Optional|The last name| -|about|[CLICK ME string](../types/string.md) | Optional|The bio/about field| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| ### Return type: [User](../types/User.md) @@ -22,14 +22,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v68/methods/account_updateStatus.md b/old_docs/API_docs_v68/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v68/methods/account_updateStatus.md +++ b/old_docs/API_docs_v68/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v68/methods/account_updateUsername.md b/old_docs/API_docs_v68/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v68/methods/account_updateUsername.md +++ b/old_docs/API_docs_v68/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v68/methods/auth_cancelCode.md b/old_docs/API_docs_v68/methods/auth_cancelCode.md index 52b85d4c..84401c62 100644 --- a/old_docs/API_docs_v68/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v68/methods/auth_cancelCode.md @@ -12,8 +12,8 @@ Invalidate sent phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invalidate sent phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v68/methods/auth_checkPhone.md b/old_docs/API_docs_v68/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v68/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v68/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v68/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v68/methods/auth_dropTempAuthKeys.md index 5aa98b3b..537afbc1 100644 --- a/old_docs/API_docs_v68/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v68/methods/auth_dropTempAuthKeys.md @@ -12,7 +12,7 @@ Delete all temporary authorization keys except the ones provided | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_auth\_keys|Array of [CLICK ME long](../types/long.md) | Yes|The temporary authorization keys to keep| +|except\_auth\_keys|Array of [long](../types/long.md) | Yes|The temporary authorization keys to keep| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/auth_recoverPassword.md b/old_docs/API_docs_v68/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v68/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v68/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v68/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v68/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v68/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v68/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v68/methods/auth_resendCode.md b/old_docs/API_docs_v68/methods/auth_resendCode.md index 253480a3..4402bfe6 100644 --- a/old_docs/API_docs_v68/methods/auth_resendCode.md +++ b/old_docs/API_docs_v68/methods/auth_resendCode.md @@ -12,8 +12,8 @@ Resend the SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -21,13 +21,6 @@ Resend the SMS verification code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v68/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v68/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v68/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v68/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/auth_sendInvites.md b/old_docs/API_docs_v68/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v68/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v68/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v68/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v68/methods/bots_answerWebhookJSONQuery.md index 40cb0477..3dbf62ef 100644 --- a/old_docs/API_docs_v68/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v68/methods/bots_answerWebhookJSONQuery.md @@ -12,8 +12,8 @@ Send webhook request via bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|data|[DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Send webhook request via bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Bool = bots.answerWebhookJSONQuery({query_id=long, data=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v68/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v68/methods/bots_sendCustomRequest.md index 5a7f4e86..cb7c32e2 100644 --- a/old_docs/API_docs_v68/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v68/methods/bots_sendCustomRequest.md @@ -12,8 +12,8 @@ Send a custom request to the bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| +|custom\_method|[string](../types/string.md) | Yes|The method to call| +|params|[DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) @@ -21,13 +21,6 @@ Send a custom request to the bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: DataJSON = bots.sendCustomRequest({custom_method='string', params=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v68/methods/channels_checkUsername.md b/old_docs/API_docs_v68/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v68/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v68/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v68/methods/channels_createChannel.md b/old_docs/API_docs_v68/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v68/methods/channels_createChannel.md +++ b/old_docs/API_docs_v68/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v68/methods/channels_deleteChannel.md b/old_docs/API_docs_v68/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v68/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v68/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v68/methods/channels_deleteMessages.md b/old_docs/API_docs_v68/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v68/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v68/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v68/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v68/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v68/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v68/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v68/methods/channels_editAbout.md b/old_docs/API_docs_v68/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v68/methods/channels_editAbout.md +++ b/old_docs/API_docs_v68/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v68/methods/channels_editAdmin.md b/old_docs/API_docs_v68/methods/channels_editAdmin.md index 7cecbd64..f08473eb 100644 --- a/old_docs/API_docs_v68/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v68/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| +|admin\_rights|[ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, admin_rights=ChannelAdminRights, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v68/methods/channels_editBanned.md b/old_docs/API_docs_v68/methods/channels_editBanned.md index ca9f2596..03dc70a5 100644 --- a/old_docs/API_docs_v68/methods/channels_editBanned.md +++ b/old_docs/API_docs_v68/methods/channels_editBanned.md @@ -14,7 +14,7 @@ Kick or ban a user from a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban| -|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| +|banned\_rights|[ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| ### Return type: [Updates](../types/Updates.md) @@ -22,17 +22,6 @@ Kick or ban a user from a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ADMIN_INVALID|You're not an admin| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +71,14 @@ Or, if you're into Lua: Updates = channels.editBanned({channel=InputChannel, user_id=InputUser, banned_rights=ChannelBannedRights, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ADMIN_INVALID|You're not an admin| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v68/methods/channels_editPhoto.md b/old_docs/API_docs_v68/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v68/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v68/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v68/methods/channels_editTitle.md b/old_docs/API_docs_v68/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v68/methods/channels_editTitle.md +++ b/old_docs/API_docs_v68/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v68/methods/channels_exportInvite.md b/old_docs/API_docs_v68/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v68/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v68/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v68/methods/channels_exportMessageLink.md b/old_docs/API_docs_v68/methods/channels_exportMessageLink.md index b4a3c645..20f6e998 100644 --- a/old_docs/API_docs_v68/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v68/methods/channels_exportMessageLink.md @@ -13,7 +13,7 @@ Get the link of a message in a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| +|id|[int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -21,13 +21,6 @@ Get the link of a message in a channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v68/methods/channels_getAdminLog.md b/old_docs/API_docs_v68/methods/channels_getAdminLog.md index 4a419778..1ffcf5c3 100644 --- a/old_docs/API_docs_v68/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v68/methods/channels_getAdminLog.md @@ -13,12 +13,12 @@ Get admin log of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|q|[CLICK ME string](../types/string.md) | Yes|Search query| -|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| +|q|[string](../types/string.md) | Yes|Search query| +|events\_filter|[ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| |admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME long](../types/long.md) | Yes|Minimum message ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[long](../types/long.md) | Yes|Maximum message ID to fetch| +|min\_id|[long](../types/long.md) | Yes|Minimum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) @@ -26,15 +26,6 @@ Get admin log of a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -83,3 +74,12 @@ Or, if you're into Lua: channels_AdminLogResults = channels.getAdminLog({channel=InputChannel, q='string', events_filter=ChannelAdminLogEventsFilter, admins={InputUser}, max_id=long, min_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v68/methods/channels_getChannels.md b/old_docs/API_docs_v68/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v68/methods/channels_getChannels.md +++ b/old_docs/API_docs_v68/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v68/methods/channels_getMessages.md b/old_docs/API_docs_v68/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v68/methods/channels_getMessages.md +++ b/old_docs/API_docs_v68/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v68/methods/channels_getParticipant.md b/old_docs/API_docs_v68/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v68/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v68/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v68/methods/channels_getParticipants.md b/old_docs/API_docs_v68/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v68/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v68/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/channels_inviteToChannel.md b/old_docs/API_docs_v68/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v68/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v68/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v68/methods/channels_joinChannel.md b/old_docs/API_docs_v68/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v68/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v68/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v68/methods/channels_leaveChannel.md b/old_docs/API_docs_v68/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v68/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v68/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v68/methods/channels_readHistory.md b/old_docs/API_docs_v68/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v68/methods/channels_readHistory.md +++ b/old_docs/API_docs_v68/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v68/methods/channels_reportSpam.md b/old_docs/API_docs_v68/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v68/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v68/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v68/methods/channels_toggleInvites.md b/old_docs/API_docs_v68/methods/channels_toggleInvites.md index e9e6450d..d437682f 100644 --- a/old_docs/API_docs_v68/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v68/methods/channels_toggleInvites.md @@ -13,7 +13,7 @@ Allow or disallow any user to invite users to this channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Allow or disallow any user to invite users to this channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v68/methods/channels_toggleSignatures.md b/old_docs/API_docs_v68/methods/channels_toggleSignatures.md index 36d1eccb..d40bf67b 100644 --- a/old_docs/API_docs_v68/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v68/methods/channels_toggleSignatures.md @@ -13,7 +13,7 @@ Toggle channel signatures | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Toggle channel signatures ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v68/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v68/methods/channels_updatePinnedMessage.md index f8d10ece..aa2cc783 100644 --- a/old_docs/API_docs_v68/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v68/methods/channels_updatePinnedMessage.md @@ -12,9 +12,9 @@ Set the pinned message of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Set the pinned message of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -81,3 +71,13 @@ Or, if you're into Lua: Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v68/methods/channels_updateUsername.md b/old_docs/API_docs_v68/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v68/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v68/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v68/methods/contacts_block.md b/old_docs/API_docs_v68/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v68/methods/contacts_block.md +++ b/old_docs/API_docs_v68/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v68/methods/contacts_deleteContact.md b/old_docs/API_docs_v68/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v68/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v68/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v68/methods/contacts_deleteContacts.md b/old_docs/API_docs_v68/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v68/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v68/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/contacts_getBlocked.md b/old_docs/API_docs_v68/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v68/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v68/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v68/methods/contacts_getContacts.md b/old_docs/API_docs_v68/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v68/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v68/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v68/methods/contacts_getTopPeers.md b/old_docs/API_docs_v68/methods/contacts_getTopPeers.md index 4958e6b2..a8cd4c57 100644 --- a/old_docs/API_docs_v68/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v68/methods/contacts_getTopPeers.md @@ -12,15 +12,15 @@ Get most used chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|correspondents|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch users?| -|bots\_pm|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch bots?| -|bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| -|phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?| -|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| -|channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| +|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?| +|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?| +|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?| +|phone\_calls|[Bool](../types/Bool.md) | Optional|Fetch phone calls?| +|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?| +|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| +|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|limit|[int](../types/int.md) | Yes|How many results to fetch| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| ### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) @@ -28,13 +28,6 @@ Get most used chats ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TYPES_EMPTY|The types field is empty| - - ### MadelineProto Example: @@ -87,3 +80,10 @@ Or, if you're into Lua: contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, phone_calls=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field is empty| + + diff --git a/old_docs/API_docs_v68/methods/contacts_importCard.md b/old_docs/API_docs_v68/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v68/methods/contacts_importCard.md +++ b/old_docs/API_docs_v68/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v68/methods/contacts_importContacts.md b/old_docs/API_docs_v68/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v68/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v68/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v68/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v68/methods/contacts_resetTopPeerRating.md index 4b5e96f1..15b07f96 100644 --- a/old_docs/API_docs_v68/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v68/methods/contacts_resetTopPeerRating.md @@ -12,7 +12,7 @@ Reset top peer rating for a certain category/peer | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| @@ -21,13 +21,6 @@ Reset top peer rating for a certain category/peer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/contacts_search.md b/old_docs/API_docs_v68/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v68/methods/contacts_search.md +++ b/old_docs/API_docs_v68/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/contacts_unblock.md b/old_docs/API_docs_v68/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v68/methods/contacts_unblock.md +++ b/old_docs/API_docs_v68/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v68/methods/contest_saveDeveloperInfo.md b/old_docs/API_docs_v68/methods/contest_saveDeveloperInfo.md index 5d82a4be..de23c472 100644 --- a/old_docs/API_docs_v68/methods/contest_saveDeveloperInfo.md +++ b/old_docs/API_docs_v68/methods/contest_saveDeveloperInfo.md @@ -12,11 +12,11 @@ Save developer info for telegram contest | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|vk\_id|[CLICK ME int](../types/int.md) | Yes|VK user ID| -|name|[CLICK ME string](../types/string.md) | Yes|Name| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|age|[CLICK ME int](../types/int.md) | Yes|Age| -|city|[CLICK ME string](../types/string.md) | Yes|City| +|vk\_id|[int](../types/int.md) | Yes|VK user ID| +|name|[string](../types/string.md) | Yes|Name| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|age|[int](../types/int.md) | Yes|Age| +|city|[string](../types/string.md) | Yes|City| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/destroy_session.md b/old_docs/API_docs_v68/methods/destroy_session.md index b74fbd11..c4187ce0 100644 --- a/old_docs/API_docs_v68/methods/destroy_session.md +++ b/old_docs/API_docs_v68/methods/destroy_session.md @@ -12,7 +12,7 @@ Destroy the current MTProto session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|session\_id|[CLICK ME long](../types/long.md) | Yes|The session to destroy| +|session\_id|[long](../types/long.md) | Yes|The session to destroy| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/old_docs/API_docs_v68/methods/get_future_salts.md b/old_docs/API_docs_v68/methods/get_future_salts.md index e8451015..7f5fc18c 100644 --- a/old_docs/API_docs_v68/methods/get_future_salts.md +++ b/old_docs/API_docs_v68/methods/get_future_salts.md @@ -12,7 +12,7 @@ Get future salts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|num|[CLICK ME int](../types/int.md) | Yes|How many salts should be fetched| +|num|[int](../types/int.md) | Yes|How many salts should be fetched| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/old_docs/API_docs_v68/methods/help_getAppChangelog.md b/old_docs/API_docs_v68/methods/help_getAppChangelog.md index eda473a6..183ebb8c 100644 --- a/old_docs/API_docs_v68/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v68/methods/help_getAppChangelog.md @@ -12,7 +12,7 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| +|prev\_app\_version|[string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/help_getCdnConfig.md b/old_docs/API_docs_v68/methods/help_getCdnConfig.md index b98949ed..b7af5bb4 100644 --- a/old_docs/API_docs_v68/methods/help_getCdnConfig.md +++ b/old_docs/API_docs_v68/methods/help_getCdnConfig.md @@ -15,13 +15,6 @@ Get CDN configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: CdnConfig = help.getCdnConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/help_getConfig.md b/old_docs/API_docs_v68/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v68/methods/help_getConfig.md +++ b/old_docs/API_docs_v68/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/help_saveAppLog.md b/old_docs/API_docs_v68/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v68/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v68/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v68/methods/help_setBotUpdatesStatus.md index a1a3ab1b..1766ee14 100644 --- a/old_docs/API_docs_v68/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v68/methods/help_setBotUpdatesStatus.md @@ -12,8 +12,8 @@ Set the update status of webhook | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| -|message|[CLICK ME string](../types/string.md) | Yes|Message| +|pending\_updates\_count|[int](../types/int.md) | Yes|Pending update count| +|message|[string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/initConnection.md b/old_docs/API_docs_v68/methods/initConnection.md index c66aa8b1..2d195613 100644 --- a/old_docs/API_docs_v68/methods/initConnection.md +++ b/old_docs/API_docs_v68/methods/initConnection.md @@ -12,14 +12,14 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|system\_lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| -|lang\_pack|[CLICK ME string](../types/string.md) | Yes|Language pack to use| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|system\_lang\_code|[string](../types/string.md) | Yes|Language code| +|lang\_pack|[string](../types/string.md) | Yes|Language pack to use| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -27,14 +27,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -94,3 +86,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', system_lang_code='string', lang_pack='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v68/methods/invokeAfterMsg.md b/old_docs/API_docs_v68/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v68/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v68/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v68/methods/invokeAfterMsgs.md b/old_docs/API_docs_v68/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v68/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v68/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v68/methods/invokeWithLayer.md b/old_docs/API_docs_v68/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v68/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v68/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v68/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v68/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v68/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v68/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v68/methods/langpack_getDifference.md b/old_docs/API_docs_v68/methods/langpack_getDifference.md index 0a6512e4..1860cc49 100644 --- a/old_docs/API_docs_v68/methods/langpack_getDifference.md +++ b/old_docs/API_docs_v68/methods/langpack_getDifference.md @@ -12,7 +12,7 @@ Get language pack updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|from\_version|[CLICK ME int](../types/int.md) | Yes|Previous version| +|from\_version|[int](../types/int.md) | Yes|Previous version| ### Return type: [LangPackDifference](../types/LangPackDifference.md) @@ -20,13 +20,6 @@ Get language pack updates ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: LangPackDifference = langpack.getDifference({from_version=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v68/methods/langpack_getLangPack.md b/old_docs/API_docs_v68/methods/langpack_getLangPack.md index 45a9ca47..7e64aec9 100644 --- a/old_docs/API_docs_v68/methods/langpack_getLangPack.md +++ b/old_docs/API_docs_v68/methods/langpack_getLangPack.md @@ -12,7 +12,7 @@ Get language pack | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [LangPackDifference](../types/LangPackDifference.md) @@ -20,13 +20,6 @@ Get language pack ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: LangPackDifference = langpack.getLangPack({lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v68/methods/langpack_getLanguages.md b/old_docs/API_docs_v68/methods/langpack_getLanguages.md index b573a5eb..c4ea44ca 100644 --- a/old_docs/API_docs_v68/methods/langpack_getLanguages.md +++ b/old_docs/API_docs_v68/methods/langpack_getLanguages.md @@ -15,13 +15,6 @@ Get available languages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Vector_of_LangPackLanguage = langpack.getLanguages({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v68/methods/langpack_getStrings.md b/old_docs/API_docs_v68/methods/langpack_getStrings.md index 841b02db..4953e1c0 100644 --- a/old_docs/API_docs_v68/methods/langpack_getStrings.md +++ b/old_docs/API_docs_v68/methods/langpack_getStrings.md @@ -12,8 +12,8 @@ Get language pack strings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| -|keys|Array of [CLICK ME string](../types/string.md) | Yes|Keys| +|lang\_code|[string](../types/string.md) | Yes|Language code| +|keys|Array of [string](../types/string.md) | Yes|Keys| ### Return type: [Vector\_of\_LangPackString](../types/LangPackString.md) @@ -21,13 +21,6 @@ Get language pack strings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Vector_of_LangPackString = langpack.getStrings({lang_code='string', keys={'string'}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_addChatUser.md b/old_docs/API_docs_v68/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v68/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v68/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v68/methods/messages_checkChatInvite.md b/old_docs/API_docs_v68/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v68/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v68/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v68/methods/messages_clearRecentStickers.md index 1d6ec8c9..72c4844b 100644 --- a/old_docs/API_docs_v68/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v68/methods/messages_clearRecentStickers.md @@ -12,7 +12,7 @@ Clear all recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_createChat.md b/old_docs/API_docs_v68/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v68/methods/messages_createChat.md +++ b/old_docs/API_docs_v68/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v68/methods/messages_deleteChatUser.md b/old_docs/API_docs_v68/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v68/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v68/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v68/methods/messages_deleteHistory.md b/old_docs/API_docs_v68/methods/messages_deleteHistory.md index 45e9890d..601d1876 100644 --- a/old_docs/API_docs_v68/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v68/methods/messages_deleteHistory.md @@ -12,9 +12,9 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|just\_clear|[CLICK ME Bool](../types/Bool.md) | Optional|Only clear it from your side| +|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,13 +22,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_deleteMessages.md b/old_docs/API_docs_v68/methods/messages_deleteMessages.md index c8670444..900e9d0e 100644 --- a/old_docs/API_docs_v68/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v68/methods/messages_deleteMessages.md @@ -12,8 +12,8 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|revoke|[CLICK ME Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,13 +21,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({revoke=Bool, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v68/methods/messages_editChatAdmin.md b/old_docs/API_docs_v68/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v68/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v68/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_editChatPhoto.md b/old_docs/API_docs_v68/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v68/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v68/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_editChatTitle.md b/old_docs/API_docs_v68/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v68/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v68/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v68/methods/messages_editInlineBotMessage.md index 73c8a2c4..4729b52a 100644 --- a/old_docs/API_docs_v68/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v68/methods/messages_editInlineBotMessage.md @@ -12,11 +12,11 @@ Edit a sent inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,14 +25,6 @@ Edit a sent inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| - - ### MadelineProto Example: @@ -120,3 +112,11 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v68/methods/messages_editMessage.md b/old_docs/API_docs_v68/methods/messages_editMessage.md index ad639325..4380aba6 100644 --- a/old_docs/API_docs_v68/methods/messages_editMessage.md +++ b/old_docs/API_docs_v68/methods/messages_editMessage.md @@ -12,12 +12,12 @@ Edit a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -26,22 +26,6 @@ Edit a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -129,3 +113,19 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v68/methods/messages_exportChatInvite.md b/old_docs/API_docs_v68/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v68/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v68/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_forwardMessage.md b/old_docs/API_docs_v68/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v68/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v68/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v68/methods/messages_forwardMessages.md b/old_docs/API_docs_v68/methods/messages_forwardMessages.md index b99e1d31..2a0455e4 100644 --- a/old_docs/API_docs_v68/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v68/methods/messages_forwardMessages.md @@ -12,11 +12,11 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[CLICK ME Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| +|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -25,34 +25,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -108,3 +80,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/messages_getAllChats.md b/old_docs/API_docs_v68/methods/messages_getAllChats.md index 513fc06f..c4851369 100644 --- a/old_docs/API_docs_v68/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v68/methods/messages_getAllChats.md @@ -12,7 +12,7 @@ Get all chats (not supergroups or channels) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v68/methods/messages_getAllStickers.md b/old_docs/API_docs_v68/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v68/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v68/methods/messages_getArchivedStickers.md index ee36b542..dfd5c006 100644 --- a/old_docs/API_docs_v68/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getArchivedStickers.md @@ -12,9 +12,9 @@ Get all archived stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| +|masks|[Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| +|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v68/methods/messages_getAttachedStickers.md index 9f8a66c5..8f51f38d 100644 --- a/old_docs/API_docs_v68/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getAttachedStickers.md @@ -12,7 +12,7 @@ Get stickers attachable to images | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v68/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v68/methods/messages_getBotCallbackAnswer.md index 0136227f..4b8887ad 100644 --- a/old_docs/API_docs_v68/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v68/methods/messages_getBotCallbackAnswer.md @@ -12,10 +12,10 @@ Get the callback answer of a bot (after clicking a button) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|game|[Bool](../types/Bool.md) | Optional|Is this a game?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) @@ -23,17 +23,6 @@ Get the callback answer of a bot (after clicking a button) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|DATA_INVALID|Encrypted data invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: messages_BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/messages_getChats.md b/old_docs/API_docs_v68/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v68/methods/messages_getChats.md +++ b/old_docs/API_docs_v68/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_getCommonChats.md b/old_docs/API_docs_v68/methods/messages_getCommonChats.md index 15ed6713..6ffa0948 100644 --- a/old_docs/API_docs_v68/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v68/methods/messages_getCommonChats.md @@ -13,8 +13,8 @@ Get chats in common with a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -22,13 +22,6 @@ Get chats in common with a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_Chats = messages.getCommonChats({user_id=InputUser, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_getDialogs.md b/old_docs/API_docs_v68/methods/messages_getDialogs.md index 53f9ac62..1035e8ce 100644 --- a/old_docs/API_docs_v68/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v68/methods/messages_getDialogs.md @@ -12,11 +12,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|exclude\_pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -24,16 +24,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v68/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v68/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v68/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v68/methods/messages_getFeaturedStickers.md index 8e49e1ef..af7f69a0 100644 --- a/old_docs/API_docs_v68/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getFeaturedStickers.md @@ -12,7 +12,7 @@ Get featured stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getGameHighScores.md b/old_docs/API_docs_v68/methods/messages_getGameHighScores.md index 113e4647..af3f3915 100644 --- a/old_docs/API_docs_v68/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v68/methods/messages_getGameHighScores.md @@ -13,7 +13,7 @@ Get high scores of a game | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -22,14 +22,6 @@ Get high scores of a game ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -79,3 +71,11 @@ Or, if you're into Lua: messages_HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v68/methods/messages_getHistory.md b/old_docs/API_docs_v68/methods/messages_getHistory.md index 851d2680..86a744cf 100644 --- a/old_docs/API_docs_v68/methods/messages_getHistory.md +++ b/old_docs/API_docs_v68/methods/messages_getHistory.md @@ -13,12 +13,12 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -26,18 +26,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v68/methods/messages_getInlineBotResults.md index 4d86caf5..207624a7 100644 --- a/old_docs/API_docs_v68/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v68/methods/messages_getInlineBotResults.md @@ -14,9 +14,9 @@ Call inline bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -24,16 +24,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v68/methods/messages_getInlineGameHighScores.md index d5a80005..e03bc273 100644 --- a/old_docs/API_docs_v68/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v68/methods/messages_getInlineGameHighScores.md @@ -12,7 +12,7 @@ Get high scores of a game sent in an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -21,14 +21,6 @@ Get high scores of a game sent in an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v68/methods/messages_getMaskStickers.md b/old_docs/API_docs_v68/methods/messages_getMaskStickers.md index 70e2e6d4..1fbd9346 100644 --- a/old_docs/API_docs_v68/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getMaskStickers.md @@ -12,7 +12,7 @@ Get masks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getMessageEditData.md b/old_docs/API_docs_v68/methods/messages_getMessageEditData.md index 34f8534f..00c63d28 100644 --- a/old_docs/API_docs_v68/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v68/methods/messages_getMessageEditData.md @@ -13,7 +13,7 @@ Check if about to edit a message or a media caption | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) @@ -21,14 +21,6 @@ Check if about to edit a message or a media caption ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v68/methods/messages_getMessages.md b/old_docs/API_docs_v68/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v68/methods/messages_getMessages.md +++ b/old_docs/API_docs_v68/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v68/methods/messages_getMessagesViews.md b/old_docs/API_docs_v68/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v68/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v68/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v68/methods/messages_getPeerDialogs.md index 063b6e7d..000e8eb6 100644 --- a/old_docs/API_docs_v68/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v68/methods/messages_getPeerDialogs.md @@ -20,14 +20,6 @@ Get dialog info of peers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: messages_PeerDialogs = messages.getPeerDialogs({peers={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_getPeerSettings.md b/old_docs/API_docs_v68/methods/messages_getPeerSettings.md index a18126f0..5a3e9349 100644 --- a/old_docs/API_docs_v68/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v68/methods/messages_getPeerSettings.md @@ -20,14 +20,6 @@ Get the settings of apeer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: PeerSettings = messages.getPeerSettings({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_getRecentStickers.md b/old_docs/API_docs_v68/methods/messages_getRecentStickers.md index 0c5ae0c6..629a2bda 100644 --- a/old_docs/API_docs_v68/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getRecentStickers.md @@ -12,8 +12,8 @@ Get recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getSavedGifs.md b/old_docs/API_docs_v68/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v68/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v68/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v68/methods/messages_getStickerSet.md b/old_docs/API_docs_v68/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v68/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v68/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_getWebPage.md b/old_docs/API_docs_v68/methods/messages_getWebPage.md index 19ca94b9..1b533ebd 100644 --- a/old_docs/API_docs_v68/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v68/methods/messages_getWebPage.md @@ -12,8 +12,8 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|url|[CLICK ME string](../types/string.md) | Yes|URL| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|url|[string](../types/string.md) | Yes|URL| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) @@ -21,13 +21,6 @@ Get webpage preview ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|WC_CONVERT_URL_INVALID|WC convert URL invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: WebPage = messages.getWebPage({url='string', hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|WC_CONVERT_URL_INVALID|WC convert URL invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v68/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v68/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v68/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v68/methods/messages_hideReportSpam.md b/old_docs/API_docs_v68/methods/messages_hideReportSpam.md index 30523f2a..0bf711ea 100644 --- a/old_docs/API_docs_v68/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v68/methods/messages_hideReportSpam.md @@ -20,13 +20,6 @@ Hide report spam popup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.hideReportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_importChatInvite.md b/old_docs/API_docs_v68/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v68/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v68/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v68/methods/messages_installStickerSet.md b/old_docs/API_docs_v68/methods/messages_installStickerSet.md index 20f90b71..d6caf555 100644 --- a/old_docs/API_docs_v68/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v68/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_migrateChat.md b/old_docs/API_docs_v68/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v68/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v68/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v68/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v68/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v68/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v68/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v68/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v68/methods/messages_readFeaturedStickers.md index 050371da..3b01171b 100644 --- a/old_docs/API_docs_v68/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v68/methods/messages_readFeaturedStickers.md @@ -12,7 +12,7 @@ Mark new featured stickers as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| +|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_readHistory.md b/old_docs/API_docs_v68/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v68/methods/messages_readHistory.md +++ b/old_docs/API_docs_v68/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/messages_readMessageContents.md b/old_docs/API_docs_v68/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v68/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v68/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v68/methods/messages_receivedMessages.md b/old_docs/API_docs_v68/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v68/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v68/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v68/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v68/methods/messages_reorderPinnedDialogs.md index 94d3b2d4..232117e8 100644 --- a/old_docs/API_docs_v68/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v68/methods/messages_reorderPinnedDialogs.md @@ -12,7 +12,7 @@ Reorder pinned dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|force|[Bool](../types/Bool.md) | Optional|Force reordering| |order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| @@ -21,13 +21,6 @@ Reorder pinned dialogs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.reorderPinnedDialogs({force=Bool, order={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v68/methods/messages_reorderStickerSets.md index 66f5e682..6a71da86 100644 --- a/old_docs/API_docs_v68/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v68/methods/messages_reorderStickerSets.md @@ -12,8 +12,8 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v68/methods/messages_reportEncryptedSpam.md index cd03c35c..988e0101 100644 --- a/old_docs/API_docs_v68/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v68/methods/messages_reportEncryptedSpam.md @@ -20,13 +20,6 @@ Report for spam a secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportEncryptedSpam({peer=InputEncryptedChat, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_reportSpam.md b/old_docs/API_docs_v68/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v68/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v68/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_saveDraft.md b/old_docs/API_docs_v68/methods/messages_saveDraft.md index 59b33b03..60d72c1e 100644 --- a/old_docs/API_docs_v68/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v68/methods/messages_saveDraft.md @@ -12,11 +12,11 @@ Save a message draft | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,13 +25,6 @@ Save a message draft ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -104,3 +97,10 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_saveGif.md b/old_docs/API_docs_v68/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v68/methods/messages_saveGif.md +++ b/old_docs/API_docs_v68/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v68/methods/messages_saveRecentSticker.md index 55757080..d2418881 100644 --- a/old_docs/API_docs_v68/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v68/methods/messages_saveRecentSticker.md @@ -12,9 +12,9 @@ Add a sticker to recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Add a sticker to recent stickers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.saveRecentSticker({attached=Bool, id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_search.md b/old_docs/API_docs_v68/methods/messages_search.md index 24e06c09..a3eb7324 100644 --- a/old_docs/API_docs_v68/methods/messages_search.md +++ b/old_docs/API_docs_v68/methods/messages_search.md @@ -13,14 +13,14 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| +|q|[string](../types/string.md) | Yes|What to search| |from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -28,19 +28,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -93,3 +80,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', from_id=InputUser, filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_searchGifs.md b/old_docs/API_docs_v68/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v68/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v68/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v68/methods/messages_searchGlobal.md b/old_docs/API_docs_v68/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v68/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v68/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v68/methods/messages_sendEncrypted.md b/old_docs/API_docs_v68/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v68/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v68/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v68/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v68/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v68/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v68/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v68/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v68/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v68/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v68/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v68/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v68/methods/messages_sendInlineBotResult.md index 758aa97f..d1f9fbd0 100644 --- a/old_docs/API_docs_v68/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v68/methods/messages_sendInlineBotResult.md @@ -12,13 +12,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -26,18 +26,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v68/methods/messages_sendMedia.md b/old_docs/API_docs_v68/methods/messages_sendMedia.md index 770d1b65..94e27b83 100644 --- a/old_docs/API_docs_v68/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v68/methods/messages_sendMedia.md @@ -12,13 +12,13 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -26,34 +26,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -117,3 +89,31 @@ Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, pe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/messages_sendMessage.md b/old_docs/API_docs_v68/methods/messages_sendMessage.md index 83dc6c8b..ba76f230 100644 --- a/old_docs/API_docs_v68/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v68/methods/messages_sendMessage.md @@ -12,15 +12,15 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,33 +29,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -143,3 +116,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v68/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v68/methods/messages_setBotCallbackAnswer.md index e221ccca..34c7bb16 100644 --- a/old_docs/API_docs_v68/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v68/methods/messages_setBotCallbackAnswer.md @@ -12,11 +12,11 @@ Bots only: set the callback answer (after a button was clicked) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|message|[CLICK ME string](../types/string.md) | Optional|The message| -|url|[CLICK ME string](../types/string.md) | Optional|The URL| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| +|url|[string](../types/string.md) | Optional|The URL| +|cache\_time|[int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) @@ -24,13 +24,6 @@ Bots only: set the callback answer (after a button was clicked) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -90,3 +83,10 @@ Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v68/methods/messages_setBotPrecheckoutResults.md index 7e3fc3c2..f631bf0c 100644 --- a/old_docs/API_docs_v68/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v68/methods/messages_setBotPrecheckoutResults.md @@ -12,9 +12,9 @@ Bots only: set precheckout results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| +|success|[Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set precheckout results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ERROR_TEXT_EMPTY|The provided error message is empty| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotPrecheckoutResults({success=Bool, query_id=long, error='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ERROR_TEXT_EMPTY|The provided error message is empty| + + diff --git a/old_docs/API_docs_v68/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v68/methods/messages_setBotShippingResults.md index 3d9f0ae2..915cfebf 100644 --- a/old_docs/API_docs_v68/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v68/methods/messages_setBotShippingResults.md @@ -12,9 +12,9 @@ Bots only: set shipping results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set shipping results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotShippingResults({query_id=long, error='string', shipping_options={ShippingOption}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v68/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v68/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v68/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_setGameScore.md b/old_docs/API_docs_v68/methods/messages_setGameScore.md index 90594a1d..c3d5a2c7 100644 --- a/old_docs/API_docs_v68/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v68/methods/messages_setGameScore.md @@ -12,12 +12,12 @@ Set the game score | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) @@ -25,14 +25,6 @@ Set the game score ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: Updates = messages.setGameScore({edit_message=Bool, force=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v68/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v68/methods/messages_setInlineBotResults.md index d4ba6e65..e46598e2 100644 --- a/old_docs/API_docs_v68/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v68/methods/messages_setInlineBotResults.md @@ -12,13 +12,13 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) @@ -26,23 +26,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -100,3 +83,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v68/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v68/methods/messages_setInlineGameScore.md index 2b7326f3..d33da5ef 100644 --- a/old_docs/API_docs_v68/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v68/methods/messages_setInlineGameScore.md @@ -12,11 +12,11 @@ Set the game score of an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) @@ -24,14 +24,6 @@ Set the game score of an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -85,3 +77,11 @@ Or, if you're into Lua: Bool = messages.setInlineGameScore({edit_message=Bool, force=Bool, id=InputBotInlineMessageID, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v68/methods/messages_setTyping.md b/old_docs/API_docs_v68/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v68/methods/messages_setTyping.md +++ b/old_docs/API_docs_v68/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v68/methods/messages_startBot.md b/old_docs/API_docs_v68/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v68/methods/messages_startBot.md +++ b/old_docs/API_docs_v68/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v68/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v68/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v68/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v68/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v68/methods/messages_toggleDialogPin.md index 14332533..6c57ce0a 100644 --- a/old_docs/API_docs_v68/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v68/methods/messages_toggleDialogPin.md @@ -12,7 +12,7 @@ Pin or unpin dialog | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| @@ -21,13 +21,6 @@ Pin or unpin dialog ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.toggleDialogPin({pinned=Bool, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v68/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v68/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v68/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v68/methods/messages_uploadMedia.md b/old_docs/API_docs_v68/methods/messages_uploadMedia.md index c09da017..4d511a15 100644 --- a/old_docs/API_docs_v68/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v68/methods/messages_uploadMedia.md @@ -21,15 +21,6 @@ Upload a file without sending it to anyone ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|MEDIA_INVALID|Media invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: MessageMedia = messages.uploadMedia({peer=InputPeer, media=InputMedia, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|MEDIA_INVALID|Media invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v68/methods/payments_clearSavedInfo.md index 8b83266f..117db209 100644 --- a/old_docs/API_docs_v68/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v68/methods/payments_clearSavedInfo.md @@ -12,8 +12,8 @@ Clear saved payments info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| +|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/payments_getPaymentForm.md b/old_docs/API_docs_v68/methods/payments_getPaymentForm.md index 3bdb9ff2..f68aa039 100644 --- a/old_docs/API_docs_v68/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v68/methods/payments_getPaymentForm.md @@ -12,7 +12,7 @@ Get payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|msg\_id|[int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) @@ -20,13 +20,6 @@ Get payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentForm = payments.getPaymentForm({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v68/methods/payments_getPaymentReceipt.md index a881aeb7..13073925 100644 --- a/old_docs/API_docs_v68/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v68/methods/payments_getPaymentReceipt.md @@ -12,7 +12,7 @@ Get payment receipt | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|msg\_id|[int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) @@ -20,13 +20,6 @@ Get payment receipt ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentReceipt = payments.getPaymentReceipt({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v68/methods/payments_sendPaymentForm.md index 79758b56..678b749b 100644 --- a/old_docs/API_docs_v68/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v68/methods/payments_sendPaymentForm.md @@ -12,10 +12,10 @@ Bots only: send payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +|msg\_id|[int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) @@ -23,13 +23,6 @@ Bots only: send payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: payments_PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v68/methods/payments_validateRequestedInfo.md index d473f97c..df6a9ba9 100644 --- a/old_docs/API_docs_v68/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v68/methods/payments_validateRequestedInfo.md @@ -12,9 +12,9 @@ Validate requested payment info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +|save|[Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) @@ -22,13 +22,6 @@ Validate requested payment info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: payments_ValidatedRequestedInfo = payments.validateRequestedInfo({save=Bool, msg_id=int, info=PaymentRequestedInfo, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v68/methods/phone_receivedCall.md b/old_docs/API_docs_v68/methods/phone_receivedCall.md index 17095622..6141a0ab 100644 --- a/old_docs/API_docs_v68/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v68/methods/phone_receivedCall.md @@ -12,7 +12,7 @@ Notify server that you received a call (server will refuse all incoming calls un | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| ### Return type: [Bool](../types/Bool.md) @@ -20,14 +20,6 @@ Notify server that you received a call (server will refuse all incoming calls un ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_ALREADY_DECLINED|The call was already declined| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = phone.receivedCall({peer=InputPhoneCall, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_ALREADY_DECLINED|The call was already declined| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v68/methods/phone_saveCallDebug.md b/old_docs/API_docs_v68/methods/phone_saveCallDebug.md index 0ff049a8..9f3daa18 100644 --- a/old_docs/API_docs_v68/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v68/methods/phone_saveCallDebug.md @@ -12,8 +12,8 @@ Save call debugging info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Debugging info| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| +|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Save call debugging info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| -|DATA_JSON_INVALID|The provided JSON data is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = phone.saveCallDebug({peer=InputPhoneCall, debug=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| +|DATA_JSON_INVALID|The provided JSON data is invalid| + + diff --git a/old_docs/API_docs_v68/methods/phone_setCallRating.md b/old_docs/API_docs_v68/methods/phone_setCallRating.md index d0aab7e0..d9833492 100644 --- a/old_docs/API_docs_v68/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v68/methods/phone_setCallRating.md @@ -12,9 +12,9 @@ Set phone call rating | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[CLICK ME int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[CLICK ME string](../types/string.md) | Yes|An optional comment| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| +|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| +|comment|[string](../types/string.md) | Yes|An optional comment| ### Return type: [Updates](../types/Updates.md) @@ -22,13 +22,6 @@ Set phone call rating ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Updates = phone.setCallRating({peer=InputPhoneCall, rating=int, comment='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v68/methods/photos_getUserPhotos.md b/old_docs/API_docs_v68/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v68/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v68/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v68/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v68/methods/photos_uploadProfilePhoto.md index c7ec3063..0c994ffe 100644 --- a/old_docs/API_docs_v68/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v68/methods/photos_uploadProfilePhoto.md @@ -20,16 +20,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -66,3 +56,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v68/methods/ping.md b/old_docs/API_docs_v68/methods/ping.md index f987ae89..daf1cc65 100644 --- a/old_docs/API_docs_v68/methods/ping.md +++ b/old_docs/API_docs_v68/methods/ping.md @@ -12,7 +12,7 @@ pings the server | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v68/methods/ping_delay_disconnect.md b/old_docs/API_docs_v68/methods/ping_delay_disconnect.md index 5b1c115d..66cc3704 100644 --- a/old_docs/API_docs_v68/methods/ping_delay_disconnect.md +++ b/old_docs/API_docs_v68/methods/ping_delay_disconnect.md @@ -12,8 +12,8 @@ Pings the server and causes disconection if the same method is not called within | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[CLICK ME int](../types/int.md) | Yes|Disconection delay| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| +|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v68/methods/req_DH_params.md b/old_docs/API_docs_v68/methods/req_DH_params.md index f0b45851..a426c699 100644 --- a/old_docs/API_docs_v68/methods/req_DH_params.md +++ b/old_docs/API_docs_v68/methods/req_DH_params.md @@ -12,12 +12,12 @@ Requests Diffie-hellman parameters for key exchange | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[CLICK ME string](../types/string.md) | Yes|factorized p from pq| -|q|[CLICK ME string](../types/string.md) | Yes|factorized q from pq| -|public\_key\_fingerprint|[CLICK ME long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[CLICK ME string](../types/string.md) | Yes|Encrypted message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|p|[string](../types/string.md) | Yes|factorized p from pq| +|q|[string](../types/string.md) | Yes|factorized q from pq| +|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| +|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/old_docs/API_docs_v68/methods/req_pq.md b/old_docs/API_docs_v68/methods/req_pq.md index 0873d9a2..d273a0b9 100644 --- a/old_docs/API_docs_v68/methods/req_pq.md +++ b/old_docs/API_docs_v68/methods/req_pq.md @@ -12,7 +12,7 @@ Requests PQ for factorization | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/old_docs/API_docs_v68/methods/rpc_drop_answer.md b/old_docs/API_docs_v68/methods/rpc_drop_answer.md index 27f98bca..34b355f3 100644 --- a/old_docs/API_docs_v68/methods/rpc_drop_answer.md +++ b/old_docs/API_docs_v68/methods/rpc_drop_answer.md @@ -12,7 +12,7 @@ Do not send answer to provided request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|req\_msg\_id|[CLICK ME long](../types/long.md) | Yes|The message ID of the request| +|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/old_docs/API_docs_v68/methods/set_client_DH_params.md b/old_docs/API_docs_v68/methods/set_client_DH_params.md index cf8ab321..5a173688 100644 --- a/old_docs/API_docs_v68/methods/set_client_DH_params.md +++ b/old_docs/API_docs_v68/methods/set_client_DH_params.md @@ -12,9 +12,9 @@ Sets client diffie-hellman parameters | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[CLICK ME string](../types/string.md) | Yes|Encrypted message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/old_docs/API_docs_v68/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v68/methods/stickers_addStickerToSet.md index 7c4191d8..6e1d680c 100644 --- a/old_docs/API_docs_v68/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v68/methods/stickers_addStickerToSet.md @@ -12,8 +12,8 @@ Add sticker to stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -21,14 +21,6 @@ Add sticker to stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.addStickerToSet({stickerset=InputStickerSet, sticker=InputStickerSetItem, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v68/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v68/methods/stickers_changeStickerPosition.md index 57803898..c4f34ec8 100644 --- a/old_docs/API_docs_v68/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v68/methods/stickers_changeStickerPosition.md @@ -13,7 +13,7 @@ Change sticker position in photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[CLICK ME int](../types/int.md) | Yes|New position| +|position|[int](../types/int.md) | Yes|New position| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Change sticker position in photo ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKER_INVALID|The provided sticker is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Bool = stickers.changeStickerPosition({sticker=InputDocument, position=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v68/methods/stickers_createStickerSet.md b/old_docs/API_docs_v68/methods/stickers_createStickerSet.md index 95775849..371033ca 100644 --- a/old_docs/API_docs_v68/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v68/methods/stickers_createStickerSet.md @@ -12,11 +12,11 @@ Create stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Masks?| +|masks|[Bool](../types/Bool.md) | Optional|Masks?| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[CLICK ME string](../types/string.md) | Yes|The stickerset title| -|short\_name|[CLICK ME string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +|title|[string](../types/string.md) | Yes|The stickerset title| +|short\_name|[string](../types/string.md) | Yes|The stickerset short name| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -24,21 +24,6 @@ Create stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|PACK_SHORT_NAME_INVALID|Short pack name invalid| -|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| -|PEER_ID_INVALID|The provided peer id is invalid| -|STICKER_EMOJI_INVALID|Sticker emoji invalid| -|STICKER_FILE_INVALID|Sticker file invalid| -|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| -|STICKERS_EMPTY|No sticker provided| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -92,3 +77,18 @@ Or, if you're into Lua: messages_StickerSet = stickers.createStickerSet({masks=Bool, user_id=InputUser, title='string', short_name='string', stickers={InputStickerSetItem}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|PACK_SHORT_NAME_INVALID|Short pack name invalid| +|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| +|PEER_ID_INVALID|The provided peer id is invalid| +|STICKER_EMOJI_INVALID|Sticker emoji invalid| +|STICKER_FILE_INVALID|Sticker file invalid| +|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| +|STICKERS_EMPTY|No sticker provided| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v68/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v68/methods/stickers_removeStickerFromSet.md index b57376d2..e5840fbf 100644 --- a/old_docs/API_docs_v68/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v68/methods/stickers_removeStickerFromSet.md @@ -20,14 +20,6 @@ Remove sticker from stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKER_INVALID|The provided sticker is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Bool = stickers.removeStickerFromSet({sticker=InputDocument, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v68/methods/upload_getWebFile.md b/old_docs/API_docs_v68/methods/upload_getWebFile.md index 11634633..f869519a 100644 --- a/old_docs/API_docs_v68/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v68/methods/upload_getWebFile.md @@ -12,9 +12,9 @@ Download a file through telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[int](../types/int.md) | Yes|The offset in bytes| +|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) @@ -22,13 +22,6 @@ Download a file through telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LOCATION_INVALID|The provided location is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: upload_WebFile = upload.getWebFile({location=InputWebFileLocation, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LOCATION_INVALID|The provided location is invalid| + + diff --git a/old_docs/API_docs_v68/methods/users_getUsers.md b/old_docs/API_docs_v68/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v68/methods/users_getUsers.md +++ b/old_docs/API_docs_v68/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/account_changePhone.md b/old_docs/API_docs_v70/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v70/methods/account_changePhone.md +++ b/old_docs/API_docs_v70/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_checkUsername.md b/old_docs/API_docs_v70/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v70/methods/account_checkUsername.md +++ b/old_docs/API_docs_v70/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v70/methods/account_confirmPhone.md b/old_docs/API_docs_v70/methods/account_confirmPhone.md index 68490f35..7ffabc24 100644 --- a/old_docs/API_docs_v70/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v70/methods/account_confirmPhone.md @@ -12,8 +12,8 @@ Confirm this phone number is associated to this account, obtain phone_code_hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| +|phone\_code\_hash|[string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Confirm this phone number is associated to this account, obtain phone_code_hash ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_HASH_INVALID|Code hash invalid| -|PHONE_CODE_EMPTY|phone_code is missing| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_HASH_INVALID|Code hash invalid| +|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/old_docs/API_docs_v70/methods/account_deleteAccount.md b/old_docs/API_docs_v70/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v70/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v70/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/account_getNotifySettings.md b/old_docs/API_docs_v70/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v70/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v70/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_getPasswordSettings.md b/old_docs/API_docs_v70/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v70/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v70/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_getPrivacy.md b/old_docs/API_docs_v70/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v70/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v70/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_getTmpPassword.md b/old_docs/API_docs_v70/methods/account_getTmpPassword.md index 01b1ebfc..c82ff37a 100644 --- a/old_docs/API_docs_v70/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v70/methods/account_getTmpPassword.md @@ -12,8 +12,8 @@ Get temporary password for buying products through bots | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|The password hash| -|period|[CLICK ME int](../types/int.md) | Yes|The validity period| +|password\_hash|[bytes](../types/bytes.md) | Yes|The password hash| +|period|[int](../types/int.md) | Yes|The validity period| ### Return type: [account\_TmpPassword](../types/account_TmpPassword.md) @@ -21,14 +21,6 @@ Get temporary password for buying products through bots ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| -|TMP_PASSWORD_DISABLED|The temporary password is disabled| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: account_TmpPassword = account.getTmpPassword({password_hash='bytes', period=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|TMP_PASSWORD_DISABLED|The temporary password is disabled| + + diff --git a/old_docs/API_docs_v70/methods/account_registerDevice.md b/old_docs/API_docs_v70/methods/account_registerDevice.md index 4e148a7f..cbac71d3 100644 --- a/old_docs/API_docs_v70/methods/account_registerDevice.md +++ b/old_docs/API_docs_v70/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_reportPeer.md b/old_docs/API_docs_v70/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v70/methods/account_reportPeer.md +++ b/old_docs/API_docs_v70/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_resetAuthorization.md b/old_docs/API_docs_v70/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v70/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v70/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v70/methods/account_sendChangePhoneCode.md index bdf7331f..476b6d79 100644 --- a/old_docs/API_docs_v70/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v70/methods/account_sendChangePhoneCode.md @@ -12,9 +12,9 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|Current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v70/methods/account_sendConfirmPhoneCode.md index 86035d19..8917355f 100644 --- a/old_docs/API_docs_v70/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v70/methods/account_sendConfirmPhoneCode.md @@ -12,9 +12,9 @@ Send confirmation phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| -|hash|[CLICK ME string](../types/string.md) | Yes|The hash| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|The current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| +|hash|[string](../types/string.md) | Yes|The hash| +|current\_number|[Bool](../types/Bool.md) | Optional|The current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Send confirmation phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendConfirmPhoneCode({allow_flashcall=Bool, hash='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_setAccountTTL.md b/old_docs/API_docs_v70/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v70/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v70/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_setPrivacy.md b/old_docs/API_docs_v70/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v70/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v70/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_unregisterDevice.md b/old_docs/API_docs_v70/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v70/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v70/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v70/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v70/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v70/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/account_updateNotifySettings.md b/old_docs/API_docs_v70/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v70/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v70/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v70/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v70/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v70/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_updateProfile.md b/old_docs/API_docs_v70/methods/account_updateProfile.md index 59629188..ef19dc00 100644 --- a/old_docs/API_docs_v70/methods/account_updateProfile.md +++ b/old_docs/API_docs_v70/methods/account_updateProfile.md @@ -12,9 +12,9 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Optional|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Optional|The last name| -|about|[CLICK ME string](../types/string.md) | Optional|The bio/about field| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| ### Return type: [User](../types/User.md) @@ -22,14 +22,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v70/methods/account_updateStatus.md b/old_docs/API_docs_v70/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v70/methods/account_updateStatus.md +++ b/old_docs/API_docs_v70/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v70/methods/account_updateUsername.md b/old_docs/API_docs_v70/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v70/methods/account_updateUsername.md +++ b/old_docs/API_docs_v70/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v70/methods/auth_cancelCode.md b/old_docs/API_docs_v70/methods/auth_cancelCode.md index 52b85d4c..84401c62 100644 --- a/old_docs/API_docs_v70/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v70/methods/auth_cancelCode.md @@ -12,8 +12,8 @@ Invalidate sent phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invalidate sent phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v70/methods/auth_checkPhone.md b/old_docs/API_docs_v70/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v70/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v70/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v70/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v70/methods/auth_dropTempAuthKeys.md index 5aa98b3b..537afbc1 100644 --- a/old_docs/API_docs_v70/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v70/methods/auth_dropTempAuthKeys.md @@ -12,7 +12,7 @@ Delete all temporary authorization keys except the ones provided | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_auth\_keys|Array of [CLICK ME long](../types/long.md) | Yes|The temporary authorization keys to keep| +|except\_auth\_keys|Array of [long](../types/long.md) | Yes|The temporary authorization keys to keep| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/auth_recoverPassword.md b/old_docs/API_docs_v70/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v70/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v70/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v70/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v70/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v70/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v70/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v70/methods/auth_resendCode.md b/old_docs/API_docs_v70/methods/auth_resendCode.md index 253480a3..4402bfe6 100644 --- a/old_docs/API_docs_v70/methods/auth_resendCode.md +++ b/old_docs/API_docs_v70/methods/auth_resendCode.md @@ -12,8 +12,8 @@ Resend the SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -21,13 +21,6 @@ Resend the SMS verification code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v70/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v70/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v70/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v70/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/auth_sendInvites.md b/old_docs/API_docs_v70/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v70/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v70/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v70/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v70/methods/bots_answerWebhookJSONQuery.md index 40cb0477..3dbf62ef 100644 --- a/old_docs/API_docs_v70/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v70/methods/bots_answerWebhookJSONQuery.md @@ -12,8 +12,8 @@ Send webhook request via bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|data|[DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Send webhook request via bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Bool = bots.answerWebhookJSONQuery({query_id=long, data=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v70/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v70/methods/bots_sendCustomRequest.md index 5a7f4e86..cb7c32e2 100644 --- a/old_docs/API_docs_v70/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v70/methods/bots_sendCustomRequest.md @@ -12,8 +12,8 @@ Send a custom request to the bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| +|custom\_method|[string](../types/string.md) | Yes|The method to call| +|params|[DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) @@ -21,13 +21,6 @@ Send a custom request to the bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: DataJSON = bots.sendCustomRequest({custom_method='string', params=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v70/methods/channels_checkUsername.md b/old_docs/API_docs_v70/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v70/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v70/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v70/methods/channels_createChannel.md b/old_docs/API_docs_v70/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v70/methods/channels_createChannel.md +++ b/old_docs/API_docs_v70/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v70/methods/channels_deleteChannel.md b/old_docs/API_docs_v70/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v70/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v70/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v70/methods/channels_deleteMessages.md b/old_docs/API_docs_v70/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v70/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v70/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v70/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v70/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v70/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v70/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v70/methods/channels_editAbout.md b/old_docs/API_docs_v70/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v70/methods/channels_editAbout.md +++ b/old_docs/API_docs_v70/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v70/methods/channels_editAdmin.md b/old_docs/API_docs_v70/methods/channels_editAdmin.md index 7cecbd64..f08473eb 100644 --- a/old_docs/API_docs_v70/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v70/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| +|admin\_rights|[ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, admin_rights=ChannelAdminRights, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v70/methods/channels_editBanned.md b/old_docs/API_docs_v70/methods/channels_editBanned.md index ca9f2596..03dc70a5 100644 --- a/old_docs/API_docs_v70/methods/channels_editBanned.md +++ b/old_docs/API_docs_v70/methods/channels_editBanned.md @@ -14,7 +14,7 @@ Kick or ban a user from a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban| -|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| +|banned\_rights|[ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| ### Return type: [Updates](../types/Updates.md) @@ -22,17 +22,6 @@ Kick or ban a user from a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ADMIN_INVALID|You're not an admin| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +71,14 @@ Or, if you're into Lua: Updates = channels.editBanned({channel=InputChannel, user_id=InputUser, banned_rights=ChannelBannedRights, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ADMIN_INVALID|You're not an admin| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v70/methods/channels_editPhoto.md b/old_docs/API_docs_v70/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v70/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v70/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v70/methods/channels_editTitle.md b/old_docs/API_docs_v70/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v70/methods/channels_editTitle.md +++ b/old_docs/API_docs_v70/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v70/methods/channels_exportInvite.md b/old_docs/API_docs_v70/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v70/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v70/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v70/methods/channels_exportMessageLink.md b/old_docs/API_docs_v70/methods/channels_exportMessageLink.md index b4a3c645..20f6e998 100644 --- a/old_docs/API_docs_v70/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v70/methods/channels_exportMessageLink.md @@ -13,7 +13,7 @@ Get the link of a message in a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| +|id|[int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -21,13 +21,6 @@ Get the link of a message in a channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v70/methods/channels_getAdminLog.md b/old_docs/API_docs_v70/methods/channels_getAdminLog.md index 4a419778..1ffcf5c3 100644 --- a/old_docs/API_docs_v70/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v70/methods/channels_getAdminLog.md @@ -13,12 +13,12 @@ Get admin log of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|q|[CLICK ME string](../types/string.md) | Yes|Search query| -|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| +|q|[string](../types/string.md) | Yes|Search query| +|events\_filter|[ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| |admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME long](../types/long.md) | Yes|Minimum message ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[long](../types/long.md) | Yes|Maximum message ID to fetch| +|min\_id|[long](../types/long.md) | Yes|Minimum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) @@ -26,15 +26,6 @@ Get admin log of a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -83,3 +74,12 @@ Or, if you're into Lua: channels_AdminLogResults = channels.getAdminLog({channel=InputChannel, q='string', events_filter=ChannelAdminLogEventsFilter, admins={InputUser}, max_id=long, min_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v70/methods/channels_getChannels.md b/old_docs/API_docs_v70/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v70/methods/channels_getChannels.md +++ b/old_docs/API_docs_v70/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v70/methods/channels_getMessages.md b/old_docs/API_docs_v70/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v70/methods/channels_getMessages.md +++ b/old_docs/API_docs_v70/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v70/methods/channels_getParticipant.md b/old_docs/API_docs_v70/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v70/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v70/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v70/methods/channels_getParticipants.md b/old_docs/API_docs_v70/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v70/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v70/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/channels_inviteToChannel.md b/old_docs/API_docs_v70/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v70/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v70/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v70/methods/channels_joinChannel.md b/old_docs/API_docs_v70/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v70/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v70/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v70/methods/channels_leaveChannel.md b/old_docs/API_docs_v70/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v70/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v70/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v70/methods/channels_readHistory.md b/old_docs/API_docs_v70/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v70/methods/channels_readHistory.md +++ b/old_docs/API_docs_v70/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v70/methods/channels_reportSpam.md b/old_docs/API_docs_v70/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v70/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v70/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v70/methods/channels_toggleInvites.md b/old_docs/API_docs_v70/methods/channels_toggleInvites.md index e9e6450d..d437682f 100644 --- a/old_docs/API_docs_v70/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v70/methods/channels_toggleInvites.md @@ -13,7 +13,7 @@ Allow or disallow any user to invite users to this channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Allow or disallow any user to invite users to this channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v70/methods/channels_toggleSignatures.md b/old_docs/API_docs_v70/methods/channels_toggleSignatures.md index 36d1eccb..d40bf67b 100644 --- a/old_docs/API_docs_v70/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v70/methods/channels_toggleSignatures.md @@ -13,7 +13,7 @@ Toggle channel signatures | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Toggle channel signatures ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v70/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v70/methods/channels_updatePinnedMessage.md index f8d10ece..aa2cc783 100644 --- a/old_docs/API_docs_v70/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v70/methods/channels_updatePinnedMessage.md @@ -12,9 +12,9 @@ Set the pinned message of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Set the pinned message of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -81,3 +71,13 @@ Or, if you're into Lua: Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v70/methods/channels_updateUsername.md b/old_docs/API_docs_v70/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v70/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v70/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v70/methods/contacts_block.md b/old_docs/API_docs_v70/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v70/methods/contacts_block.md +++ b/old_docs/API_docs_v70/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v70/methods/contacts_deleteContact.md b/old_docs/API_docs_v70/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v70/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v70/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v70/methods/contacts_deleteContacts.md b/old_docs/API_docs_v70/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v70/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v70/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/contacts_getBlocked.md b/old_docs/API_docs_v70/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v70/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v70/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v70/methods/contacts_getContacts.md b/old_docs/API_docs_v70/methods/contacts_getContacts.md index 83c4846f..6fc46414 100644 --- a/old_docs/API_docs_v70/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v70/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v70/methods/contacts_getTopPeers.md b/old_docs/API_docs_v70/methods/contacts_getTopPeers.md index 4958e6b2..a8cd4c57 100644 --- a/old_docs/API_docs_v70/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v70/methods/contacts_getTopPeers.md @@ -12,15 +12,15 @@ Get most used chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|correspondents|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch users?| -|bots\_pm|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch bots?| -|bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| -|phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?| -|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| -|channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| +|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?| +|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?| +|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?| +|phone\_calls|[Bool](../types/Bool.md) | Optional|Fetch phone calls?| +|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?| +|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| +|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|limit|[int](../types/int.md) | Yes|How many results to fetch| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| ### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) @@ -28,13 +28,6 @@ Get most used chats ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TYPES_EMPTY|The types field is empty| - - ### MadelineProto Example: @@ -87,3 +80,10 @@ Or, if you're into Lua: contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, phone_calls=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field is empty| + + diff --git a/old_docs/API_docs_v70/methods/contacts_importCard.md b/old_docs/API_docs_v70/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v70/methods/contacts_importCard.md +++ b/old_docs/API_docs_v70/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v70/methods/contacts_importContacts.md b/old_docs/API_docs_v70/methods/contacts_importContacts.md index cd3d6615..745de92b 100644 --- a/old_docs/API_docs_v70/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v70/methods/contacts_importContacts.md @@ -12,8 +12,8 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| +|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v70/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v70/methods/contacts_resetTopPeerRating.md index 4b5e96f1..15b07f96 100644 --- a/old_docs/API_docs_v70/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v70/methods/contacts_resetTopPeerRating.md @@ -12,7 +12,7 @@ Reset top peer rating for a certain category/peer | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| @@ -21,13 +21,6 @@ Reset top peer rating for a certain category/peer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/contacts_search.md b/old_docs/API_docs_v70/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v70/methods/contacts_search.md +++ b/old_docs/API_docs_v70/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/contacts_unblock.md b/old_docs/API_docs_v70/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v70/methods/contacts_unblock.md +++ b/old_docs/API_docs_v70/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v70/methods/contest_saveDeveloperInfo.md b/old_docs/API_docs_v70/methods/contest_saveDeveloperInfo.md index 5d82a4be..de23c472 100644 --- a/old_docs/API_docs_v70/methods/contest_saveDeveloperInfo.md +++ b/old_docs/API_docs_v70/methods/contest_saveDeveloperInfo.md @@ -12,11 +12,11 @@ Save developer info for telegram contest | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|vk\_id|[CLICK ME int](../types/int.md) | Yes|VK user ID| -|name|[CLICK ME string](../types/string.md) | Yes|Name| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|age|[CLICK ME int](../types/int.md) | Yes|Age| -|city|[CLICK ME string](../types/string.md) | Yes|City| +|vk\_id|[int](../types/int.md) | Yes|VK user ID| +|name|[string](../types/string.md) | Yes|Name| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|age|[int](../types/int.md) | Yes|Age| +|city|[string](../types/string.md) | Yes|City| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/destroy_session.md b/old_docs/API_docs_v70/methods/destroy_session.md index b74fbd11..c4187ce0 100644 --- a/old_docs/API_docs_v70/methods/destroy_session.md +++ b/old_docs/API_docs_v70/methods/destroy_session.md @@ -12,7 +12,7 @@ Destroy the current MTProto session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|session\_id|[CLICK ME long](../types/long.md) | Yes|The session to destroy| +|session\_id|[long](../types/long.md) | Yes|The session to destroy| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/old_docs/API_docs_v70/methods/get_future_salts.md b/old_docs/API_docs_v70/methods/get_future_salts.md index e8451015..7f5fc18c 100644 --- a/old_docs/API_docs_v70/methods/get_future_salts.md +++ b/old_docs/API_docs_v70/methods/get_future_salts.md @@ -12,7 +12,7 @@ Get future salts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|num|[CLICK ME int](../types/int.md) | Yes|How many salts should be fetched| +|num|[int](../types/int.md) | Yes|How many salts should be fetched| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/old_docs/API_docs_v70/methods/help_getAppChangelog.md b/old_docs/API_docs_v70/methods/help_getAppChangelog.md index eda473a6..183ebb8c 100644 --- a/old_docs/API_docs_v70/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v70/methods/help_getAppChangelog.md @@ -12,7 +12,7 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| +|prev\_app\_version|[string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/help_getCdnConfig.md b/old_docs/API_docs_v70/methods/help_getCdnConfig.md index b98949ed..b7af5bb4 100644 --- a/old_docs/API_docs_v70/methods/help_getCdnConfig.md +++ b/old_docs/API_docs_v70/methods/help_getCdnConfig.md @@ -15,13 +15,6 @@ Get CDN configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: CdnConfig = help.getCdnConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/help_getConfig.md b/old_docs/API_docs_v70/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v70/methods/help_getConfig.md +++ b/old_docs/API_docs_v70/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/help_saveAppLog.md b/old_docs/API_docs_v70/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v70/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v70/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v70/methods/help_setBotUpdatesStatus.md index a1a3ab1b..1766ee14 100644 --- a/old_docs/API_docs_v70/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v70/methods/help_setBotUpdatesStatus.md @@ -12,8 +12,8 @@ Set the update status of webhook | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| -|message|[CLICK ME string](../types/string.md) | Yes|Message| +|pending\_updates\_count|[int](../types/int.md) | Yes|Pending update count| +|message|[string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/initConnection.md b/old_docs/API_docs_v70/methods/initConnection.md index c66aa8b1..2d195613 100644 --- a/old_docs/API_docs_v70/methods/initConnection.md +++ b/old_docs/API_docs_v70/methods/initConnection.md @@ -12,14 +12,14 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|system\_lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| -|lang\_pack|[CLICK ME string](../types/string.md) | Yes|Language pack to use| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|system\_lang\_code|[string](../types/string.md) | Yes|Language code| +|lang\_pack|[string](../types/string.md) | Yes|Language pack to use| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -27,14 +27,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -94,3 +86,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', system_lang_code='string', lang_pack='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v70/methods/invokeAfterMsg.md b/old_docs/API_docs_v70/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v70/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v70/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v70/methods/invokeAfterMsgs.md b/old_docs/API_docs_v70/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v70/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v70/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v70/methods/invokeWithLayer.md b/old_docs/API_docs_v70/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v70/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v70/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v70/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v70/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v70/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v70/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v70/methods/langpack_getDifference.md b/old_docs/API_docs_v70/methods/langpack_getDifference.md index 0a6512e4..1860cc49 100644 --- a/old_docs/API_docs_v70/methods/langpack_getDifference.md +++ b/old_docs/API_docs_v70/methods/langpack_getDifference.md @@ -12,7 +12,7 @@ Get language pack updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|from\_version|[CLICK ME int](../types/int.md) | Yes|Previous version| +|from\_version|[int](../types/int.md) | Yes|Previous version| ### Return type: [LangPackDifference](../types/LangPackDifference.md) @@ -20,13 +20,6 @@ Get language pack updates ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: LangPackDifference = langpack.getDifference({from_version=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v70/methods/langpack_getLangPack.md b/old_docs/API_docs_v70/methods/langpack_getLangPack.md index 45a9ca47..7e64aec9 100644 --- a/old_docs/API_docs_v70/methods/langpack_getLangPack.md +++ b/old_docs/API_docs_v70/methods/langpack_getLangPack.md @@ -12,7 +12,7 @@ Get language pack | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [LangPackDifference](../types/LangPackDifference.md) @@ -20,13 +20,6 @@ Get language pack ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: LangPackDifference = langpack.getLangPack({lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v70/methods/langpack_getLanguages.md b/old_docs/API_docs_v70/methods/langpack_getLanguages.md index b573a5eb..c4ea44ca 100644 --- a/old_docs/API_docs_v70/methods/langpack_getLanguages.md +++ b/old_docs/API_docs_v70/methods/langpack_getLanguages.md @@ -15,13 +15,6 @@ Get available languages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Vector_of_LangPackLanguage = langpack.getLanguages({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v70/methods/langpack_getStrings.md b/old_docs/API_docs_v70/methods/langpack_getStrings.md index 841b02db..4953e1c0 100644 --- a/old_docs/API_docs_v70/methods/langpack_getStrings.md +++ b/old_docs/API_docs_v70/methods/langpack_getStrings.md @@ -12,8 +12,8 @@ Get language pack strings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| -|keys|Array of [CLICK ME string](../types/string.md) | Yes|Keys| +|lang\_code|[string](../types/string.md) | Yes|Language code| +|keys|Array of [string](../types/string.md) | Yes|Keys| ### Return type: [Vector\_of\_LangPackString](../types/LangPackString.md) @@ -21,13 +21,6 @@ Get language pack strings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Vector_of_LangPackString = langpack.getStrings({lang_code='string', keys={'string'}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_addChatUser.md b/old_docs/API_docs_v70/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v70/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v70/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v70/methods/messages_checkChatInvite.md b/old_docs/API_docs_v70/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v70/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v70/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v70/methods/messages_clearRecentStickers.md index 1d6ec8c9..72c4844b 100644 --- a/old_docs/API_docs_v70/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v70/methods/messages_clearRecentStickers.md @@ -12,7 +12,7 @@ Clear all recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_createChat.md b/old_docs/API_docs_v70/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v70/methods/messages_createChat.md +++ b/old_docs/API_docs_v70/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v70/methods/messages_deleteChatUser.md b/old_docs/API_docs_v70/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v70/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v70/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v70/methods/messages_deleteHistory.md b/old_docs/API_docs_v70/methods/messages_deleteHistory.md index 45e9890d..601d1876 100644 --- a/old_docs/API_docs_v70/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v70/methods/messages_deleteHistory.md @@ -12,9 +12,9 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|just\_clear|[CLICK ME Bool](../types/Bool.md) | Optional|Only clear it from your side| +|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,13 +22,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_deleteMessages.md b/old_docs/API_docs_v70/methods/messages_deleteMessages.md index c8670444..900e9d0e 100644 --- a/old_docs/API_docs_v70/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v70/methods/messages_deleteMessages.md @@ -12,8 +12,8 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|revoke|[CLICK ME Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,13 +21,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({revoke=Bool, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v70/methods/messages_editChatAdmin.md b/old_docs/API_docs_v70/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v70/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v70/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_editChatPhoto.md b/old_docs/API_docs_v70/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v70/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v70/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_editChatTitle.md b/old_docs/API_docs_v70/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v70/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v70/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v70/methods/messages_editInlineBotMessage.md index 73c8a2c4..4729b52a 100644 --- a/old_docs/API_docs_v70/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v70/methods/messages_editInlineBotMessage.md @@ -12,11 +12,11 @@ Edit a sent inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,14 +25,6 @@ Edit a sent inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| - - ### MadelineProto Example: @@ -120,3 +112,11 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v70/methods/messages_editMessage.md b/old_docs/API_docs_v70/methods/messages_editMessage.md index ad639325..4380aba6 100644 --- a/old_docs/API_docs_v70/methods/messages_editMessage.md +++ b/old_docs/API_docs_v70/methods/messages_editMessage.md @@ -12,12 +12,12 @@ Edit a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -26,22 +26,6 @@ Edit a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -129,3 +113,19 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v70/methods/messages_exportChatInvite.md b/old_docs/API_docs_v70/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v70/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v70/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_forwardMessage.md b/old_docs/API_docs_v70/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v70/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v70/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v70/methods/messages_forwardMessages.md b/old_docs/API_docs_v70/methods/messages_forwardMessages.md index b99e1d31..2a0455e4 100644 --- a/old_docs/API_docs_v70/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v70/methods/messages_forwardMessages.md @@ -12,11 +12,11 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[CLICK ME Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| +|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -25,34 +25,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -108,3 +80,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/messages_getAllChats.md b/old_docs/API_docs_v70/methods/messages_getAllChats.md index 513fc06f..c4851369 100644 --- a/old_docs/API_docs_v70/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v70/methods/messages_getAllChats.md @@ -12,7 +12,7 @@ Get all chats (not supergroups or channels) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v70/methods/messages_getAllStickers.md b/old_docs/API_docs_v70/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v70/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v70/methods/messages_getArchivedStickers.md index ee36b542..dfd5c006 100644 --- a/old_docs/API_docs_v70/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getArchivedStickers.md @@ -12,9 +12,9 @@ Get all archived stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| +|masks|[Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| +|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v70/methods/messages_getAttachedStickers.md index 9f8a66c5..8f51f38d 100644 --- a/old_docs/API_docs_v70/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getAttachedStickers.md @@ -12,7 +12,7 @@ Get stickers attachable to images | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v70/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v70/methods/messages_getBotCallbackAnswer.md index 0136227f..4b8887ad 100644 --- a/old_docs/API_docs_v70/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v70/methods/messages_getBotCallbackAnswer.md @@ -12,10 +12,10 @@ Get the callback answer of a bot (after clicking a button) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|game|[Bool](../types/Bool.md) | Optional|Is this a game?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) @@ -23,17 +23,6 @@ Get the callback answer of a bot (after clicking a button) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|DATA_INVALID|Encrypted data invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: messages_BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/messages_getChats.md b/old_docs/API_docs_v70/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v70/methods/messages_getChats.md +++ b/old_docs/API_docs_v70/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_getCommonChats.md b/old_docs/API_docs_v70/methods/messages_getCommonChats.md index 15ed6713..6ffa0948 100644 --- a/old_docs/API_docs_v70/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v70/methods/messages_getCommonChats.md @@ -13,8 +13,8 @@ Get chats in common with a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -22,13 +22,6 @@ Get chats in common with a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_Chats = messages.getCommonChats({user_id=InputUser, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_getDialogs.md b/old_docs/API_docs_v70/methods/messages_getDialogs.md index 53f9ac62..1035e8ce 100644 --- a/old_docs/API_docs_v70/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v70/methods/messages_getDialogs.md @@ -12,11 +12,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|exclude\_pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -24,16 +24,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v70/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v70/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v70/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v70/methods/messages_getFeaturedStickers.md index 8e49e1ef..af7f69a0 100644 --- a/old_docs/API_docs_v70/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getFeaturedStickers.md @@ -12,7 +12,7 @@ Get featured stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getGameHighScores.md b/old_docs/API_docs_v70/methods/messages_getGameHighScores.md index 113e4647..af3f3915 100644 --- a/old_docs/API_docs_v70/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v70/methods/messages_getGameHighScores.md @@ -13,7 +13,7 @@ Get high scores of a game | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -22,14 +22,6 @@ Get high scores of a game ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -79,3 +71,11 @@ Or, if you're into Lua: messages_HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v70/methods/messages_getHistory.md b/old_docs/API_docs_v70/methods/messages_getHistory.md index 851d2680..86a744cf 100644 --- a/old_docs/API_docs_v70/methods/messages_getHistory.md +++ b/old_docs/API_docs_v70/methods/messages_getHistory.md @@ -13,12 +13,12 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -26,18 +26,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v70/methods/messages_getInlineBotResults.md index 4d86caf5..207624a7 100644 --- a/old_docs/API_docs_v70/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v70/methods/messages_getInlineBotResults.md @@ -14,9 +14,9 @@ Call inline bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -24,16 +24,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v70/methods/messages_getInlineGameHighScores.md index d5a80005..e03bc273 100644 --- a/old_docs/API_docs_v70/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v70/methods/messages_getInlineGameHighScores.md @@ -12,7 +12,7 @@ Get high scores of a game sent in an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -21,14 +21,6 @@ Get high scores of a game sent in an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v70/methods/messages_getMaskStickers.md b/old_docs/API_docs_v70/methods/messages_getMaskStickers.md index 70e2e6d4..1fbd9346 100644 --- a/old_docs/API_docs_v70/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getMaskStickers.md @@ -12,7 +12,7 @@ Get masks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getMessageEditData.md b/old_docs/API_docs_v70/methods/messages_getMessageEditData.md index 34f8534f..00c63d28 100644 --- a/old_docs/API_docs_v70/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v70/methods/messages_getMessageEditData.md @@ -13,7 +13,7 @@ Check if about to edit a message or a media caption | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) @@ -21,14 +21,6 @@ Check if about to edit a message or a media caption ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v70/methods/messages_getMessages.md b/old_docs/API_docs_v70/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v70/methods/messages_getMessages.md +++ b/old_docs/API_docs_v70/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v70/methods/messages_getMessagesViews.md b/old_docs/API_docs_v70/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v70/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v70/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v70/methods/messages_getPeerDialogs.md index 063b6e7d..000e8eb6 100644 --- a/old_docs/API_docs_v70/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v70/methods/messages_getPeerDialogs.md @@ -20,14 +20,6 @@ Get dialog info of peers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: messages_PeerDialogs = messages.getPeerDialogs({peers={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_getPeerSettings.md b/old_docs/API_docs_v70/methods/messages_getPeerSettings.md index a18126f0..5a3e9349 100644 --- a/old_docs/API_docs_v70/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v70/methods/messages_getPeerSettings.md @@ -20,14 +20,6 @@ Get the settings of apeer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: PeerSettings = messages.getPeerSettings({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_getRecentStickers.md b/old_docs/API_docs_v70/methods/messages_getRecentStickers.md index 0c5ae0c6..629a2bda 100644 --- a/old_docs/API_docs_v70/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getRecentStickers.md @@ -12,8 +12,8 @@ Get recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getSavedGifs.md b/old_docs/API_docs_v70/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v70/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v70/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v70/methods/messages_getStickerSet.md b/old_docs/API_docs_v70/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v70/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v70/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_getWebPage.md b/old_docs/API_docs_v70/methods/messages_getWebPage.md index 19ca94b9..1b533ebd 100644 --- a/old_docs/API_docs_v70/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v70/methods/messages_getWebPage.md @@ -12,8 +12,8 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|url|[CLICK ME string](../types/string.md) | Yes|URL| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|url|[string](../types/string.md) | Yes|URL| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) @@ -21,13 +21,6 @@ Get webpage preview ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|WC_CONVERT_URL_INVALID|WC convert URL invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: WebPage = messages.getWebPage({url='string', hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|WC_CONVERT_URL_INVALID|WC convert URL invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v70/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v70/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v70/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v70/methods/messages_hideReportSpam.md b/old_docs/API_docs_v70/methods/messages_hideReportSpam.md index 30523f2a..0bf711ea 100644 --- a/old_docs/API_docs_v70/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v70/methods/messages_hideReportSpam.md @@ -20,13 +20,6 @@ Hide report spam popup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.hideReportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_importChatInvite.md b/old_docs/API_docs_v70/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v70/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v70/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v70/methods/messages_installStickerSet.md b/old_docs/API_docs_v70/methods/messages_installStickerSet.md index 20f90b71..d6caf555 100644 --- a/old_docs/API_docs_v70/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v70/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_migrateChat.md b/old_docs/API_docs_v70/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v70/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v70/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v70/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v70/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v70/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v70/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v70/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v70/methods/messages_readFeaturedStickers.md index 050371da..3b01171b 100644 --- a/old_docs/API_docs_v70/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v70/methods/messages_readFeaturedStickers.md @@ -12,7 +12,7 @@ Mark new featured stickers as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| +|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_readHistory.md b/old_docs/API_docs_v70/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v70/methods/messages_readHistory.md +++ b/old_docs/API_docs_v70/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/messages_readMessageContents.md b/old_docs/API_docs_v70/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v70/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v70/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v70/methods/messages_receivedMessages.md b/old_docs/API_docs_v70/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v70/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v70/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v70/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v70/methods/messages_reorderPinnedDialogs.md index 94d3b2d4..232117e8 100644 --- a/old_docs/API_docs_v70/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v70/methods/messages_reorderPinnedDialogs.md @@ -12,7 +12,7 @@ Reorder pinned dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|force|[Bool](../types/Bool.md) | Optional|Force reordering| |order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| @@ -21,13 +21,6 @@ Reorder pinned dialogs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.reorderPinnedDialogs({force=Bool, order={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v70/methods/messages_reorderStickerSets.md index 66f5e682..6a71da86 100644 --- a/old_docs/API_docs_v70/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v70/methods/messages_reorderStickerSets.md @@ -12,8 +12,8 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v70/methods/messages_reportEncryptedSpam.md index cd03c35c..988e0101 100644 --- a/old_docs/API_docs_v70/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v70/methods/messages_reportEncryptedSpam.md @@ -20,13 +20,6 @@ Report for spam a secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportEncryptedSpam({peer=InputEncryptedChat, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_reportSpam.md b/old_docs/API_docs_v70/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v70/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v70/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_saveDraft.md b/old_docs/API_docs_v70/methods/messages_saveDraft.md index 59b33b03..60d72c1e 100644 --- a/old_docs/API_docs_v70/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v70/methods/messages_saveDraft.md @@ -12,11 +12,11 @@ Save a message draft | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,13 +25,6 @@ Save a message draft ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -104,3 +97,10 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_saveGif.md b/old_docs/API_docs_v70/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v70/methods/messages_saveGif.md +++ b/old_docs/API_docs_v70/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v70/methods/messages_saveRecentSticker.md index 55757080..d2418881 100644 --- a/old_docs/API_docs_v70/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v70/methods/messages_saveRecentSticker.md @@ -12,9 +12,9 @@ Add a sticker to recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Add a sticker to recent stickers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.saveRecentSticker({attached=Bool, id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_search.md b/old_docs/API_docs_v70/methods/messages_search.md index 24e06c09..a3eb7324 100644 --- a/old_docs/API_docs_v70/methods/messages_search.md +++ b/old_docs/API_docs_v70/methods/messages_search.md @@ -13,14 +13,14 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| +|q|[string](../types/string.md) | Yes|What to search| |from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset | -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset|[int](../types/int.md) | Yes|Offset | +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -28,19 +28,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -93,3 +80,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', from_id=InputUser, filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_searchGifs.md b/old_docs/API_docs_v70/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v70/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v70/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v70/methods/messages_searchGlobal.md b/old_docs/API_docs_v70/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v70/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v70/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v70/methods/messages_sendEncrypted.md b/old_docs/API_docs_v70/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v70/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v70/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v70/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v70/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v70/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v70/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v70/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v70/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v70/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v70/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v70/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v70/methods/messages_sendInlineBotResult.md index 758aa97f..d1f9fbd0 100644 --- a/old_docs/API_docs_v70/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v70/methods/messages_sendInlineBotResult.md @@ -12,13 +12,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -26,18 +26,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v70/methods/messages_sendMedia.md b/old_docs/API_docs_v70/methods/messages_sendMedia.md index 770d1b65..94e27b83 100644 --- a/old_docs/API_docs_v70/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v70/methods/messages_sendMedia.md @@ -12,13 +12,13 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -26,34 +26,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -117,3 +89,31 @@ Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, pe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/messages_sendMessage.md b/old_docs/API_docs_v70/methods/messages_sendMessage.md index 83dc6c8b..ba76f230 100644 --- a/old_docs/API_docs_v70/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v70/methods/messages_sendMessage.md @@ -12,15 +12,15 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,33 +29,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -143,3 +116,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v70/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v70/methods/messages_sendScreenshotNotification.md index e823fd52..9db86b56 100644 --- a/old_docs/API_docs_v70/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v70/methods/messages_sendScreenshotNotification.md @@ -13,7 +13,7 @@ Send screenshot notification | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Send screenshot notification ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = messages.sendScreenshotNotification({peer=InputPeer, reply_to_msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v70/methods/messages_setBotCallbackAnswer.md index e221ccca..34c7bb16 100644 --- a/old_docs/API_docs_v70/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v70/methods/messages_setBotCallbackAnswer.md @@ -12,11 +12,11 @@ Bots only: set the callback answer (after a button was clicked) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|message|[CLICK ME string](../types/string.md) | Optional|The message| -|url|[CLICK ME string](../types/string.md) | Optional|The URL| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| +|url|[string](../types/string.md) | Optional|The URL| +|cache\_time|[int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) @@ -24,13 +24,6 @@ Bots only: set the callback answer (after a button was clicked) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -90,3 +83,10 @@ Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v70/methods/messages_setBotPrecheckoutResults.md index 7e3fc3c2..f631bf0c 100644 --- a/old_docs/API_docs_v70/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v70/methods/messages_setBotPrecheckoutResults.md @@ -12,9 +12,9 @@ Bots only: set precheckout results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| +|success|[Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set precheckout results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ERROR_TEXT_EMPTY|The provided error message is empty| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotPrecheckoutResults({success=Bool, query_id=long, error='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ERROR_TEXT_EMPTY|The provided error message is empty| + + diff --git a/old_docs/API_docs_v70/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v70/methods/messages_setBotShippingResults.md index 3d9f0ae2..915cfebf 100644 --- a/old_docs/API_docs_v70/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v70/methods/messages_setBotShippingResults.md @@ -12,9 +12,9 @@ Bots only: set shipping results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set shipping results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotShippingResults({query_id=long, error='string', shipping_options={ShippingOption}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v70/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v70/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v70/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_setGameScore.md b/old_docs/API_docs_v70/methods/messages_setGameScore.md index 90594a1d..c3d5a2c7 100644 --- a/old_docs/API_docs_v70/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v70/methods/messages_setGameScore.md @@ -12,12 +12,12 @@ Set the game score | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) @@ -25,14 +25,6 @@ Set the game score ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: Updates = messages.setGameScore({edit_message=Bool, force=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v70/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v70/methods/messages_setInlineBotResults.md index d4ba6e65..e46598e2 100644 --- a/old_docs/API_docs_v70/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v70/methods/messages_setInlineBotResults.md @@ -12,13 +12,13 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) @@ -26,23 +26,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -100,3 +83,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v70/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v70/methods/messages_setInlineGameScore.md index 2b7326f3..d33da5ef 100644 --- a/old_docs/API_docs_v70/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v70/methods/messages_setInlineGameScore.md @@ -12,11 +12,11 @@ Set the game score of an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) @@ -24,14 +24,6 @@ Set the game score of an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -85,3 +77,11 @@ Or, if you're into Lua: Bool = messages.setInlineGameScore({edit_message=Bool, force=Bool, id=InputBotInlineMessageID, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v70/methods/messages_setTyping.md b/old_docs/API_docs_v70/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v70/methods/messages_setTyping.md +++ b/old_docs/API_docs_v70/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v70/methods/messages_startBot.md b/old_docs/API_docs_v70/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v70/methods/messages_startBot.md +++ b/old_docs/API_docs_v70/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v70/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v70/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v70/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v70/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v70/methods/messages_toggleDialogPin.md index 14332533..6c57ce0a 100644 --- a/old_docs/API_docs_v70/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v70/methods/messages_toggleDialogPin.md @@ -12,7 +12,7 @@ Pin or unpin dialog | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| @@ -21,13 +21,6 @@ Pin or unpin dialog ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.toggleDialogPin({pinned=Bool, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v70/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v70/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v70/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v70/methods/messages_uploadMedia.md b/old_docs/API_docs_v70/methods/messages_uploadMedia.md index c09da017..4d511a15 100644 --- a/old_docs/API_docs_v70/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v70/methods/messages_uploadMedia.md @@ -21,15 +21,6 @@ Upload a file without sending it to anyone ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|MEDIA_INVALID|Media invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: MessageMedia = messages.uploadMedia({peer=InputPeer, media=InputMedia, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|MEDIA_INVALID|Media invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v70/methods/payments_clearSavedInfo.md index 8b83266f..117db209 100644 --- a/old_docs/API_docs_v70/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v70/methods/payments_clearSavedInfo.md @@ -12,8 +12,8 @@ Clear saved payments info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| +|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/payments_getPaymentForm.md b/old_docs/API_docs_v70/methods/payments_getPaymentForm.md index 3bdb9ff2..f68aa039 100644 --- a/old_docs/API_docs_v70/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v70/methods/payments_getPaymentForm.md @@ -12,7 +12,7 @@ Get payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|msg\_id|[int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) @@ -20,13 +20,6 @@ Get payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentForm = payments.getPaymentForm({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v70/methods/payments_getPaymentReceipt.md index a881aeb7..13073925 100644 --- a/old_docs/API_docs_v70/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v70/methods/payments_getPaymentReceipt.md @@ -12,7 +12,7 @@ Get payment receipt | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|msg\_id|[int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) @@ -20,13 +20,6 @@ Get payment receipt ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentReceipt = payments.getPaymentReceipt({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v70/methods/payments_sendPaymentForm.md index 79758b56..678b749b 100644 --- a/old_docs/API_docs_v70/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v70/methods/payments_sendPaymentForm.md @@ -12,10 +12,10 @@ Bots only: send payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +|msg\_id|[int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) @@ -23,13 +23,6 @@ Bots only: send payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: payments_PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v70/methods/payments_validateRequestedInfo.md index d473f97c..df6a9ba9 100644 --- a/old_docs/API_docs_v70/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v70/methods/payments_validateRequestedInfo.md @@ -12,9 +12,9 @@ Validate requested payment info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +|save|[Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) @@ -22,13 +22,6 @@ Validate requested payment info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: payments_ValidatedRequestedInfo = payments.validateRequestedInfo({save=Bool, msg_id=int, info=PaymentRequestedInfo, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v70/methods/phone_receivedCall.md b/old_docs/API_docs_v70/methods/phone_receivedCall.md index 17095622..6141a0ab 100644 --- a/old_docs/API_docs_v70/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v70/methods/phone_receivedCall.md @@ -12,7 +12,7 @@ Notify server that you received a call (server will refuse all incoming calls un | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| ### Return type: [Bool](../types/Bool.md) @@ -20,14 +20,6 @@ Notify server that you received a call (server will refuse all incoming calls un ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_ALREADY_DECLINED|The call was already declined| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = phone.receivedCall({peer=InputPhoneCall, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_ALREADY_DECLINED|The call was already declined| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v70/methods/phone_saveCallDebug.md b/old_docs/API_docs_v70/methods/phone_saveCallDebug.md index 0ff049a8..9f3daa18 100644 --- a/old_docs/API_docs_v70/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v70/methods/phone_saveCallDebug.md @@ -12,8 +12,8 @@ Save call debugging info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Debugging info| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| +|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Save call debugging info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| -|DATA_JSON_INVALID|The provided JSON data is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = phone.saveCallDebug({peer=InputPhoneCall, debug=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| +|DATA_JSON_INVALID|The provided JSON data is invalid| + + diff --git a/old_docs/API_docs_v70/methods/phone_setCallRating.md b/old_docs/API_docs_v70/methods/phone_setCallRating.md index d0aab7e0..d9833492 100644 --- a/old_docs/API_docs_v70/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v70/methods/phone_setCallRating.md @@ -12,9 +12,9 @@ Set phone call rating | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[CLICK ME int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[CLICK ME string](../types/string.md) | Yes|An optional comment| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| +|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| +|comment|[string](../types/string.md) | Yes|An optional comment| ### Return type: [Updates](../types/Updates.md) @@ -22,13 +22,6 @@ Set phone call rating ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Updates = phone.setCallRating({peer=InputPhoneCall, rating=int, comment='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v70/methods/photos_getUserPhotos.md b/old_docs/API_docs_v70/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v70/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v70/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v70/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v70/methods/photos_uploadProfilePhoto.md index c7ec3063..0c994ffe 100644 --- a/old_docs/API_docs_v70/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v70/methods/photos_uploadProfilePhoto.md @@ -20,16 +20,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -66,3 +56,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v70/methods/ping.md b/old_docs/API_docs_v70/methods/ping.md index f987ae89..daf1cc65 100644 --- a/old_docs/API_docs_v70/methods/ping.md +++ b/old_docs/API_docs_v70/methods/ping.md @@ -12,7 +12,7 @@ pings the server | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v70/methods/ping_delay_disconnect.md b/old_docs/API_docs_v70/methods/ping_delay_disconnect.md index 5b1c115d..66cc3704 100644 --- a/old_docs/API_docs_v70/methods/ping_delay_disconnect.md +++ b/old_docs/API_docs_v70/methods/ping_delay_disconnect.md @@ -12,8 +12,8 @@ Pings the server and causes disconection if the same method is not called within | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[CLICK ME int](../types/int.md) | Yes|Disconection delay| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| +|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v70/methods/req_DH_params.md b/old_docs/API_docs_v70/methods/req_DH_params.md index f0b45851..a426c699 100644 --- a/old_docs/API_docs_v70/methods/req_DH_params.md +++ b/old_docs/API_docs_v70/methods/req_DH_params.md @@ -12,12 +12,12 @@ Requests Diffie-hellman parameters for key exchange | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[CLICK ME string](../types/string.md) | Yes|factorized p from pq| -|q|[CLICK ME string](../types/string.md) | Yes|factorized q from pq| -|public\_key\_fingerprint|[CLICK ME long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[CLICK ME string](../types/string.md) | Yes|Encrypted message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|p|[string](../types/string.md) | Yes|factorized p from pq| +|q|[string](../types/string.md) | Yes|factorized q from pq| +|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| +|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/old_docs/API_docs_v70/methods/req_pq.md b/old_docs/API_docs_v70/methods/req_pq.md index 0873d9a2..d273a0b9 100644 --- a/old_docs/API_docs_v70/methods/req_pq.md +++ b/old_docs/API_docs_v70/methods/req_pq.md @@ -12,7 +12,7 @@ Requests PQ for factorization | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/old_docs/API_docs_v70/methods/rpc_drop_answer.md b/old_docs/API_docs_v70/methods/rpc_drop_answer.md index 27f98bca..34b355f3 100644 --- a/old_docs/API_docs_v70/methods/rpc_drop_answer.md +++ b/old_docs/API_docs_v70/methods/rpc_drop_answer.md @@ -12,7 +12,7 @@ Do not send answer to provided request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|req\_msg\_id|[CLICK ME long](../types/long.md) | Yes|The message ID of the request| +|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/old_docs/API_docs_v70/methods/set_client_DH_params.md b/old_docs/API_docs_v70/methods/set_client_DH_params.md index cf8ab321..5a173688 100644 --- a/old_docs/API_docs_v70/methods/set_client_DH_params.md +++ b/old_docs/API_docs_v70/methods/set_client_DH_params.md @@ -12,9 +12,9 @@ Sets client diffie-hellman parameters | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[CLICK ME string](../types/string.md) | Yes|Encrypted message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/old_docs/API_docs_v70/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v70/methods/stickers_addStickerToSet.md index 7c4191d8..6e1d680c 100644 --- a/old_docs/API_docs_v70/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v70/methods/stickers_addStickerToSet.md @@ -12,8 +12,8 @@ Add sticker to stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -21,14 +21,6 @@ Add sticker to stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.addStickerToSet({stickerset=InputStickerSet, sticker=InputStickerSetItem, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v70/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v70/methods/stickers_changeStickerPosition.md index d25129c5..6e8e2505 100644 --- a/old_docs/API_docs_v70/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v70/methods/stickers_changeStickerPosition.md @@ -13,7 +13,7 @@ Change sticker position in photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[CLICK ME int](../types/int.md) | Yes|New position| +|position|[int](../types/int.md) | Yes|New position| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -21,14 +21,6 @@ Change sticker position in photo ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKER_INVALID|The provided sticker is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.changeStickerPosition({sticker=InputDocument, position=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v70/methods/stickers_createStickerSet.md b/old_docs/API_docs_v70/methods/stickers_createStickerSet.md index 95775849..371033ca 100644 --- a/old_docs/API_docs_v70/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v70/methods/stickers_createStickerSet.md @@ -12,11 +12,11 @@ Create stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Masks?| +|masks|[Bool](../types/Bool.md) | Optional|Masks?| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[CLICK ME string](../types/string.md) | Yes|The stickerset title| -|short\_name|[CLICK ME string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +|title|[string](../types/string.md) | Yes|The stickerset title| +|short\_name|[string](../types/string.md) | Yes|The stickerset short name| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -24,21 +24,6 @@ Create stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|PACK_SHORT_NAME_INVALID|Short pack name invalid| -|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| -|PEER_ID_INVALID|The provided peer id is invalid| -|STICKER_EMOJI_INVALID|Sticker emoji invalid| -|STICKER_FILE_INVALID|Sticker file invalid| -|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| -|STICKERS_EMPTY|No sticker provided| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -92,3 +77,18 @@ Or, if you're into Lua: messages_StickerSet = stickers.createStickerSet({masks=Bool, user_id=InputUser, title='string', short_name='string', stickers={InputStickerSetItem}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|PACK_SHORT_NAME_INVALID|Short pack name invalid| +|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| +|PEER_ID_INVALID|The provided peer id is invalid| +|STICKER_EMOJI_INVALID|Sticker emoji invalid| +|STICKER_FILE_INVALID|Sticker file invalid| +|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| +|STICKERS_EMPTY|No sticker provided| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v70/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v70/methods/stickers_removeStickerFromSet.md index 73ed78d5..5e3a4291 100644 --- a/old_docs/API_docs_v70/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v70/methods/stickers_removeStickerFromSet.md @@ -20,14 +20,6 @@ Remove sticker from stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKER_INVALID|The provided sticker is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.removeStickerFromSet({sticker=InputDocument, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v70/methods/upload_getWebFile.md b/old_docs/API_docs_v70/methods/upload_getWebFile.md index 11634633..f869519a 100644 --- a/old_docs/API_docs_v70/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v70/methods/upload_getWebFile.md @@ -12,9 +12,9 @@ Download a file through telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[int](../types/int.md) | Yes|The offset in bytes| +|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) @@ -22,13 +22,6 @@ Download a file through telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LOCATION_INVALID|The provided location is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: upload_WebFile = upload.getWebFile({location=InputWebFileLocation, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LOCATION_INVALID|The provided location is invalid| + + diff --git a/old_docs/API_docs_v70/methods/users_getUsers.md b/old_docs/API_docs_v70/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v70/methods/users_getUsers.md +++ b/old_docs/API_docs_v70/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/account_changePhone.md b/old_docs/API_docs_v71/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v71/methods/account_changePhone.md +++ b/old_docs/API_docs_v71/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_checkUsername.md b/old_docs/API_docs_v71/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v71/methods/account_checkUsername.md +++ b/old_docs/API_docs_v71/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v71/methods/account_confirmPhone.md b/old_docs/API_docs_v71/methods/account_confirmPhone.md index 68490f35..7ffabc24 100644 --- a/old_docs/API_docs_v71/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v71/methods/account_confirmPhone.md @@ -12,8 +12,8 @@ Confirm this phone number is associated to this account, obtain phone_code_hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| +|phone\_code\_hash|[string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Confirm this phone number is associated to this account, obtain phone_code_hash ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_HASH_INVALID|Code hash invalid| -|PHONE_CODE_EMPTY|phone_code is missing| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_HASH_INVALID|Code hash invalid| +|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/old_docs/API_docs_v71/methods/account_deleteAccount.md b/old_docs/API_docs_v71/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v71/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v71/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/account_getNotifySettings.md b/old_docs/API_docs_v71/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v71/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v71/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_getPasswordSettings.md b/old_docs/API_docs_v71/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v71/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v71/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_getPrivacy.md b/old_docs/API_docs_v71/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v71/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v71/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_getTmpPassword.md b/old_docs/API_docs_v71/methods/account_getTmpPassword.md index 01b1ebfc..c82ff37a 100644 --- a/old_docs/API_docs_v71/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v71/methods/account_getTmpPassword.md @@ -12,8 +12,8 @@ Get temporary password for buying products through bots | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|The password hash| -|period|[CLICK ME int](../types/int.md) | Yes|The validity period| +|password\_hash|[bytes](../types/bytes.md) | Yes|The password hash| +|period|[int](../types/int.md) | Yes|The validity period| ### Return type: [account\_TmpPassword](../types/account_TmpPassword.md) @@ -21,14 +21,6 @@ Get temporary password for buying products through bots ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| -|TMP_PASSWORD_DISABLED|The temporary password is disabled| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: account_TmpPassword = account.getTmpPassword({password_hash='bytes', period=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|TMP_PASSWORD_DISABLED|The temporary password is disabled| + + diff --git a/old_docs/API_docs_v71/methods/account_registerDevice.md b/old_docs/API_docs_v71/methods/account_registerDevice.md index 4e148a7f..cbac71d3 100644 --- a/old_docs/API_docs_v71/methods/account_registerDevice.md +++ b/old_docs/API_docs_v71/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_reportPeer.md b/old_docs/API_docs_v71/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v71/methods/account_reportPeer.md +++ b/old_docs/API_docs_v71/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_resetAuthorization.md b/old_docs/API_docs_v71/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v71/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v71/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v71/methods/account_sendChangePhoneCode.md index bdf7331f..476b6d79 100644 --- a/old_docs/API_docs_v71/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v71/methods/account_sendChangePhoneCode.md @@ -12,9 +12,9 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|Current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v71/methods/account_sendConfirmPhoneCode.md index 86035d19..8917355f 100644 --- a/old_docs/API_docs_v71/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v71/methods/account_sendConfirmPhoneCode.md @@ -12,9 +12,9 @@ Send confirmation phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| -|hash|[CLICK ME string](../types/string.md) | Yes|The hash| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|The current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| +|hash|[string](../types/string.md) | Yes|The hash| +|current\_number|[Bool](../types/Bool.md) | Optional|The current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Send confirmation phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendConfirmPhoneCode({allow_flashcall=Bool, hash='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_setAccountTTL.md b/old_docs/API_docs_v71/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v71/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v71/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_setPrivacy.md b/old_docs/API_docs_v71/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v71/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v71/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_unregisterDevice.md b/old_docs/API_docs_v71/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v71/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v71/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v71/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v71/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v71/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/account_updateNotifySettings.md b/old_docs/API_docs_v71/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v71/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v71/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v71/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v71/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v71/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_updateProfile.md b/old_docs/API_docs_v71/methods/account_updateProfile.md index 59629188..ef19dc00 100644 --- a/old_docs/API_docs_v71/methods/account_updateProfile.md +++ b/old_docs/API_docs_v71/methods/account_updateProfile.md @@ -12,9 +12,9 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Optional|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Optional|The last name| -|about|[CLICK ME string](../types/string.md) | Optional|The bio/about field| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| ### Return type: [User](../types/User.md) @@ -22,14 +22,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v71/methods/account_updateStatus.md b/old_docs/API_docs_v71/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v71/methods/account_updateStatus.md +++ b/old_docs/API_docs_v71/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v71/methods/account_updateUsername.md b/old_docs/API_docs_v71/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v71/methods/account_updateUsername.md +++ b/old_docs/API_docs_v71/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v71/methods/auth_cancelCode.md b/old_docs/API_docs_v71/methods/auth_cancelCode.md index 52b85d4c..84401c62 100644 --- a/old_docs/API_docs_v71/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v71/methods/auth_cancelCode.md @@ -12,8 +12,8 @@ Invalidate sent phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invalidate sent phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v71/methods/auth_checkPhone.md b/old_docs/API_docs_v71/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v71/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v71/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v71/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v71/methods/auth_dropTempAuthKeys.md index 5aa98b3b..537afbc1 100644 --- a/old_docs/API_docs_v71/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v71/methods/auth_dropTempAuthKeys.md @@ -12,7 +12,7 @@ Delete all temporary authorization keys except the ones provided | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_auth\_keys|Array of [CLICK ME long](../types/long.md) | Yes|The temporary authorization keys to keep| +|except\_auth\_keys|Array of [long](../types/long.md) | Yes|The temporary authorization keys to keep| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/auth_recoverPassword.md b/old_docs/API_docs_v71/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v71/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v71/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v71/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v71/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v71/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v71/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v71/methods/auth_resendCode.md b/old_docs/API_docs_v71/methods/auth_resendCode.md index 253480a3..4402bfe6 100644 --- a/old_docs/API_docs_v71/methods/auth_resendCode.md +++ b/old_docs/API_docs_v71/methods/auth_resendCode.md @@ -12,8 +12,8 @@ Resend the SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -21,13 +21,6 @@ Resend the SMS verification code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v71/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v71/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v71/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v71/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/auth_sendInvites.md b/old_docs/API_docs_v71/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v71/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v71/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v71/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v71/methods/bots_answerWebhookJSONQuery.md index 40cb0477..3dbf62ef 100644 --- a/old_docs/API_docs_v71/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v71/methods/bots_answerWebhookJSONQuery.md @@ -12,8 +12,8 @@ Send webhook request via bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|data|[DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Send webhook request via bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Bool = bots.answerWebhookJSONQuery({query_id=long, data=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v71/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v71/methods/bots_sendCustomRequest.md index 5a7f4e86..cb7c32e2 100644 --- a/old_docs/API_docs_v71/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v71/methods/bots_sendCustomRequest.md @@ -12,8 +12,8 @@ Send a custom request to the bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| +|custom\_method|[string](../types/string.md) | Yes|The method to call| +|params|[DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) @@ -21,13 +21,6 @@ Send a custom request to the bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: DataJSON = bots.sendCustomRequest({custom_method='string', params=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v71/methods/channels_checkUsername.md b/old_docs/API_docs_v71/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v71/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v71/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v71/methods/channels_createChannel.md b/old_docs/API_docs_v71/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v71/methods/channels_createChannel.md +++ b/old_docs/API_docs_v71/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v71/methods/channels_deleteChannel.md b/old_docs/API_docs_v71/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v71/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v71/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v71/methods/channels_deleteMessages.md b/old_docs/API_docs_v71/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v71/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v71/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v71/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v71/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v71/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v71/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v71/methods/channels_editAbout.md b/old_docs/API_docs_v71/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v71/methods/channels_editAbout.md +++ b/old_docs/API_docs_v71/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v71/methods/channels_editAdmin.md b/old_docs/API_docs_v71/methods/channels_editAdmin.md index 7cecbd64..f08473eb 100644 --- a/old_docs/API_docs_v71/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v71/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| +|admin\_rights|[ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, admin_rights=ChannelAdminRights, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v71/methods/channels_editBanned.md b/old_docs/API_docs_v71/methods/channels_editBanned.md index ca9f2596..03dc70a5 100644 --- a/old_docs/API_docs_v71/methods/channels_editBanned.md +++ b/old_docs/API_docs_v71/methods/channels_editBanned.md @@ -14,7 +14,7 @@ Kick or ban a user from a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban| -|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| +|banned\_rights|[ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| ### Return type: [Updates](../types/Updates.md) @@ -22,17 +22,6 @@ Kick or ban a user from a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ADMIN_INVALID|You're not an admin| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +71,14 @@ Or, if you're into Lua: Updates = channels.editBanned({channel=InputChannel, user_id=InputUser, banned_rights=ChannelBannedRights, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ADMIN_INVALID|You're not an admin| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v71/methods/channels_editPhoto.md b/old_docs/API_docs_v71/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v71/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v71/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v71/methods/channels_editTitle.md b/old_docs/API_docs_v71/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v71/methods/channels_editTitle.md +++ b/old_docs/API_docs_v71/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v71/methods/channels_exportInvite.md b/old_docs/API_docs_v71/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v71/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v71/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v71/methods/channels_exportMessageLink.md b/old_docs/API_docs_v71/methods/channels_exportMessageLink.md index b4a3c645..20f6e998 100644 --- a/old_docs/API_docs_v71/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v71/methods/channels_exportMessageLink.md @@ -13,7 +13,7 @@ Get the link of a message in a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| +|id|[int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -21,13 +21,6 @@ Get the link of a message in a channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v71/methods/channels_getAdminLog.md b/old_docs/API_docs_v71/methods/channels_getAdminLog.md index 4a419778..1ffcf5c3 100644 --- a/old_docs/API_docs_v71/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v71/methods/channels_getAdminLog.md @@ -13,12 +13,12 @@ Get admin log of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|q|[CLICK ME string](../types/string.md) | Yes|Search query| -|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| +|q|[string](../types/string.md) | Yes|Search query| +|events\_filter|[ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| |admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME long](../types/long.md) | Yes|Minimum message ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[long](../types/long.md) | Yes|Maximum message ID to fetch| +|min\_id|[long](../types/long.md) | Yes|Minimum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) @@ -26,15 +26,6 @@ Get admin log of a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -83,3 +74,12 @@ Or, if you're into Lua: channels_AdminLogResults = channels.getAdminLog({channel=InputChannel, q='string', events_filter=ChannelAdminLogEventsFilter, admins={InputUser}, max_id=long, min_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v71/methods/channels_getChannels.md b/old_docs/API_docs_v71/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v71/methods/channels_getChannels.md +++ b/old_docs/API_docs_v71/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v71/methods/channels_getMessages.md b/old_docs/API_docs_v71/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v71/methods/channels_getMessages.md +++ b/old_docs/API_docs_v71/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v71/methods/channels_getParticipant.md b/old_docs/API_docs_v71/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v71/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v71/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v71/methods/channels_getParticipants.md b/old_docs/API_docs_v71/methods/channels_getParticipants.md index 6a27016b..bc5bd7f4 100644 --- a/old_docs/API_docs_v71/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v71/methods/channels_getParticipants.md @@ -13,9 +13,9 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -23,17 +23,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -85,3 +74,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/channels_inviteToChannel.md b/old_docs/API_docs_v71/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v71/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v71/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v71/methods/channels_joinChannel.md b/old_docs/API_docs_v71/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v71/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v71/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v71/methods/channels_leaveChannel.md b/old_docs/API_docs_v71/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v71/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v71/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v71/methods/channels_readHistory.md b/old_docs/API_docs_v71/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v71/methods/channels_readHistory.md +++ b/old_docs/API_docs_v71/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v71/methods/channels_readMessageContents.md b/old_docs/API_docs_v71/methods/channels_readMessageContents.md index aa9893c2..912adfcf 100644 --- a/old_docs/API_docs_v71/methods/channels_readMessageContents.md +++ b/old_docs/API_docs_v71/methods/channels_readMessageContents.md @@ -13,7 +13,7 @@ Mark channel/supergroup messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|id|Array of [CLICK ME int](../types/int.md) | Yes|List of message IDs| +|id|Array of [int](../types/int.md) | Yes|List of message IDs| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readMessageContents({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v71/methods/channels_reportSpam.md b/old_docs/API_docs_v71/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v71/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v71/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v71/methods/channels_setStickers.md b/old_docs/API_docs_v71/methods/channels_setStickers.md index d9be32a4..b5142d9f 100644 --- a/old_docs/API_docs_v71/methods/channels_setStickers.md +++ b/old_docs/API_docs_v71/methods/channels_setStickers.md @@ -13,7 +13,7 @@ Set the supergroup/channel stickerpack | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergoup| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Set the supergroup/channel stickerpack ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PARTICIPANTS_TOO_FEW|Not enough participants| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Bool = channels.setStickers({channel=InputChannel, stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PARTICIPANTS_TOO_FEW|Not enough participants| + + diff --git a/old_docs/API_docs_v71/methods/channels_toggleInvites.md b/old_docs/API_docs_v71/methods/channels_toggleInvites.md index e9e6450d..d437682f 100644 --- a/old_docs/API_docs_v71/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v71/methods/channels_toggleInvites.md @@ -13,7 +13,7 @@ Allow or disallow any user to invite users to this channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Allow or disallow any user to invite users to this channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v71/methods/channels_toggleSignatures.md b/old_docs/API_docs_v71/methods/channels_toggleSignatures.md index 36d1eccb..d40bf67b 100644 --- a/old_docs/API_docs_v71/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v71/methods/channels_toggleSignatures.md @@ -13,7 +13,7 @@ Toggle channel signatures | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Toggle channel signatures ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v71/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v71/methods/channels_updatePinnedMessage.md index f8d10ece..aa2cc783 100644 --- a/old_docs/API_docs_v71/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v71/methods/channels_updatePinnedMessage.md @@ -12,9 +12,9 @@ Set the pinned message of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Set the pinned message of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -81,3 +71,13 @@ Or, if you're into Lua: Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v71/methods/channels_updateUsername.md b/old_docs/API_docs_v71/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v71/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v71/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v71/methods/contacts_block.md b/old_docs/API_docs_v71/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v71/methods/contacts_block.md +++ b/old_docs/API_docs_v71/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v71/methods/contacts_deleteContact.md b/old_docs/API_docs_v71/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v71/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v71/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v71/methods/contacts_deleteContacts.md b/old_docs/API_docs_v71/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v71/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v71/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/contacts_getBlocked.md b/old_docs/API_docs_v71/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v71/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v71/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v71/methods/contacts_getContacts.md b/old_docs/API_docs_v71/methods/contacts_getContacts.md index 589572dc..25085a19 100644 --- a/old_docs/API_docs_v71/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v71/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|$ids is the list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`| +|hash|[int](../types/int.md) | Yes|$ids is the list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v71/methods/contacts_getTopPeers.md b/old_docs/API_docs_v71/methods/contacts_getTopPeers.md index 4958e6b2..a8cd4c57 100644 --- a/old_docs/API_docs_v71/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v71/methods/contacts_getTopPeers.md @@ -12,15 +12,15 @@ Get most used chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|correspondents|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch users?| -|bots\_pm|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch bots?| -|bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| -|phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?| -|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| -|channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| +|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?| +|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?| +|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?| +|phone\_calls|[Bool](../types/Bool.md) | Optional|Fetch phone calls?| +|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?| +|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| +|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|limit|[int](../types/int.md) | Yes|How many results to fetch| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| ### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) @@ -28,13 +28,6 @@ Get most used chats ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TYPES_EMPTY|The types field is empty| - - ### MadelineProto Example: @@ -87,3 +80,10 @@ Or, if you're into Lua: contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, phone_calls=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field is empty| + + diff --git a/old_docs/API_docs_v71/methods/contacts_importCard.md b/old_docs/API_docs_v71/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v71/methods/contacts_importCard.md +++ b/old_docs/API_docs_v71/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v71/methods/contacts_importContacts.md b/old_docs/API_docs_v71/methods/contacts_importContacts.md index ccc0eada..5b07237e 100644 --- a/old_docs/API_docs_v71/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v71/methods/contacts_importContacts.md @@ -12,7 +12,7 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v71/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v71/methods/contacts_resetTopPeerRating.md index 4b5e96f1..15b07f96 100644 --- a/old_docs/API_docs_v71/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v71/methods/contacts_resetTopPeerRating.md @@ -12,7 +12,7 @@ Reset top peer rating for a certain category/peer | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| @@ -21,13 +21,6 @@ Reset top peer rating for a certain category/peer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/contacts_search.md b/old_docs/API_docs_v71/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v71/methods/contacts_search.md +++ b/old_docs/API_docs_v71/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/contacts_unblock.md b/old_docs/API_docs_v71/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v71/methods/contacts_unblock.md +++ b/old_docs/API_docs_v71/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v71/methods/contest_saveDeveloperInfo.md b/old_docs/API_docs_v71/methods/contest_saveDeveloperInfo.md index 5d82a4be..de23c472 100644 --- a/old_docs/API_docs_v71/methods/contest_saveDeveloperInfo.md +++ b/old_docs/API_docs_v71/methods/contest_saveDeveloperInfo.md @@ -12,11 +12,11 @@ Save developer info for telegram contest | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|vk\_id|[CLICK ME int](../types/int.md) | Yes|VK user ID| -|name|[CLICK ME string](../types/string.md) | Yes|Name| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|age|[CLICK ME int](../types/int.md) | Yes|Age| -|city|[CLICK ME string](../types/string.md) | Yes|City| +|vk\_id|[int](../types/int.md) | Yes|VK user ID| +|name|[string](../types/string.md) | Yes|Name| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|age|[int](../types/int.md) | Yes|Age| +|city|[string](../types/string.md) | Yes|City| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/destroy_session.md b/old_docs/API_docs_v71/methods/destroy_session.md index b74fbd11..c4187ce0 100644 --- a/old_docs/API_docs_v71/methods/destroy_session.md +++ b/old_docs/API_docs_v71/methods/destroy_session.md @@ -12,7 +12,7 @@ Destroy the current MTProto session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|session\_id|[CLICK ME long](../types/long.md) | Yes|The session to destroy| +|session\_id|[long](../types/long.md) | Yes|The session to destroy| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/old_docs/API_docs_v71/methods/get_future_salts.md b/old_docs/API_docs_v71/methods/get_future_salts.md index e8451015..7f5fc18c 100644 --- a/old_docs/API_docs_v71/methods/get_future_salts.md +++ b/old_docs/API_docs_v71/methods/get_future_salts.md @@ -12,7 +12,7 @@ Get future salts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|num|[CLICK ME int](../types/int.md) | Yes|How many salts should be fetched| +|num|[int](../types/int.md) | Yes|How many salts should be fetched| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/old_docs/API_docs_v71/methods/help_getAppChangelog.md b/old_docs/API_docs_v71/methods/help_getAppChangelog.md index eda473a6..183ebb8c 100644 --- a/old_docs/API_docs_v71/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v71/methods/help_getAppChangelog.md @@ -12,7 +12,7 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| +|prev\_app\_version|[string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/help_getCdnConfig.md b/old_docs/API_docs_v71/methods/help_getCdnConfig.md index b98949ed..b7af5bb4 100644 --- a/old_docs/API_docs_v71/methods/help_getCdnConfig.md +++ b/old_docs/API_docs_v71/methods/help_getCdnConfig.md @@ -15,13 +15,6 @@ Get CDN configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: CdnConfig = help.getCdnConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/help_getConfig.md b/old_docs/API_docs_v71/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v71/methods/help_getConfig.md +++ b/old_docs/API_docs_v71/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/help_saveAppLog.md b/old_docs/API_docs_v71/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v71/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v71/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v71/methods/help_setBotUpdatesStatus.md index a1a3ab1b..1766ee14 100644 --- a/old_docs/API_docs_v71/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v71/methods/help_setBotUpdatesStatus.md @@ -12,8 +12,8 @@ Set the update status of webhook | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| -|message|[CLICK ME string](../types/string.md) | Yes|Message| +|pending\_updates\_count|[int](../types/int.md) | Yes|Pending update count| +|message|[string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/initConnection.md b/old_docs/API_docs_v71/methods/initConnection.md index c66aa8b1..2d195613 100644 --- a/old_docs/API_docs_v71/methods/initConnection.md +++ b/old_docs/API_docs_v71/methods/initConnection.md @@ -12,14 +12,14 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|system\_lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| -|lang\_pack|[CLICK ME string](../types/string.md) | Yes|Language pack to use| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|system\_lang\_code|[string](../types/string.md) | Yes|Language code| +|lang\_pack|[string](../types/string.md) | Yes|Language pack to use| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -27,14 +27,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -94,3 +86,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', system_lang_code='string', lang_pack='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v71/methods/invokeAfterMsg.md b/old_docs/API_docs_v71/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v71/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v71/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v71/methods/invokeAfterMsgs.md b/old_docs/API_docs_v71/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v71/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v71/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v71/methods/invokeWithLayer.md b/old_docs/API_docs_v71/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v71/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v71/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v71/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v71/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v71/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v71/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v71/methods/langpack_getDifference.md b/old_docs/API_docs_v71/methods/langpack_getDifference.md index 0a6512e4..1860cc49 100644 --- a/old_docs/API_docs_v71/methods/langpack_getDifference.md +++ b/old_docs/API_docs_v71/methods/langpack_getDifference.md @@ -12,7 +12,7 @@ Get language pack updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|from\_version|[CLICK ME int](../types/int.md) | Yes|Previous version| +|from\_version|[int](../types/int.md) | Yes|Previous version| ### Return type: [LangPackDifference](../types/LangPackDifference.md) @@ -20,13 +20,6 @@ Get language pack updates ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: LangPackDifference = langpack.getDifference({from_version=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v71/methods/langpack_getLangPack.md b/old_docs/API_docs_v71/methods/langpack_getLangPack.md index 45a9ca47..7e64aec9 100644 --- a/old_docs/API_docs_v71/methods/langpack_getLangPack.md +++ b/old_docs/API_docs_v71/methods/langpack_getLangPack.md @@ -12,7 +12,7 @@ Get language pack | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [LangPackDifference](../types/LangPackDifference.md) @@ -20,13 +20,6 @@ Get language pack ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: LangPackDifference = langpack.getLangPack({lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v71/methods/langpack_getLanguages.md b/old_docs/API_docs_v71/methods/langpack_getLanguages.md index b573a5eb..c4ea44ca 100644 --- a/old_docs/API_docs_v71/methods/langpack_getLanguages.md +++ b/old_docs/API_docs_v71/methods/langpack_getLanguages.md @@ -15,13 +15,6 @@ Get available languages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Vector_of_LangPackLanguage = langpack.getLanguages({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v71/methods/langpack_getStrings.md b/old_docs/API_docs_v71/methods/langpack_getStrings.md index 841b02db..4953e1c0 100644 --- a/old_docs/API_docs_v71/methods/langpack_getStrings.md +++ b/old_docs/API_docs_v71/methods/langpack_getStrings.md @@ -12,8 +12,8 @@ Get language pack strings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| -|keys|Array of [CLICK ME string](../types/string.md) | Yes|Keys| +|lang\_code|[string](../types/string.md) | Yes|Language code| +|keys|Array of [string](../types/string.md) | Yes|Keys| ### Return type: [Vector\_of\_LangPackString](../types/LangPackString.md) @@ -21,13 +21,6 @@ Get language pack strings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Vector_of_LangPackString = langpack.getStrings({lang_code='string', keys={'string'}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_addChatUser.md b/old_docs/API_docs_v71/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v71/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v71/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v71/methods/messages_checkChatInvite.md b/old_docs/API_docs_v71/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v71/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v71/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v71/methods/messages_clearRecentStickers.md index 1d6ec8c9..72c4844b 100644 --- a/old_docs/API_docs_v71/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v71/methods/messages_clearRecentStickers.md @@ -12,7 +12,7 @@ Clear all recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_createChat.md b/old_docs/API_docs_v71/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v71/methods/messages_createChat.md +++ b/old_docs/API_docs_v71/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v71/methods/messages_deleteChatUser.md b/old_docs/API_docs_v71/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v71/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v71/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v71/methods/messages_deleteHistory.md b/old_docs/API_docs_v71/methods/messages_deleteHistory.md index 45e9890d..601d1876 100644 --- a/old_docs/API_docs_v71/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v71/methods/messages_deleteHistory.md @@ -12,9 +12,9 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|just\_clear|[CLICK ME Bool](../types/Bool.md) | Optional|Only clear it from your side| +|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,13 +22,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_deleteMessages.md b/old_docs/API_docs_v71/methods/messages_deleteMessages.md index c8670444..900e9d0e 100644 --- a/old_docs/API_docs_v71/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v71/methods/messages_deleteMessages.md @@ -12,8 +12,8 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|revoke|[CLICK ME Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,13 +21,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({revoke=Bool, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v71/methods/messages_editChatAdmin.md b/old_docs/API_docs_v71/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v71/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v71/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_editChatPhoto.md b/old_docs/API_docs_v71/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v71/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v71/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_editChatTitle.md b/old_docs/API_docs_v71/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v71/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v71/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v71/methods/messages_editInlineBotMessage.md index 73c8a2c4..4729b52a 100644 --- a/old_docs/API_docs_v71/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v71/methods/messages_editInlineBotMessage.md @@ -12,11 +12,11 @@ Edit a sent inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,14 +25,6 @@ Edit a sent inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| - - ### MadelineProto Example: @@ -120,3 +112,11 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v71/methods/messages_editMessage.md b/old_docs/API_docs_v71/methods/messages_editMessage.md index ad639325..4380aba6 100644 --- a/old_docs/API_docs_v71/methods/messages_editMessage.md +++ b/old_docs/API_docs_v71/methods/messages_editMessage.md @@ -12,12 +12,12 @@ Edit a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -26,22 +26,6 @@ Edit a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -129,3 +113,19 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v71/methods/messages_exportChatInvite.md b/old_docs/API_docs_v71/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v71/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v71/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_faveSticker.md b/old_docs/API_docs_v71/methods/messages_faveSticker.md index ee1eb66a..8b1534ea 100644 --- a/old_docs/API_docs_v71/methods/messages_faveSticker.md +++ b/old_docs/API_docs_v71/methods/messages_faveSticker.md @@ -13,7 +13,7 @@ Add a sticker to favorites | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| -|unfave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove it from favorites?| +|unfave|[Bool](../types/Bool.md) | Yes|Remove it from favorites?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker to favorites ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.faveSticker({id=InputDocument, unfave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_forwardMessage.md b/old_docs/API_docs_v71/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v71/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v71/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v71/methods/messages_forwardMessages.md b/old_docs/API_docs_v71/methods/messages_forwardMessages.md index b99e1d31..2a0455e4 100644 --- a/old_docs/API_docs_v71/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v71/methods/messages_forwardMessages.md @@ -12,11 +12,11 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[CLICK ME Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| +|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -25,34 +25,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -108,3 +80,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/messages_getAllChats.md b/old_docs/API_docs_v71/methods/messages_getAllChats.md index 513fc06f..c4851369 100644 --- a/old_docs/API_docs_v71/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v71/methods/messages_getAllChats.md @@ -12,7 +12,7 @@ Get all chats (not supergroups or channels) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v71/methods/messages_getAllStickers.md b/old_docs/API_docs_v71/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v71/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v71/methods/messages_getArchivedStickers.md index ee36b542..dfd5c006 100644 --- a/old_docs/API_docs_v71/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getArchivedStickers.md @@ -12,9 +12,9 @@ Get all archived stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| +|masks|[Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| +|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v71/methods/messages_getAttachedStickers.md index 9f8a66c5..8f51f38d 100644 --- a/old_docs/API_docs_v71/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getAttachedStickers.md @@ -12,7 +12,7 @@ Get stickers attachable to images | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v71/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v71/methods/messages_getBotCallbackAnswer.md index 0136227f..4b8887ad 100644 --- a/old_docs/API_docs_v71/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v71/methods/messages_getBotCallbackAnswer.md @@ -12,10 +12,10 @@ Get the callback answer of a bot (after clicking a button) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|game|[Bool](../types/Bool.md) | Optional|Is this a game?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) @@ -23,17 +23,6 @@ Get the callback answer of a bot (after clicking a button) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|DATA_INVALID|Encrypted data invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: messages_BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/messages_getChats.md b/old_docs/API_docs_v71/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v71/methods/messages_getChats.md +++ b/old_docs/API_docs_v71/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_getCommonChats.md b/old_docs/API_docs_v71/methods/messages_getCommonChats.md index 15ed6713..6ffa0948 100644 --- a/old_docs/API_docs_v71/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v71/methods/messages_getCommonChats.md @@ -13,8 +13,8 @@ Get chats in common with a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -22,13 +22,6 @@ Get chats in common with a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_Chats = messages.getCommonChats({user_id=InputUser, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_getDialogs.md b/old_docs/API_docs_v71/methods/messages_getDialogs.md index 53f9ac62..1035e8ce 100644 --- a/old_docs/API_docs_v71/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v71/methods/messages_getDialogs.md @@ -12,11 +12,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|exclude\_pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -24,16 +24,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v71/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v71/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v71/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_getFavedStickers.md b/old_docs/API_docs_v71/methods/messages_getFavedStickers.md index 8ef3e565..dea1e5ec 100644 --- a/old_docs/API_docs_v71/methods/messages_getFavedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getFavedStickers.md @@ -12,7 +12,7 @@ Get favorite stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v71/methods/messages_getFeaturedStickers.md index 8e49e1ef..af7f69a0 100644 --- a/old_docs/API_docs_v71/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getFeaturedStickers.md @@ -12,7 +12,7 @@ Get featured stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getGameHighScores.md b/old_docs/API_docs_v71/methods/messages_getGameHighScores.md index 113e4647..af3f3915 100644 --- a/old_docs/API_docs_v71/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v71/methods/messages_getGameHighScores.md @@ -13,7 +13,7 @@ Get high scores of a game | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -22,14 +22,6 @@ Get high scores of a game ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -79,3 +71,11 @@ Or, if you're into Lua: messages_HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v71/methods/messages_getHistory.md b/old_docs/API_docs_v71/methods/messages_getHistory.md index 851d2680..86a744cf 100644 --- a/old_docs/API_docs_v71/methods/messages_getHistory.md +++ b/old_docs/API_docs_v71/methods/messages_getHistory.md @@ -13,12 +13,12 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -26,18 +26,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v71/methods/messages_getInlineBotResults.md index 4d86caf5..207624a7 100644 --- a/old_docs/API_docs_v71/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v71/methods/messages_getInlineBotResults.md @@ -14,9 +14,9 @@ Call inline bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -24,16 +24,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v71/methods/messages_getInlineGameHighScores.md index d5a80005..e03bc273 100644 --- a/old_docs/API_docs_v71/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v71/methods/messages_getInlineGameHighScores.md @@ -12,7 +12,7 @@ Get high scores of a game sent in an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -21,14 +21,6 @@ Get high scores of a game sent in an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v71/methods/messages_getMaskStickers.md b/old_docs/API_docs_v71/methods/messages_getMaskStickers.md index 70e2e6d4..1fbd9346 100644 --- a/old_docs/API_docs_v71/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getMaskStickers.md @@ -12,7 +12,7 @@ Get masks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getMessageEditData.md b/old_docs/API_docs_v71/methods/messages_getMessageEditData.md index 34f8534f..00c63d28 100644 --- a/old_docs/API_docs_v71/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v71/methods/messages_getMessageEditData.md @@ -13,7 +13,7 @@ Check if about to edit a message or a media caption | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) @@ -21,14 +21,6 @@ Check if about to edit a message or a media caption ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v71/methods/messages_getMessages.md b/old_docs/API_docs_v71/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v71/methods/messages_getMessages.md +++ b/old_docs/API_docs_v71/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v71/methods/messages_getMessagesViews.md b/old_docs/API_docs_v71/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v71/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v71/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v71/methods/messages_getPeerDialogs.md index 063b6e7d..000e8eb6 100644 --- a/old_docs/API_docs_v71/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v71/methods/messages_getPeerDialogs.md @@ -20,14 +20,6 @@ Get dialog info of peers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: messages_PeerDialogs = messages.getPeerDialogs({peers={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_getPeerSettings.md b/old_docs/API_docs_v71/methods/messages_getPeerSettings.md index a18126f0..5a3e9349 100644 --- a/old_docs/API_docs_v71/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v71/methods/messages_getPeerSettings.md @@ -20,14 +20,6 @@ Get the settings of apeer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: PeerSettings = messages.getPeerSettings({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_getRecentStickers.md b/old_docs/API_docs_v71/methods/messages_getRecentStickers.md index 0c5ae0c6..629a2bda 100644 --- a/old_docs/API_docs_v71/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getRecentStickers.md @@ -12,8 +12,8 @@ Get recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getSavedGifs.md b/old_docs/API_docs_v71/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v71/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v71/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v71/methods/messages_getStickerSet.md b/old_docs/API_docs_v71/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v71/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v71/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_getUnreadMentions.md b/old_docs/API_docs_v71/methods/messages_getUnreadMentions.md index b8d7b5a5..6abe55c6 100644 --- a/old_docs/API_docs_v71/methods/messages_getUnreadMentions.md +++ b/old_docs/API_docs_v71/methods/messages_getUnreadMentions.md @@ -13,11 +13,11 @@ Get unread mentions | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The offset| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|The additional offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|The minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The offset| +|add\_offset|[int](../types/int.md) | Yes|The additional offset| +|limit|[int](../types/int.md) | Yes|The number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|The minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -25,13 +25,6 @@ Get unread mentions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: messages_Messages = messages.getUnreadMentions({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_getWebPage.md b/old_docs/API_docs_v71/methods/messages_getWebPage.md index 19ca94b9..1b533ebd 100644 --- a/old_docs/API_docs_v71/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v71/methods/messages_getWebPage.md @@ -12,8 +12,8 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|url|[CLICK ME string](../types/string.md) | Yes|URL| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|url|[string](../types/string.md) | Yes|URL| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) @@ -21,13 +21,6 @@ Get webpage preview ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|WC_CONVERT_URL_INVALID|WC convert URL invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: WebPage = messages.getWebPage({url='string', hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|WC_CONVERT_URL_INVALID|WC convert URL invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v71/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v71/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v71/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v71/methods/messages_hideReportSpam.md b/old_docs/API_docs_v71/methods/messages_hideReportSpam.md index 30523f2a..0bf711ea 100644 --- a/old_docs/API_docs_v71/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v71/methods/messages_hideReportSpam.md @@ -20,13 +20,6 @@ Hide report spam popup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.hideReportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_importChatInvite.md b/old_docs/API_docs_v71/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v71/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v71/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v71/methods/messages_installStickerSet.md b/old_docs/API_docs_v71/methods/messages_installStickerSet.md index 20f90b71..d6caf555 100644 --- a/old_docs/API_docs_v71/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v71/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_migrateChat.md b/old_docs/API_docs_v71/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v71/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v71/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v71/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v71/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v71/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v71/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v71/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v71/methods/messages_readFeaturedStickers.md index 050371da..3b01171b 100644 --- a/old_docs/API_docs_v71/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_readFeaturedStickers.md @@ -12,7 +12,7 @@ Mark new featured stickers as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| +|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_readHistory.md b/old_docs/API_docs_v71/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v71/methods/messages_readHistory.md +++ b/old_docs/API_docs_v71/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/messages_readMessageContents.md b/old_docs/API_docs_v71/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v71/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v71/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v71/methods/messages_receivedMessages.md b/old_docs/API_docs_v71/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v71/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v71/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v71/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v71/methods/messages_reorderPinnedDialogs.md index 94d3b2d4..232117e8 100644 --- a/old_docs/API_docs_v71/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v71/methods/messages_reorderPinnedDialogs.md @@ -12,7 +12,7 @@ Reorder pinned dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|force|[Bool](../types/Bool.md) | Optional|Force reordering| |order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| @@ -21,13 +21,6 @@ Reorder pinned dialogs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.reorderPinnedDialogs({force=Bool, order={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v71/methods/messages_reorderStickerSets.md index 66f5e682..6a71da86 100644 --- a/old_docs/API_docs_v71/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v71/methods/messages_reorderStickerSets.md @@ -12,8 +12,8 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v71/methods/messages_reportEncryptedSpam.md index cd03c35c..988e0101 100644 --- a/old_docs/API_docs_v71/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v71/methods/messages_reportEncryptedSpam.md @@ -20,13 +20,6 @@ Report for spam a secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportEncryptedSpam({peer=InputEncryptedChat, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_reportSpam.md b/old_docs/API_docs_v71/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v71/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v71/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_saveDraft.md b/old_docs/API_docs_v71/methods/messages_saveDraft.md index 59b33b03..60d72c1e 100644 --- a/old_docs/API_docs_v71/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v71/methods/messages_saveDraft.md @@ -12,11 +12,11 @@ Save a message draft | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,13 +25,6 @@ Save a message draft ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -104,3 +97,10 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_saveGif.md b/old_docs/API_docs_v71/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v71/methods/messages_saveGif.md +++ b/old_docs/API_docs_v71/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v71/methods/messages_saveRecentSticker.md index 55757080..d2418881 100644 --- a/old_docs/API_docs_v71/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v71/methods/messages_saveRecentSticker.md @@ -12,9 +12,9 @@ Add a sticker to recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Add a sticker to recent stickers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.saveRecentSticker({attached=Bool, id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_search.md b/old_docs/API_docs_v71/methods/messages_search.md index 9253828a..96e0463e 100644 --- a/old_docs/API_docs_v71/methods/messages_search.md +++ b/old_docs/API_docs_v71/methods/messages_search.md @@ -13,16 +13,16 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| +|q|[string](../types/string.md) | Yes|What to search| |from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|Offset | -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message id to return| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset\_id|[int](../types/int.md) | Yes|Offset | +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of results to return| +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|min\_id|[int](../types/int.md) | Yes|Minumum message id to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -30,19 +30,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -99,3 +86,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', from_id=InputUser, filter=MessagesFilter, min_date=int, max_date=int, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_searchGifs.md b/old_docs/API_docs_v71/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v71/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v71/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v71/methods/messages_searchGlobal.md b/old_docs/API_docs_v71/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v71/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v71/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v71/methods/messages_sendEncrypted.md b/old_docs/API_docs_v71/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v71/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v71/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v71/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v71/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v71/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v71/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v71/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v71/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v71/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v71/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v71/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v71/methods/messages_sendInlineBotResult.md index 758aa97f..d1f9fbd0 100644 --- a/old_docs/API_docs_v71/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v71/methods/messages_sendInlineBotResult.md @@ -12,13 +12,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -26,18 +26,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v71/methods/messages_sendMedia.md b/old_docs/API_docs_v71/methods/messages_sendMedia.md index 770d1b65..94e27b83 100644 --- a/old_docs/API_docs_v71/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v71/methods/messages_sendMedia.md @@ -12,13 +12,13 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -26,34 +26,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -117,3 +89,31 @@ Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, pe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/messages_sendMessage.md b/old_docs/API_docs_v71/methods/messages_sendMessage.md index 83dc6c8b..ba76f230 100644 --- a/old_docs/API_docs_v71/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v71/methods/messages_sendMessage.md @@ -12,15 +12,15 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,33 +29,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -143,3 +116,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v71/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v71/methods/messages_sendScreenshotNotification.md index e823fd52..9db86b56 100644 --- a/old_docs/API_docs_v71/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v71/methods/messages_sendScreenshotNotification.md @@ -13,7 +13,7 @@ Send screenshot notification | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Send screenshot notification ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = messages.sendScreenshotNotification({peer=InputPeer, reply_to_msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v71/methods/messages_setBotCallbackAnswer.md index e221ccca..34c7bb16 100644 --- a/old_docs/API_docs_v71/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v71/methods/messages_setBotCallbackAnswer.md @@ -12,11 +12,11 @@ Bots only: set the callback answer (after a button was clicked) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|message|[CLICK ME string](../types/string.md) | Optional|The message| -|url|[CLICK ME string](../types/string.md) | Optional|The URL| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| +|url|[string](../types/string.md) | Optional|The URL| +|cache\_time|[int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) @@ -24,13 +24,6 @@ Bots only: set the callback answer (after a button was clicked) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -90,3 +83,10 @@ Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v71/methods/messages_setBotPrecheckoutResults.md index 7e3fc3c2..f631bf0c 100644 --- a/old_docs/API_docs_v71/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v71/methods/messages_setBotPrecheckoutResults.md @@ -12,9 +12,9 @@ Bots only: set precheckout results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| +|success|[Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set precheckout results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ERROR_TEXT_EMPTY|The provided error message is empty| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotPrecheckoutResults({success=Bool, query_id=long, error='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ERROR_TEXT_EMPTY|The provided error message is empty| + + diff --git a/old_docs/API_docs_v71/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v71/methods/messages_setBotShippingResults.md index 3d9f0ae2..915cfebf 100644 --- a/old_docs/API_docs_v71/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v71/methods/messages_setBotShippingResults.md @@ -12,9 +12,9 @@ Bots only: set shipping results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set shipping results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotShippingResults({query_id=long, error='string', shipping_options={ShippingOption}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v71/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v71/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v71/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_setGameScore.md b/old_docs/API_docs_v71/methods/messages_setGameScore.md index 90594a1d..c3d5a2c7 100644 --- a/old_docs/API_docs_v71/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v71/methods/messages_setGameScore.md @@ -12,12 +12,12 @@ Set the game score | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) @@ -25,14 +25,6 @@ Set the game score ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: Updates = messages.setGameScore({edit_message=Bool, force=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v71/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v71/methods/messages_setInlineBotResults.md index d4ba6e65..e46598e2 100644 --- a/old_docs/API_docs_v71/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v71/methods/messages_setInlineBotResults.md @@ -12,13 +12,13 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) @@ -26,23 +26,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -100,3 +83,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v71/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v71/methods/messages_setInlineGameScore.md index 2b7326f3..d33da5ef 100644 --- a/old_docs/API_docs_v71/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v71/methods/messages_setInlineGameScore.md @@ -12,11 +12,11 @@ Set the game score of an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) @@ -24,14 +24,6 @@ Set the game score of an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -85,3 +77,11 @@ Or, if you're into Lua: Bool = messages.setInlineGameScore({edit_message=Bool, force=Bool, id=InputBotInlineMessageID, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v71/methods/messages_setTyping.md b/old_docs/API_docs_v71/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v71/methods/messages_setTyping.md +++ b/old_docs/API_docs_v71/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v71/methods/messages_startBot.md b/old_docs/API_docs_v71/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v71/methods/messages_startBot.md +++ b/old_docs/API_docs_v71/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v71/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v71/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v71/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v71/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v71/methods/messages_toggleDialogPin.md index 14332533..6c57ce0a 100644 --- a/old_docs/API_docs_v71/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v71/methods/messages_toggleDialogPin.md @@ -12,7 +12,7 @@ Pin or unpin dialog | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| @@ -21,13 +21,6 @@ Pin or unpin dialog ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.toggleDialogPin({pinned=Bool, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v71/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v71/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v71/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v71/methods/messages_uploadMedia.md b/old_docs/API_docs_v71/methods/messages_uploadMedia.md index c09da017..4d511a15 100644 --- a/old_docs/API_docs_v71/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v71/methods/messages_uploadMedia.md @@ -21,15 +21,6 @@ Upload a file without sending it to anyone ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|MEDIA_INVALID|Media invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: MessageMedia = messages.uploadMedia({peer=InputPeer, media=InputMedia, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|MEDIA_INVALID|Media invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v71/methods/payments_clearSavedInfo.md index 8b83266f..117db209 100644 --- a/old_docs/API_docs_v71/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v71/methods/payments_clearSavedInfo.md @@ -12,8 +12,8 @@ Clear saved payments info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| +|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/payments_getPaymentForm.md b/old_docs/API_docs_v71/methods/payments_getPaymentForm.md index 3bdb9ff2..f68aa039 100644 --- a/old_docs/API_docs_v71/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v71/methods/payments_getPaymentForm.md @@ -12,7 +12,7 @@ Get payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|msg\_id|[int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) @@ -20,13 +20,6 @@ Get payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentForm = payments.getPaymentForm({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v71/methods/payments_getPaymentReceipt.md index a881aeb7..13073925 100644 --- a/old_docs/API_docs_v71/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v71/methods/payments_getPaymentReceipt.md @@ -12,7 +12,7 @@ Get payment receipt | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|msg\_id|[int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) @@ -20,13 +20,6 @@ Get payment receipt ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentReceipt = payments.getPaymentReceipt({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v71/methods/payments_sendPaymentForm.md index 79758b56..678b749b 100644 --- a/old_docs/API_docs_v71/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v71/methods/payments_sendPaymentForm.md @@ -12,10 +12,10 @@ Bots only: send payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +|msg\_id|[int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) @@ -23,13 +23,6 @@ Bots only: send payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: payments_PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v71/methods/payments_validateRequestedInfo.md index d473f97c..df6a9ba9 100644 --- a/old_docs/API_docs_v71/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v71/methods/payments_validateRequestedInfo.md @@ -12,9 +12,9 @@ Validate requested payment info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +|save|[Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) @@ -22,13 +22,6 @@ Validate requested payment info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: payments_ValidatedRequestedInfo = payments.validateRequestedInfo({save=Bool, msg_id=int, info=PaymentRequestedInfo, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v71/methods/phone_receivedCall.md b/old_docs/API_docs_v71/methods/phone_receivedCall.md index 17095622..6141a0ab 100644 --- a/old_docs/API_docs_v71/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v71/methods/phone_receivedCall.md @@ -12,7 +12,7 @@ Notify server that you received a call (server will refuse all incoming calls un | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| ### Return type: [Bool](../types/Bool.md) @@ -20,14 +20,6 @@ Notify server that you received a call (server will refuse all incoming calls un ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_ALREADY_DECLINED|The call was already declined| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = phone.receivedCall({peer=InputPhoneCall, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_ALREADY_DECLINED|The call was already declined| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v71/methods/phone_saveCallDebug.md b/old_docs/API_docs_v71/methods/phone_saveCallDebug.md index 0ff049a8..9f3daa18 100644 --- a/old_docs/API_docs_v71/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v71/methods/phone_saveCallDebug.md @@ -12,8 +12,8 @@ Save call debugging info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Debugging info| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| +|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Save call debugging info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| -|DATA_JSON_INVALID|The provided JSON data is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = phone.saveCallDebug({peer=InputPhoneCall, debug=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| +|DATA_JSON_INVALID|The provided JSON data is invalid| + + diff --git a/old_docs/API_docs_v71/methods/phone_setCallRating.md b/old_docs/API_docs_v71/methods/phone_setCallRating.md index d0aab7e0..d9833492 100644 --- a/old_docs/API_docs_v71/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v71/methods/phone_setCallRating.md @@ -12,9 +12,9 @@ Set phone call rating | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[CLICK ME int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[CLICK ME string](../types/string.md) | Yes|An optional comment| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| +|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| +|comment|[string](../types/string.md) | Yes|An optional comment| ### Return type: [Updates](../types/Updates.md) @@ -22,13 +22,6 @@ Set phone call rating ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Updates = phone.setCallRating({peer=InputPhoneCall, rating=int, comment='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v71/methods/photos_getUserPhotos.md b/old_docs/API_docs_v71/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v71/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v71/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v71/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v71/methods/photos_uploadProfilePhoto.md index c7ec3063..0c994ffe 100644 --- a/old_docs/API_docs_v71/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v71/methods/photos_uploadProfilePhoto.md @@ -20,16 +20,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -66,3 +56,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v71/methods/ping.md b/old_docs/API_docs_v71/methods/ping.md index f987ae89..daf1cc65 100644 --- a/old_docs/API_docs_v71/methods/ping.md +++ b/old_docs/API_docs_v71/methods/ping.md @@ -12,7 +12,7 @@ pings the server | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v71/methods/ping_delay_disconnect.md b/old_docs/API_docs_v71/methods/ping_delay_disconnect.md index 5b1c115d..66cc3704 100644 --- a/old_docs/API_docs_v71/methods/ping_delay_disconnect.md +++ b/old_docs/API_docs_v71/methods/ping_delay_disconnect.md @@ -12,8 +12,8 @@ Pings the server and causes disconection if the same method is not called within | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[CLICK ME int](../types/int.md) | Yes|Disconection delay| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| +|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v71/methods/req_DH_params.md b/old_docs/API_docs_v71/methods/req_DH_params.md index f0b45851..a426c699 100644 --- a/old_docs/API_docs_v71/methods/req_DH_params.md +++ b/old_docs/API_docs_v71/methods/req_DH_params.md @@ -12,12 +12,12 @@ Requests Diffie-hellman parameters for key exchange | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[CLICK ME string](../types/string.md) | Yes|factorized p from pq| -|q|[CLICK ME string](../types/string.md) | Yes|factorized q from pq| -|public\_key\_fingerprint|[CLICK ME long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[CLICK ME string](../types/string.md) | Yes|Encrypted message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|p|[string](../types/string.md) | Yes|factorized p from pq| +|q|[string](../types/string.md) | Yes|factorized q from pq| +|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| +|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/old_docs/API_docs_v71/methods/req_pq.md b/old_docs/API_docs_v71/methods/req_pq.md index 0873d9a2..d273a0b9 100644 --- a/old_docs/API_docs_v71/methods/req_pq.md +++ b/old_docs/API_docs_v71/methods/req_pq.md @@ -12,7 +12,7 @@ Requests PQ for factorization | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/old_docs/API_docs_v71/methods/rpc_drop_answer.md b/old_docs/API_docs_v71/methods/rpc_drop_answer.md index 27f98bca..34b355f3 100644 --- a/old_docs/API_docs_v71/methods/rpc_drop_answer.md +++ b/old_docs/API_docs_v71/methods/rpc_drop_answer.md @@ -12,7 +12,7 @@ Do not send answer to provided request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|req\_msg\_id|[CLICK ME long](../types/long.md) | Yes|The message ID of the request| +|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/old_docs/API_docs_v71/methods/set_client_DH_params.md b/old_docs/API_docs_v71/methods/set_client_DH_params.md index cf8ab321..5a173688 100644 --- a/old_docs/API_docs_v71/methods/set_client_DH_params.md +++ b/old_docs/API_docs_v71/methods/set_client_DH_params.md @@ -12,9 +12,9 @@ Sets client diffie-hellman parameters | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[CLICK ME string](../types/string.md) | Yes|Encrypted message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/old_docs/API_docs_v71/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v71/methods/stickers_addStickerToSet.md index 7c4191d8..6e1d680c 100644 --- a/old_docs/API_docs_v71/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v71/methods/stickers_addStickerToSet.md @@ -12,8 +12,8 @@ Add sticker to stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -21,14 +21,6 @@ Add sticker to stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.addStickerToSet({stickerset=InputStickerSet, sticker=InputStickerSetItem, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v71/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v71/methods/stickers_changeStickerPosition.md index d25129c5..6e8e2505 100644 --- a/old_docs/API_docs_v71/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v71/methods/stickers_changeStickerPosition.md @@ -13,7 +13,7 @@ Change sticker position in photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[CLICK ME int](../types/int.md) | Yes|New position| +|position|[int](../types/int.md) | Yes|New position| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -21,14 +21,6 @@ Change sticker position in photo ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKER_INVALID|The provided sticker is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.changeStickerPosition({sticker=InputDocument, position=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v71/methods/stickers_createStickerSet.md b/old_docs/API_docs_v71/methods/stickers_createStickerSet.md index 95775849..371033ca 100644 --- a/old_docs/API_docs_v71/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v71/methods/stickers_createStickerSet.md @@ -12,11 +12,11 @@ Create stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Masks?| +|masks|[Bool](../types/Bool.md) | Optional|Masks?| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[CLICK ME string](../types/string.md) | Yes|The stickerset title| -|short\_name|[CLICK ME string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +|title|[string](../types/string.md) | Yes|The stickerset title| +|short\_name|[string](../types/string.md) | Yes|The stickerset short name| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -24,21 +24,6 @@ Create stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|PACK_SHORT_NAME_INVALID|Short pack name invalid| -|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| -|PEER_ID_INVALID|The provided peer id is invalid| -|STICKER_EMOJI_INVALID|Sticker emoji invalid| -|STICKER_FILE_INVALID|Sticker file invalid| -|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| -|STICKERS_EMPTY|No sticker provided| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -92,3 +77,18 @@ Or, if you're into Lua: messages_StickerSet = stickers.createStickerSet({masks=Bool, user_id=InputUser, title='string', short_name='string', stickers={InputStickerSetItem}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|PACK_SHORT_NAME_INVALID|Short pack name invalid| +|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| +|PEER_ID_INVALID|The provided peer id is invalid| +|STICKER_EMOJI_INVALID|Sticker emoji invalid| +|STICKER_FILE_INVALID|Sticker file invalid| +|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| +|STICKERS_EMPTY|No sticker provided| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v71/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v71/methods/stickers_removeStickerFromSet.md index 73ed78d5..5e3a4291 100644 --- a/old_docs/API_docs_v71/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v71/methods/stickers_removeStickerFromSet.md @@ -20,14 +20,6 @@ Remove sticker from stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKER_INVALID|The provided sticker is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.removeStickerFromSet({sticker=InputDocument, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v71/methods/upload_getWebFile.md b/old_docs/API_docs_v71/methods/upload_getWebFile.md index 11634633..f869519a 100644 --- a/old_docs/API_docs_v71/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v71/methods/upload_getWebFile.md @@ -12,9 +12,9 @@ Download a file through telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[int](../types/int.md) | Yes|The offset in bytes| +|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) @@ -22,13 +22,6 @@ Download a file through telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LOCATION_INVALID|The provided location is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: upload_WebFile = upload.getWebFile({location=InputWebFileLocation, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LOCATION_INVALID|The provided location is invalid| + + diff --git a/old_docs/API_docs_v71/methods/users_getUsers.md b/old_docs/API_docs_v71/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v71/methods/users_getUsers.md +++ b/old_docs/API_docs_v71/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/account_changePhone.md b/old_docs/API_docs_v72/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v72/methods/account_changePhone.md +++ b/old_docs/API_docs_v72/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_checkUsername.md b/old_docs/API_docs_v72/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v72/methods/account_checkUsername.md +++ b/old_docs/API_docs_v72/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v72/methods/account_confirmPhone.md b/old_docs/API_docs_v72/methods/account_confirmPhone.md index 68490f35..7ffabc24 100644 --- a/old_docs/API_docs_v72/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v72/methods/account_confirmPhone.md @@ -12,8 +12,8 @@ Confirm this phone number is associated to this account, obtain phone_code_hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| +|phone\_code\_hash|[string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Confirm this phone number is associated to this account, obtain phone_code_hash ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_HASH_INVALID|Code hash invalid| -|PHONE_CODE_EMPTY|phone_code is missing| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_HASH_INVALID|Code hash invalid| +|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/old_docs/API_docs_v72/methods/account_deleteAccount.md b/old_docs/API_docs_v72/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v72/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v72/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/account_getNotifySettings.md b/old_docs/API_docs_v72/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v72/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v72/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_getPasswordSettings.md b/old_docs/API_docs_v72/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v72/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v72/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_getPrivacy.md b/old_docs/API_docs_v72/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v72/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v72/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_getTmpPassword.md b/old_docs/API_docs_v72/methods/account_getTmpPassword.md index 01b1ebfc..c82ff37a 100644 --- a/old_docs/API_docs_v72/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v72/methods/account_getTmpPassword.md @@ -12,8 +12,8 @@ Get temporary password for buying products through bots | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|The password hash| -|period|[CLICK ME int](../types/int.md) | Yes|The validity period| +|password\_hash|[bytes](../types/bytes.md) | Yes|The password hash| +|period|[int](../types/int.md) | Yes|The validity period| ### Return type: [account\_TmpPassword](../types/account_TmpPassword.md) @@ -21,14 +21,6 @@ Get temporary password for buying products through bots ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| -|TMP_PASSWORD_DISABLED|The temporary password is disabled| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: account_TmpPassword = account.getTmpPassword({password_hash='bytes', period=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|TMP_PASSWORD_DISABLED|The temporary password is disabled| + + diff --git a/old_docs/API_docs_v72/methods/account_registerDevice.md b/old_docs/API_docs_v72/methods/account_registerDevice.md index 4e148a7f..cbac71d3 100644 --- a/old_docs/API_docs_v72/methods/account_registerDevice.md +++ b/old_docs/API_docs_v72/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_reportPeer.md b/old_docs/API_docs_v72/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v72/methods/account_reportPeer.md +++ b/old_docs/API_docs_v72/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_resetAuthorization.md b/old_docs/API_docs_v72/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v72/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v72/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v72/methods/account_sendChangePhoneCode.md index bdf7331f..476b6d79 100644 --- a/old_docs/API_docs_v72/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v72/methods/account_sendChangePhoneCode.md @@ -12,9 +12,9 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|Current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v72/methods/account_sendConfirmPhoneCode.md index 86035d19..8917355f 100644 --- a/old_docs/API_docs_v72/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v72/methods/account_sendConfirmPhoneCode.md @@ -12,9 +12,9 @@ Send confirmation phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| -|hash|[CLICK ME string](../types/string.md) | Yes|The hash| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|The current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| +|hash|[string](../types/string.md) | Yes|The hash| +|current\_number|[Bool](../types/Bool.md) | Optional|The current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Send confirmation phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendConfirmPhoneCode({allow_flashcall=Bool, hash='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_setAccountTTL.md b/old_docs/API_docs_v72/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v72/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v72/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_setPrivacy.md b/old_docs/API_docs_v72/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v72/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v72/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_unregisterDevice.md b/old_docs/API_docs_v72/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v72/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v72/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v72/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v72/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v72/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/account_updateNotifySettings.md b/old_docs/API_docs_v72/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v72/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v72/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v72/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v72/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v72/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_updateProfile.md b/old_docs/API_docs_v72/methods/account_updateProfile.md index 59629188..ef19dc00 100644 --- a/old_docs/API_docs_v72/methods/account_updateProfile.md +++ b/old_docs/API_docs_v72/methods/account_updateProfile.md @@ -12,9 +12,9 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Optional|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Optional|The last name| -|about|[CLICK ME string](../types/string.md) | Optional|The bio/about field| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| ### Return type: [User](../types/User.md) @@ -22,14 +22,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v72/methods/account_updateStatus.md b/old_docs/API_docs_v72/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v72/methods/account_updateStatus.md +++ b/old_docs/API_docs_v72/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v72/methods/account_updateUsername.md b/old_docs/API_docs_v72/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v72/methods/account_updateUsername.md +++ b/old_docs/API_docs_v72/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v72/methods/auth_cancelCode.md b/old_docs/API_docs_v72/methods/auth_cancelCode.md index 52b85d4c..84401c62 100644 --- a/old_docs/API_docs_v72/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v72/methods/auth_cancelCode.md @@ -12,8 +12,8 @@ Invalidate sent phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invalidate sent phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v72/methods/auth_checkPhone.md b/old_docs/API_docs_v72/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v72/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v72/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v72/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v72/methods/auth_dropTempAuthKeys.md index 5aa98b3b..537afbc1 100644 --- a/old_docs/API_docs_v72/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v72/methods/auth_dropTempAuthKeys.md @@ -12,7 +12,7 @@ Delete all temporary authorization keys except the ones provided | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_auth\_keys|Array of [CLICK ME long](../types/long.md) | Yes|The temporary authorization keys to keep| +|except\_auth\_keys|Array of [long](../types/long.md) | Yes|The temporary authorization keys to keep| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/auth_recoverPassword.md b/old_docs/API_docs_v72/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v72/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v72/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v72/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v72/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v72/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v72/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v72/methods/auth_resendCode.md b/old_docs/API_docs_v72/methods/auth_resendCode.md index 253480a3..4402bfe6 100644 --- a/old_docs/API_docs_v72/methods/auth_resendCode.md +++ b/old_docs/API_docs_v72/methods/auth_resendCode.md @@ -12,8 +12,8 @@ Resend the SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -21,13 +21,6 @@ Resend the SMS verification code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v72/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v72/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v72/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v72/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/auth_sendInvites.md b/old_docs/API_docs_v72/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v72/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v72/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v72/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v72/methods/bots_answerWebhookJSONQuery.md index 40cb0477..3dbf62ef 100644 --- a/old_docs/API_docs_v72/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v72/methods/bots_answerWebhookJSONQuery.md @@ -12,8 +12,8 @@ Send webhook request via bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|data|[DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Send webhook request via bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Bool = bots.answerWebhookJSONQuery({query_id=long, data=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v72/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v72/methods/bots_sendCustomRequest.md index 5a7f4e86..cb7c32e2 100644 --- a/old_docs/API_docs_v72/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v72/methods/bots_sendCustomRequest.md @@ -12,8 +12,8 @@ Send a custom request to the bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| +|custom\_method|[string](../types/string.md) | Yes|The method to call| +|params|[DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) @@ -21,13 +21,6 @@ Send a custom request to the bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: DataJSON = bots.sendCustomRequest({custom_method='string', params=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v72/methods/channels_checkUsername.md b/old_docs/API_docs_v72/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v72/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v72/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v72/methods/channels_createChannel.md b/old_docs/API_docs_v72/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v72/methods/channels_createChannel.md +++ b/old_docs/API_docs_v72/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v72/methods/channels_deleteChannel.md b/old_docs/API_docs_v72/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v72/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v72/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v72/methods/channels_deleteHistory.md b/old_docs/API_docs_v72/methods/channels_deleteHistory.md index 856a32e8..f7c225f6 100644 --- a/old_docs/API_docs_v72/methods/channels_deleteHistory.md +++ b/old_docs/API_docs_v72/methods/channels_deleteHistory.md @@ -13,7 +13,7 @@ Delete the history of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to delete| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/channels_deleteMessages.md b/old_docs/API_docs_v72/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v72/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v72/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v72/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v72/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v72/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v72/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v72/methods/channels_editAbout.md b/old_docs/API_docs_v72/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v72/methods/channels_editAbout.md +++ b/old_docs/API_docs_v72/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v72/methods/channels_editAdmin.md b/old_docs/API_docs_v72/methods/channels_editAdmin.md index 7cecbd64..f08473eb 100644 --- a/old_docs/API_docs_v72/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v72/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| +|admin\_rights|[ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, admin_rights=ChannelAdminRights, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v72/methods/channels_editBanned.md b/old_docs/API_docs_v72/methods/channels_editBanned.md index ca9f2596..03dc70a5 100644 --- a/old_docs/API_docs_v72/methods/channels_editBanned.md +++ b/old_docs/API_docs_v72/methods/channels_editBanned.md @@ -14,7 +14,7 @@ Kick or ban a user from a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban| -|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| +|banned\_rights|[ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| ### Return type: [Updates](../types/Updates.md) @@ -22,17 +22,6 @@ Kick or ban a user from a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ADMIN_INVALID|You're not an admin| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +71,14 @@ Or, if you're into Lua: Updates = channels.editBanned({channel=InputChannel, user_id=InputUser, banned_rights=ChannelBannedRights, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ADMIN_INVALID|You're not an admin| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v72/methods/channels_editPhoto.md b/old_docs/API_docs_v72/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v72/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v72/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v72/methods/channels_editTitle.md b/old_docs/API_docs_v72/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v72/methods/channels_editTitle.md +++ b/old_docs/API_docs_v72/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v72/methods/channels_exportInvite.md b/old_docs/API_docs_v72/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v72/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v72/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v72/methods/channels_exportMessageLink.md b/old_docs/API_docs_v72/methods/channels_exportMessageLink.md index b4a3c645..20f6e998 100644 --- a/old_docs/API_docs_v72/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v72/methods/channels_exportMessageLink.md @@ -13,7 +13,7 @@ Get the link of a message in a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| +|id|[int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -21,13 +21,6 @@ Get the link of a message in a channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v72/methods/channels_getAdminLog.md b/old_docs/API_docs_v72/methods/channels_getAdminLog.md index 4a419778..1ffcf5c3 100644 --- a/old_docs/API_docs_v72/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v72/methods/channels_getAdminLog.md @@ -13,12 +13,12 @@ Get admin log of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|q|[CLICK ME string](../types/string.md) | Yes|Search query| -|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| +|q|[string](../types/string.md) | Yes|Search query| +|events\_filter|[ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| |admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME long](../types/long.md) | Yes|Minimum message ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[long](../types/long.md) | Yes|Maximum message ID to fetch| +|min\_id|[long](../types/long.md) | Yes|Minimum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) @@ -26,15 +26,6 @@ Get admin log of a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -83,3 +74,12 @@ Or, if you're into Lua: channels_AdminLogResults = channels.getAdminLog({channel=InputChannel, q='string', events_filter=ChannelAdminLogEventsFilter, admins={InputUser}, max_id=long, min_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v72/methods/channels_getChannels.md b/old_docs/API_docs_v72/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v72/methods/channels_getChannels.md +++ b/old_docs/API_docs_v72/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v72/methods/channels_getMessages.md b/old_docs/API_docs_v72/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v72/methods/channels_getMessages.md +++ b/old_docs/API_docs_v72/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v72/methods/channels_getParticipant.md b/old_docs/API_docs_v72/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v72/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v72/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v72/methods/channels_getParticipants.md b/old_docs/API_docs_v72/methods/channels_getParticipants.md index 3772ef4b..32b677d5 100644 --- a/old_docs/API_docs_v72/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v72/methods/channels_getParticipants.md @@ -13,10 +13,10 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched participant IDs)| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched participant IDs)| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -24,17 +24,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -88,3 +77,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/channels_inviteToChannel.md b/old_docs/API_docs_v72/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v72/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v72/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v72/methods/channels_joinChannel.md b/old_docs/API_docs_v72/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v72/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v72/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v72/methods/channels_leaveChannel.md b/old_docs/API_docs_v72/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v72/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v72/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v72/methods/channels_readHistory.md b/old_docs/API_docs_v72/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v72/methods/channels_readHistory.md +++ b/old_docs/API_docs_v72/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v72/methods/channels_readMessageContents.md b/old_docs/API_docs_v72/methods/channels_readMessageContents.md index aa9893c2..912adfcf 100644 --- a/old_docs/API_docs_v72/methods/channels_readMessageContents.md +++ b/old_docs/API_docs_v72/methods/channels_readMessageContents.md @@ -13,7 +13,7 @@ Mark channel/supergroup messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|id|Array of [CLICK ME int](../types/int.md) | Yes|List of message IDs| +|id|Array of [int](../types/int.md) | Yes|List of message IDs| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readMessageContents({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v72/methods/channels_reportSpam.md b/old_docs/API_docs_v72/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v72/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v72/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v72/methods/channels_setStickers.md b/old_docs/API_docs_v72/methods/channels_setStickers.md index d9be32a4..b5142d9f 100644 --- a/old_docs/API_docs_v72/methods/channels_setStickers.md +++ b/old_docs/API_docs_v72/methods/channels_setStickers.md @@ -13,7 +13,7 @@ Set the supergroup/channel stickerpack | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergoup| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Set the supergroup/channel stickerpack ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PARTICIPANTS_TOO_FEW|Not enough participants| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Bool = channels.setStickers({channel=InputChannel, stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PARTICIPANTS_TOO_FEW|Not enough participants| + + diff --git a/old_docs/API_docs_v72/methods/channels_toggleInvites.md b/old_docs/API_docs_v72/methods/channels_toggleInvites.md index e9e6450d..d437682f 100644 --- a/old_docs/API_docs_v72/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v72/methods/channels_toggleInvites.md @@ -13,7 +13,7 @@ Allow or disallow any user to invite users to this channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Allow or disallow any user to invite users to this channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v72/methods/channels_togglePreHistoryHidden.md b/old_docs/API_docs_v72/methods/channels_togglePreHistoryHidden.md index d07784de..4374991f 100644 --- a/old_docs/API_docs_v72/methods/channels_togglePreHistoryHidden.md +++ b/old_docs/API_docs_v72/methods/channels_togglePreHistoryHidden.md @@ -13,7 +13,7 @@ Enable or disable hidden history for new channel/supergroup users | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable hidden history for new channel/supergroup users| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable hidden history for new channel/supergroup users| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_toggleSignatures.md b/old_docs/API_docs_v72/methods/channels_toggleSignatures.md index 36d1eccb..d40bf67b 100644 --- a/old_docs/API_docs_v72/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v72/methods/channels_toggleSignatures.md @@ -13,7 +13,7 @@ Toggle channel signatures | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Toggle channel signatures ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v72/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v72/methods/channels_updatePinnedMessage.md index f8d10ece..aa2cc783 100644 --- a/old_docs/API_docs_v72/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v72/methods/channels_updatePinnedMessage.md @@ -12,9 +12,9 @@ Set the pinned message of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Set the pinned message of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -81,3 +71,13 @@ Or, if you're into Lua: Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v72/methods/channels_updateUsername.md b/old_docs/API_docs_v72/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v72/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v72/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v72/methods/contacts_block.md b/old_docs/API_docs_v72/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v72/methods/contacts_block.md +++ b/old_docs/API_docs_v72/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v72/methods/contacts_deleteContact.md b/old_docs/API_docs_v72/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v72/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v72/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v72/methods/contacts_deleteContacts.md b/old_docs/API_docs_v72/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v72/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v72/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/contacts_getBlocked.md b/old_docs/API_docs_v72/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v72/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v72/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v72/methods/contacts_getContacts.md b/old_docs/API_docs_v72/methods/contacts_getContacts.md index 589572dc..25085a19 100644 --- a/old_docs/API_docs_v72/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v72/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|$ids is the list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`| +|hash|[int](../types/int.md) | Yes|$ids is the list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v72/methods/contacts_getTopPeers.md b/old_docs/API_docs_v72/methods/contacts_getTopPeers.md index 4958e6b2..a8cd4c57 100644 --- a/old_docs/API_docs_v72/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v72/methods/contacts_getTopPeers.md @@ -12,15 +12,15 @@ Get most used chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|correspondents|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch users?| -|bots\_pm|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch bots?| -|bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| -|phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?| -|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| -|channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| +|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?| +|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?| +|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?| +|phone\_calls|[Bool](../types/Bool.md) | Optional|Fetch phone calls?| +|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?| +|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| +|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|limit|[int](../types/int.md) | Yes|How many results to fetch| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| ### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) @@ -28,13 +28,6 @@ Get most used chats ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TYPES_EMPTY|The types field is empty| - - ### MadelineProto Example: @@ -87,3 +80,10 @@ Or, if you're into Lua: contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, phone_calls=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field is empty| + + diff --git a/old_docs/API_docs_v72/methods/contacts_importCard.md b/old_docs/API_docs_v72/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v72/methods/contacts_importCard.md +++ b/old_docs/API_docs_v72/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v72/methods/contacts_importContacts.md b/old_docs/API_docs_v72/methods/contacts_importContacts.md index ccc0eada..5b07237e 100644 --- a/old_docs/API_docs_v72/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v72/methods/contacts_importContacts.md @@ -12,7 +12,7 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v72/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v72/methods/contacts_resetTopPeerRating.md index 4b5e96f1..15b07f96 100644 --- a/old_docs/API_docs_v72/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v72/methods/contacts_resetTopPeerRating.md @@ -12,7 +12,7 @@ Reset top peer rating for a certain category/peer | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| @@ -21,13 +21,6 @@ Reset top peer rating for a certain category/peer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/contacts_search.md b/old_docs/API_docs_v72/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v72/methods/contacts_search.md +++ b/old_docs/API_docs_v72/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/contacts_unblock.md b/old_docs/API_docs_v72/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v72/methods/contacts_unblock.md +++ b/old_docs/API_docs_v72/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v72/methods/contest_saveDeveloperInfo.md b/old_docs/API_docs_v72/methods/contest_saveDeveloperInfo.md index 5d82a4be..de23c472 100644 --- a/old_docs/API_docs_v72/methods/contest_saveDeveloperInfo.md +++ b/old_docs/API_docs_v72/methods/contest_saveDeveloperInfo.md @@ -12,11 +12,11 @@ Save developer info for telegram contest | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|vk\_id|[CLICK ME int](../types/int.md) | Yes|VK user ID| -|name|[CLICK ME string](../types/string.md) | Yes|Name| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|age|[CLICK ME int](../types/int.md) | Yes|Age| -|city|[CLICK ME string](../types/string.md) | Yes|City| +|vk\_id|[int](../types/int.md) | Yes|VK user ID| +|name|[string](../types/string.md) | Yes|Name| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|age|[int](../types/int.md) | Yes|Age| +|city|[string](../types/string.md) | Yes|City| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/destroy_session.md b/old_docs/API_docs_v72/methods/destroy_session.md index b74fbd11..c4187ce0 100644 --- a/old_docs/API_docs_v72/methods/destroy_session.md +++ b/old_docs/API_docs_v72/methods/destroy_session.md @@ -12,7 +12,7 @@ Destroy the current MTProto session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|session\_id|[CLICK ME long](../types/long.md) | Yes|The session to destroy| +|session\_id|[long](../types/long.md) | Yes|The session to destroy| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/old_docs/API_docs_v72/methods/get_future_salts.md b/old_docs/API_docs_v72/methods/get_future_salts.md index e8451015..7f5fc18c 100644 --- a/old_docs/API_docs_v72/methods/get_future_salts.md +++ b/old_docs/API_docs_v72/methods/get_future_salts.md @@ -12,7 +12,7 @@ Get future salts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|num|[CLICK ME int](../types/int.md) | Yes|How many salts should be fetched| +|num|[int](../types/int.md) | Yes|How many salts should be fetched| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/old_docs/API_docs_v72/methods/help_getAppChangelog.md b/old_docs/API_docs_v72/methods/help_getAppChangelog.md index eda473a6..183ebb8c 100644 --- a/old_docs/API_docs_v72/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v72/methods/help_getAppChangelog.md @@ -12,7 +12,7 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| +|prev\_app\_version|[string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/help_getCdnConfig.md b/old_docs/API_docs_v72/methods/help_getCdnConfig.md index b98949ed..b7af5bb4 100644 --- a/old_docs/API_docs_v72/methods/help_getCdnConfig.md +++ b/old_docs/API_docs_v72/methods/help_getCdnConfig.md @@ -15,13 +15,6 @@ Get CDN configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: CdnConfig = help.getCdnConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/help_getConfig.md b/old_docs/API_docs_v72/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v72/methods/help_getConfig.md +++ b/old_docs/API_docs_v72/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/help_getRecentMeUrls.md b/old_docs/API_docs_v72/methods/help_getRecentMeUrls.md index 29d2e21f..7a41f33c 100644 --- a/old_docs/API_docs_v72/methods/help_getRecentMeUrls.md +++ b/old_docs/API_docs_v72/methods/help_getRecentMeUrls.md @@ -12,7 +12,7 @@ Get recent t.me URLs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|referer|[CLICK ME string](../types/string.md) | Yes|Referrer| +|referer|[string](../types/string.md) | Yes|Referrer| ### Return type: [help\_RecentMeUrls](../types/help_RecentMeUrls.md) diff --git a/old_docs/API_docs_v72/methods/help_saveAppLog.md b/old_docs/API_docs_v72/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v72/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v72/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v72/methods/help_setBotUpdatesStatus.md index a1a3ab1b..1766ee14 100644 --- a/old_docs/API_docs_v72/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v72/methods/help_setBotUpdatesStatus.md @@ -12,8 +12,8 @@ Set the update status of webhook | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| -|message|[CLICK ME string](../types/string.md) | Yes|Message| +|pending\_updates\_count|[int](../types/int.md) | Yes|Pending update count| +|message|[string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/initConnection.md b/old_docs/API_docs_v72/methods/initConnection.md index c66aa8b1..2d195613 100644 --- a/old_docs/API_docs_v72/methods/initConnection.md +++ b/old_docs/API_docs_v72/methods/initConnection.md @@ -12,14 +12,14 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|system\_lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| -|lang\_pack|[CLICK ME string](../types/string.md) | Yes|Language pack to use| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|system\_lang\_code|[string](../types/string.md) | Yes|Language code| +|lang\_pack|[string](../types/string.md) | Yes|Language pack to use| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -27,14 +27,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -94,3 +86,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', system_lang_code='string', lang_pack='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v72/methods/invokeAfterMsg.md b/old_docs/API_docs_v72/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v72/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v72/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v72/methods/invokeAfterMsgs.md b/old_docs/API_docs_v72/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v72/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v72/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v72/methods/invokeWithLayer.md b/old_docs/API_docs_v72/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v72/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v72/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v72/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v72/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v72/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v72/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v72/methods/langpack_getDifference.md b/old_docs/API_docs_v72/methods/langpack_getDifference.md index 0a6512e4..1860cc49 100644 --- a/old_docs/API_docs_v72/methods/langpack_getDifference.md +++ b/old_docs/API_docs_v72/methods/langpack_getDifference.md @@ -12,7 +12,7 @@ Get language pack updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|from\_version|[CLICK ME int](../types/int.md) | Yes|Previous version| +|from\_version|[int](../types/int.md) | Yes|Previous version| ### Return type: [LangPackDifference](../types/LangPackDifference.md) @@ -20,13 +20,6 @@ Get language pack updates ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: LangPackDifference = langpack.getDifference({from_version=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v72/methods/langpack_getLangPack.md b/old_docs/API_docs_v72/methods/langpack_getLangPack.md index 45a9ca47..7e64aec9 100644 --- a/old_docs/API_docs_v72/methods/langpack_getLangPack.md +++ b/old_docs/API_docs_v72/methods/langpack_getLangPack.md @@ -12,7 +12,7 @@ Get language pack | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [LangPackDifference](../types/LangPackDifference.md) @@ -20,13 +20,6 @@ Get language pack ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: LangPackDifference = langpack.getLangPack({lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v72/methods/langpack_getLanguages.md b/old_docs/API_docs_v72/methods/langpack_getLanguages.md index b573a5eb..c4ea44ca 100644 --- a/old_docs/API_docs_v72/methods/langpack_getLanguages.md +++ b/old_docs/API_docs_v72/methods/langpack_getLanguages.md @@ -15,13 +15,6 @@ Get available languages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Vector_of_LangPackLanguage = langpack.getLanguages({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v72/methods/langpack_getStrings.md b/old_docs/API_docs_v72/methods/langpack_getStrings.md index 841b02db..4953e1c0 100644 --- a/old_docs/API_docs_v72/methods/langpack_getStrings.md +++ b/old_docs/API_docs_v72/methods/langpack_getStrings.md @@ -12,8 +12,8 @@ Get language pack strings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| -|keys|Array of [CLICK ME string](../types/string.md) | Yes|Keys| +|lang\_code|[string](../types/string.md) | Yes|Language code| +|keys|Array of [string](../types/string.md) | Yes|Keys| ### Return type: [Vector\_of\_LangPackString](../types/LangPackString.md) @@ -21,13 +21,6 @@ Get language pack strings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Vector_of_LangPackString = langpack.getStrings({lang_code='string', keys={'string'}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_addChatUser.md b/old_docs/API_docs_v72/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v72/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v72/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v72/methods/messages_checkChatInvite.md b/old_docs/API_docs_v72/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v72/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v72/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v72/methods/messages_clearRecentStickers.md index 1d6ec8c9..72c4844b 100644 --- a/old_docs/API_docs_v72/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v72/methods/messages_clearRecentStickers.md @@ -12,7 +12,7 @@ Clear all recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_createChat.md b/old_docs/API_docs_v72/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v72/methods/messages_createChat.md +++ b/old_docs/API_docs_v72/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v72/methods/messages_deleteChatUser.md b/old_docs/API_docs_v72/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v72/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v72/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v72/methods/messages_deleteHistory.md b/old_docs/API_docs_v72/methods/messages_deleteHistory.md index 45e9890d..601d1876 100644 --- a/old_docs/API_docs_v72/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v72/methods/messages_deleteHistory.md @@ -12,9 +12,9 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|just\_clear|[CLICK ME Bool](../types/Bool.md) | Optional|Only clear it from your side| +|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,13 +22,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_deleteMessages.md b/old_docs/API_docs_v72/methods/messages_deleteMessages.md index c8670444..900e9d0e 100644 --- a/old_docs/API_docs_v72/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v72/methods/messages_deleteMessages.md @@ -12,8 +12,8 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|revoke|[CLICK ME Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,13 +21,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({revoke=Bool, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v72/methods/messages_editChatAdmin.md b/old_docs/API_docs_v72/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v72/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v72/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_editChatPhoto.md b/old_docs/API_docs_v72/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v72/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v72/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_editChatTitle.md b/old_docs/API_docs_v72/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v72/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v72/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v72/methods/messages_editInlineBotMessage.md index 73c8a2c4..4729b52a 100644 --- a/old_docs/API_docs_v72/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v72/methods/messages_editInlineBotMessage.md @@ -12,11 +12,11 @@ Edit a sent inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,14 +25,6 @@ Edit a sent inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| - - ### MadelineProto Example: @@ -120,3 +112,11 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v72/methods/messages_editMessage.md b/old_docs/API_docs_v72/methods/messages_editMessage.md index e3178d97..7c85d566 100644 --- a/old_docs/API_docs_v72/methods/messages_editMessage.md +++ b/old_docs/API_docs_v72/methods/messages_editMessage.md @@ -12,15 +12,15 @@ Edit a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional|Stop live location| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| ### Return type: [Updates](../types/Updates.md) @@ -28,22 +28,6 @@ Edit a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -133,3 +117,19 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v72/methods/messages_exportChatInvite.md b/old_docs/API_docs_v72/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v72/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v72/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_faveSticker.md b/old_docs/API_docs_v72/methods/messages_faveSticker.md index ee1eb66a..8b1534ea 100644 --- a/old_docs/API_docs_v72/methods/messages_faveSticker.md +++ b/old_docs/API_docs_v72/methods/messages_faveSticker.md @@ -13,7 +13,7 @@ Add a sticker to favorites | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| -|unfave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove it from favorites?| +|unfave|[Bool](../types/Bool.md) | Yes|Remove it from favorites?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker to favorites ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.faveSticker({id=InputDocument, unfave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_forwardMessage.md b/old_docs/API_docs_v72/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v72/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v72/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v72/methods/messages_forwardMessages.md b/old_docs/API_docs_v72/methods/messages_forwardMessages.md index b99e1d31..2a0455e4 100644 --- a/old_docs/API_docs_v72/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v72/methods/messages_forwardMessages.md @@ -12,11 +12,11 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[CLICK ME Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| +|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -25,34 +25,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -108,3 +80,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/messages_getAllChats.md b/old_docs/API_docs_v72/methods/messages_getAllChats.md index 513fc06f..c4851369 100644 --- a/old_docs/API_docs_v72/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v72/methods/messages_getAllChats.md @@ -12,7 +12,7 @@ Get all chats (not supergroups or channels) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v72/methods/messages_getAllStickers.md b/old_docs/API_docs_v72/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v72/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v72/methods/messages_getArchivedStickers.md index ee36b542..dfd5c006 100644 --- a/old_docs/API_docs_v72/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getArchivedStickers.md @@ -12,9 +12,9 @@ Get all archived stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| +|masks|[Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| +|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v72/methods/messages_getAttachedStickers.md index 9f8a66c5..8f51f38d 100644 --- a/old_docs/API_docs_v72/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getAttachedStickers.md @@ -12,7 +12,7 @@ Get stickers attachable to images | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v72/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v72/methods/messages_getBotCallbackAnswer.md index 0136227f..4b8887ad 100644 --- a/old_docs/API_docs_v72/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v72/methods/messages_getBotCallbackAnswer.md @@ -12,10 +12,10 @@ Get the callback answer of a bot (after clicking a button) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|game|[Bool](../types/Bool.md) | Optional|Is this a game?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) @@ -23,17 +23,6 @@ Get the callback answer of a bot (after clicking a button) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|DATA_INVALID|Encrypted data invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: messages_BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/messages_getChats.md b/old_docs/API_docs_v72/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v72/methods/messages_getChats.md +++ b/old_docs/API_docs_v72/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_getCommonChats.md b/old_docs/API_docs_v72/methods/messages_getCommonChats.md index 15ed6713..6ffa0948 100644 --- a/old_docs/API_docs_v72/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v72/methods/messages_getCommonChats.md @@ -13,8 +13,8 @@ Get chats in common with a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -22,13 +22,6 @@ Get chats in common with a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_Chats = messages.getCommonChats({user_id=InputUser, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_getDialogs.md b/old_docs/API_docs_v72/methods/messages_getDialogs.md index 53f9ac62..1035e8ce 100644 --- a/old_docs/API_docs_v72/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v72/methods/messages_getDialogs.md @@ -12,11 +12,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|exclude\_pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -24,16 +24,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v72/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v72/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v72/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_getFavedStickers.md b/old_docs/API_docs_v72/methods/messages_getFavedStickers.md index 8ef3e565..dea1e5ec 100644 --- a/old_docs/API_docs_v72/methods/messages_getFavedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getFavedStickers.md @@ -12,7 +12,7 @@ Get favorite stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v72/methods/messages_getFeaturedStickers.md index 8e49e1ef..af7f69a0 100644 --- a/old_docs/API_docs_v72/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getFeaturedStickers.md @@ -12,7 +12,7 @@ Get featured stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getGameHighScores.md b/old_docs/API_docs_v72/methods/messages_getGameHighScores.md index 113e4647..af3f3915 100644 --- a/old_docs/API_docs_v72/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v72/methods/messages_getGameHighScores.md @@ -13,7 +13,7 @@ Get high scores of a game | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -22,14 +22,6 @@ Get high scores of a game ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -79,3 +71,11 @@ Or, if you're into Lua: messages_HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v72/methods/messages_getHistory.md b/old_docs/API_docs_v72/methods/messages_getHistory.md index 851d2680..86a744cf 100644 --- a/old_docs/API_docs_v72/methods/messages_getHistory.md +++ b/old_docs/API_docs_v72/methods/messages_getHistory.md @@ -13,12 +13,12 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -26,18 +26,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v72/methods/messages_getInlineBotResults.md index 4d86caf5..207624a7 100644 --- a/old_docs/API_docs_v72/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v72/methods/messages_getInlineBotResults.md @@ -14,9 +14,9 @@ Call inline bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -24,16 +24,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v72/methods/messages_getInlineGameHighScores.md index d5a80005..e03bc273 100644 --- a/old_docs/API_docs_v72/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v72/methods/messages_getInlineGameHighScores.md @@ -12,7 +12,7 @@ Get high scores of a game sent in an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -21,14 +21,6 @@ Get high scores of a game sent in an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v72/methods/messages_getMaskStickers.md b/old_docs/API_docs_v72/methods/messages_getMaskStickers.md index 70e2e6d4..1fbd9346 100644 --- a/old_docs/API_docs_v72/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getMaskStickers.md @@ -12,7 +12,7 @@ Get masks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getMessageEditData.md b/old_docs/API_docs_v72/methods/messages_getMessageEditData.md index 34f8534f..00c63d28 100644 --- a/old_docs/API_docs_v72/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v72/methods/messages_getMessageEditData.md @@ -13,7 +13,7 @@ Check if about to edit a message or a media caption | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) @@ -21,14 +21,6 @@ Check if about to edit a message or a media caption ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v72/methods/messages_getMessages.md b/old_docs/API_docs_v72/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v72/methods/messages_getMessages.md +++ b/old_docs/API_docs_v72/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v72/methods/messages_getMessagesViews.md b/old_docs/API_docs_v72/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v72/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v72/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v72/methods/messages_getPeerDialogs.md index 063b6e7d..000e8eb6 100644 --- a/old_docs/API_docs_v72/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v72/methods/messages_getPeerDialogs.md @@ -20,14 +20,6 @@ Get dialog info of peers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: messages_PeerDialogs = messages.getPeerDialogs({peers={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_getPeerSettings.md b/old_docs/API_docs_v72/methods/messages_getPeerSettings.md index a18126f0..5a3e9349 100644 --- a/old_docs/API_docs_v72/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v72/methods/messages_getPeerSettings.md @@ -20,14 +20,6 @@ Get the settings of apeer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: PeerSettings = messages.getPeerSettings({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_getRecentLocations.md b/old_docs/API_docs_v72/methods/messages_getRecentLocations.md index a1bad267..ab3fb8e4 100644 --- a/old_docs/API_docs_v72/methods/messages_getRecentLocations.md +++ b/old_docs/API_docs_v72/methods/messages_getRecentLocations.md @@ -13,7 +13,7 @@ Get recent locations | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to search locations| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v72/methods/messages_getRecentStickers.md b/old_docs/API_docs_v72/methods/messages_getRecentStickers.md index 0c5ae0c6..629a2bda 100644 --- a/old_docs/API_docs_v72/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getRecentStickers.md @@ -12,8 +12,8 @@ Get recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getSavedGifs.md b/old_docs/API_docs_v72/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v72/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v72/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v72/methods/messages_getStickerSet.md b/old_docs/API_docs_v72/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v72/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v72/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_getUnreadMentions.md b/old_docs/API_docs_v72/methods/messages_getUnreadMentions.md index b8d7b5a5..6abe55c6 100644 --- a/old_docs/API_docs_v72/methods/messages_getUnreadMentions.md +++ b/old_docs/API_docs_v72/methods/messages_getUnreadMentions.md @@ -13,11 +13,11 @@ Get unread mentions | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The offset| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|The additional offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|The minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The offset| +|add\_offset|[int](../types/int.md) | Yes|The additional offset| +|limit|[int](../types/int.md) | Yes|The number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|The minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -25,13 +25,6 @@ Get unread mentions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: messages_Messages = messages.getUnreadMentions({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_getWebPage.md b/old_docs/API_docs_v72/methods/messages_getWebPage.md index 19ca94b9..1b533ebd 100644 --- a/old_docs/API_docs_v72/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v72/methods/messages_getWebPage.md @@ -12,8 +12,8 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|url|[CLICK ME string](../types/string.md) | Yes|URL| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|url|[string](../types/string.md) | Yes|URL| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) @@ -21,13 +21,6 @@ Get webpage preview ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|WC_CONVERT_URL_INVALID|WC convert URL invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: WebPage = messages.getWebPage({url='string', hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|WC_CONVERT_URL_INVALID|WC convert URL invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v72/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v72/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v72/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v72/methods/messages_hideReportSpam.md b/old_docs/API_docs_v72/methods/messages_hideReportSpam.md index 30523f2a..0bf711ea 100644 --- a/old_docs/API_docs_v72/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v72/methods/messages_hideReportSpam.md @@ -20,13 +20,6 @@ Hide report spam popup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.hideReportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_importChatInvite.md b/old_docs/API_docs_v72/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v72/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v72/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v72/methods/messages_installStickerSet.md b/old_docs/API_docs_v72/methods/messages_installStickerSet.md index 20f90b71..d6caf555 100644 --- a/old_docs/API_docs_v72/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v72/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_migrateChat.md b/old_docs/API_docs_v72/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v72/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v72/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v72/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v72/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v72/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v72/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v72/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v72/methods/messages_readFeaturedStickers.md index 050371da..3b01171b 100644 --- a/old_docs/API_docs_v72/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_readFeaturedStickers.md @@ -12,7 +12,7 @@ Mark new featured stickers as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| +|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_readHistory.md b/old_docs/API_docs_v72/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v72/methods/messages_readHistory.md +++ b/old_docs/API_docs_v72/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/messages_readMessageContents.md b/old_docs/API_docs_v72/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v72/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v72/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v72/methods/messages_receivedMessages.md b/old_docs/API_docs_v72/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v72/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v72/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v72/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v72/methods/messages_reorderPinnedDialogs.md index 94d3b2d4..232117e8 100644 --- a/old_docs/API_docs_v72/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v72/methods/messages_reorderPinnedDialogs.md @@ -12,7 +12,7 @@ Reorder pinned dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|force|[Bool](../types/Bool.md) | Optional|Force reordering| |order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| @@ -21,13 +21,6 @@ Reorder pinned dialogs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.reorderPinnedDialogs({force=Bool, order={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v72/methods/messages_reorderStickerSets.md index 66f5e682..6a71da86 100644 --- a/old_docs/API_docs_v72/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v72/methods/messages_reorderStickerSets.md @@ -12,8 +12,8 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v72/methods/messages_reportEncryptedSpam.md index cd03c35c..988e0101 100644 --- a/old_docs/API_docs_v72/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v72/methods/messages_reportEncryptedSpam.md @@ -20,13 +20,6 @@ Report for spam a secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportEncryptedSpam({peer=InputEncryptedChat, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_reportSpam.md b/old_docs/API_docs_v72/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v72/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v72/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_saveDraft.md b/old_docs/API_docs_v72/methods/messages_saveDraft.md index 59b33b03..60d72c1e 100644 --- a/old_docs/API_docs_v72/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v72/methods/messages_saveDraft.md @@ -12,11 +12,11 @@ Save a message draft | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,13 +25,6 @@ Save a message draft ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -104,3 +97,10 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_saveGif.md b/old_docs/API_docs_v72/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v72/methods/messages_saveGif.md +++ b/old_docs/API_docs_v72/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v72/methods/messages_saveRecentSticker.md index 55757080..d2418881 100644 --- a/old_docs/API_docs_v72/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v72/methods/messages_saveRecentSticker.md @@ -12,9 +12,9 @@ Add a sticker to recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Add a sticker to recent stickers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.saveRecentSticker({attached=Bool, id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_search.md b/old_docs/API_docs_v72/methods/messages_search.md index 9253828a..96e0463e 100644 --- a/old_docs/API_docs_v72/methods/messages_search.md +++ b/old_docs/API_docs_v72/methods/messages_search.md @@ -13,16 +13,16 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| +|q|[string](../types/string.md) | Yes|What to search| |from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|Offset | -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message id to return| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset\_id|[int](../types/int.md) | Yes|Offset | +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of results to return| +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|min\_id|[int](../types/int.md) | Yes|Minumum message id to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -30,19 +30,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -99,3 +86,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', from_id=InputUser, filter=MessagesFilter, min_date=int, max_date=int, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_searchGifs.md b/old_docs/API_docs_v72/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v72/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v72/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v72/methods/messages_searchGlobal.md b/old_docs/API_docs_v72/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v72/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v72/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v72/methods/messages_sendEncrypted.md b/old_docs/API_docs_v72/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v72/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v72/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v72/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v72/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v72/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v72/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v72/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v72/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v72/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v72/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v72/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v72/methods/messages_sendInlineBotResult.md index 758aa97f..d1f9fbd0 100644 --- a/old_docs/API_docs_v72/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v72/methods/messages_sendInlineBotResult.md @@ -12,13 +12,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -26,18 +26,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v72/methods/messages_sendMedia.md b/old_docs/API_docs_v72/methods/messages_sendMedia.md index 770d1b65..94e27b83 100644 --- a/old_docs/API_docs_v72/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v72/methods/messages_sendMedia.md @@ -12,13 +12,13 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -26,34 +26,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -117,3 +89,31 @@ Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, pe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/messages_sendMessage.md b/old_docs/API_docs_v72/methods/messages_sendMessage.md index 83dc6c8b..ba76f230 100644 --- a/old_docs/API_docs_v72/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v72/methods/messages_sendMessage.md @@ -12,15 +12,15 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,33 +29,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -143,3 +116,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v72/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v72/methods/messages_sendScreenshotNotification.md index e823fd52..9db86b56 100644 --- a/old_docs/API_docs_v72/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v72/methods/messages_sendScreenshotNotification.md @@ -13,7 +13,7 @@ Send screenshot notification | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Send screenshot notification ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = messages.sendScreenshotNotification({peer=InputPeer, reply_to_msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v72/methods/messages_setBotCallbackAnswer.md index e221ccca..34c7bb16 100644 --- a/old_docs/API_docs_v72/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v72/methods/messages_setBotCallbackAnswer.md @@ -12,11 +12,11 @@ Bots only: set the callback answer (after a button was clicked) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|message|[CLICK ME string](../types/string.md) | Optional|The message| -|url|[CLICK ME string](../types/string.md) | Optional|The URL| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| +|url|[string](../types/string.md) | Optional|The URL| +|cache\_time|[int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) @@ -24,13 +24,6 @@ Bots only: set the callback answer (after a button was clicked) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -90,3 +83,10 @@ Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v72/methods/messages_setBotPrecheckoutResults.md index 7e3fc3c2..f631bf0c 100644 --- a/old_docs/API_docs_v72/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v72/methods/messages_setBotPrecheckoutResults.md @@ -12,9 +12,9 @@ Bots only: set precheckout results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| +|success|[Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set precheckout results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ERROR_TEXT_EMPTY|The provided error message is empty| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotPrecheckoutResults({success=Bool, query_id=long, error='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ERROR_TEXT_EMPTY|The provided error message is empty| + + diff --git a/old_docs/API_docs_v72/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v72/methods/messages_setBotShippingResults.md index 3d9f0ae2..915cfebf 100644 --- a/old_docs/API_docs_v72/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v72/methods/messages_setBotShippingResults.md @@ -12,9 +12,9 @@ Bots only: set shipping results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set shipping results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotShippingResults({query_id=long, error='string', shipping_options={ShippingOption}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v72/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v72/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v72/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_setGameScore.md b/old_docs/API_docs_v72/methods/messages_setGameScore.md index 90594a1d..c3d5a2c7 100644 --- a/old_docs/API_docs_v72/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v72/methods/messages_setGameScore.md @@ -12,12 +12,12 @@ Set the game score | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) @@ -25,14 +25,6 @@ Set the game score ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: Updates = messages.setGameScore({edit_message=Bool, force=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v72/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v72/methods/messages_setInlineBotResults.md index d4ba6e65..e46598e2 100644 --- a/old_docs/API_docs_v72/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v72/methods/messages_setInlineBotResults.md @@ -12,13 +12,13 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) @@ -26,23 +26,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -100,3 +83,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v72/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v72/methods/messages_setInlineGameScore.md index 2b7326f3..d33da5ef 100644 --- a/old_docs/API_docs_v72/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v72/methods/messages_setInlineGameScore.md @@ -12,11 +12,11 @@ Set the game score of an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) @@ -24,14 +24,6 @@ Set the game score of an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -85,3 +77,11 @@ Or, if you're into Lua: Bool = messages.setInlineGameScore({edit_message=Bool, force=Bool, id=InputBotInlineMessageID, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v72/methods/messages_setTyping.md b/old_docs/API_docs_v72/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v72/methods/messages_setTyping.md +++ b/old_docs/API_docs_v72/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v72/methods/messages_startBot.md b/old_docs/API_docs_v72/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v72/methods/messages_startBot.md +++ b/old_docs/API_docs_v72/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v72/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v72/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v72/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v72/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v72/methods/messages_toggleDialogPin.md index 14332533..6c57ce0a 100644 --- a/old_docs/API_docs_v72/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v72/methods/messages_toggleDialogPin.md @@ -12,7 +12,7 @@ Pin or unpin dialog | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| @@ -21,13 +21,6 @@ Pin or unpin dialog ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.toggleDialogPin({pinned=Bool, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v72/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v72/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v72/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v72/methods/messages_uploadMedia.md b/old_docs/API_docs_v72/methods/messages_uploadMedia.md index c09da017..4d511a15 100644 --- a/old_docs/API_docs_v72/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v72/methods/messages_uploadMedia.md @@ -21,15 +21,6 @@ Upload a file without sending it to anyone ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|MEDIA_INVALID|Media invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: MessageMedia = messages.uploadMedia({peer=InputPeer, media=InputMedia, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|MEDIA_INVALID|Media invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v72/methods/payments_clearSavedInfo.md index 8b83266f..117db209 100644 --- a/old_docs/API_docs_v72/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v72/methods/payments_clearSavedInfo.md @@ -12,8 +12,8 @@ Clear saved payments info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| +|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/payments_getPaymentForm.md b/old_docs/API_docs_v72/methods/payments_getPaymentForm.md index 3bdb9ff2..f68aa039 100644 --- a/old_docs/API_docs_v72/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v72/methods/payments_getPaymentForm.md @@ -12,7 +12,7 @@ Get payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|msg\_id|[int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) @@ -20,13 +20,6 @@ Get payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentForm = payments.getPaymentForm({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v72/methods/payments_getPaymentReceipt.md index a881aeb7..13073925 100644 --- a/old_docs/API_docs_v72/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v72/methods/payments_getPaymentReceipt.md @@ -12,7 +12,7 @@ Get payment receipt | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|msg\_id|[int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) @@ -20,13 +20,6 @@ Get payment receipt ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentReceipt = payments.getPaymentReceipt({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v72/methods/payments_sendPaymentForm.md index 79758b56..678b749b 100644 --- a/old_docs/API_docs_v72/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v72/methods/payments_sendPaymentForm.md @@ -12,10 +12,10 @@ Bots only: send payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +|msg\_id|[int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) @@ -23,13 +23,6 @@ Bots only: send payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: payments_PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v72/methods/payments_validateRequestedInfo.md index d473f97c..df6a9ba9 100644 --- a/old_docs/API_docs_v72/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v72/methods/payments_validateRequestedInfo.md @@ -12,9 +12,9 @@ Validate requested payment info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +|save|[Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) @@ -22,13 +22,6 @@ Validate requested payment info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: payments_ValidatedRequestedInfo = payments.validateRequestedInfo({save=Bool, msg_id=int, info=PaymentRequestedInfo, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v72/methods/phone_receivedCall.md b/old_docs/API_docs_v72/methods/phone_receivedCall.md index 17095622..6141a0ab 100644 --- a/old_docs/API_docs_v72/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v72/methods/phone_receivedCall.md @@ -12,7 +12,7 @@ Notify server that you received a call (server will refuse all incoming calls un | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| ### Return type: [Bool](../types/Bool.md) @@ -20,14 +20,6 @@ Notify server that you received a call (server will refuse all incoming calls un ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_ALREADY_DECLINED|The call was already declined| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = phone.receivedCall({peer=InputPhoneCall, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_ALREADY_DECLINED|The call was already declined| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v72/methods/phone_saveCallDebug.md b/old_docs/API_docs_v72/methods/phone_saveCallDebug.md index 0ff049a8..9f3daa18 100644 --- a/old_docs/API_docs_v72/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v72/methods/phone_saveCallDebug.md @@ -12,8 +12,8 @@ Save call debugging info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Debugging info| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| +|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Save call debugging info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| -|DATA_JSON_INVALID|The provided JSON data is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = phone.saveCallDebug({peer=InputPhoneCall, debug=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| +|DATA_JSON_INVALID|The provided JSON data is invalid| + + diff --git a/old_docs/API_docs_v72/methods/phone_setCallRating.md b/old_docs/API_docs_v72/methods/phone_setCallRating.md index d0aab7e0..d9833492 100644 --- a/old_docs/API_docs_v72/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v72/methods/phone_setCallRating.md @@ -12,9 +12,9 @@ Set phone call rating | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[CLICK ME int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[CLICK ME string](../types/string.md) | Yes|An optional comment| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| +|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| +|comment|[string](../types/string.md) | Yes|An optional comment| ### Return type: [Updates](../types/Updates.md) @@ -22,13 +22,6 @@ Set phone call rating ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Updates = phone.setCallRating({peer=InputPhoneCall, rating=int, comment='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v72/methods/photos_getUserPhotos.md b/old_docs/API_docs_v72/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v72/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v72/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v72/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v72/methods/photos_uploadProfilePhoto.md index c7ec3063..0c994ffe 100644 --- a/old_docs/API_docs_v72/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v72/methods/photos_uploadProfilePhoto.md @@ -20,16 +20,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -66,3 +56,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v72/methods/ping.md b/old_docs/API_docs_v72/methods/ping.md index f987ae89..daf1cc65 100644 --- a/old_docs/API_docs_v72/methods/ping.md +++ b/old_docs/API_docs_v72/methods/ping.md @@ -12,7 +12,7 @@ pings the server | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v72/methods/ping_delay_disconnect.md b/old_docs/API_docs_v72/methods/ping_delay_disconnect.md index 5b1c115d..66cc3704 100644 --- a/old_docs/API_docs_v72/methods/ping_delay_disconnect.md +++ b/old_docs/API_docs_v72/methods/ping_delay_disconnect.md @@ -12,8 +12,8 @@ Pings the server and causes disconection if the same method is not called within | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ping\_id|[CLICK ME long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[CLICK ME int](../types/int.md) | Yes|Disconection delay| +|ping\_id|[long](../types/long.md) | Yes|Ping ID| +|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v72/methods/req_DH_params.md b/old_docs/API_docs_v72/methods/req_DH_params.md index f0b45851..a426c699 100644 --- a/old_docs/API_docs_v72/methods/req_DH_params.md +++ b/old_docs/API_docs_v72/methods/req_DH_params.md @@ -12,12 +12,12 @@ Requests Diffie-hellman parameters for key exchange | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[CLICK ME string](../types/string.md) | Yes|factorized p from pq| -|q|[CLICK ME string](../types/string.md) | Yes|factorized q from pq| -|public\_key\_fingerprint|[CLICK ME long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[CLICK ME string](../types/string.md) | Yes|Encrypted message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|p|[string](../types/string.md) | Yes|factorized p from pq| +|q|[string](../types/string.md) | Yes|factorized q from pq| +|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| +|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/old_docs/API_docs_v72/methods/req_pq.md b/old_docs/API_docs_v72/methods/req_pq.md index 0873d9a2..d273a0b9 100644 --- a/old_docs/API_docs_v72/methods/req_pq.md +++ b/old_docs/API_docs_v72/methods/req_pq.md @@ -12,7 +12,7 @@ Requests PQ for factorization | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/old_docs/API_docs_v72/methods/rpc_drop_answer.md b/old_docs/API_docs_v72/methods/rpc_drop_answer.md index 27f98bca..34b355f3 100644 --- a/old_docs/API_docs_v72/methods/rpc_drop_answer.md +++ b/old_docs/API_docs_v72/methods/rpc_drop_answer.md @@ -12,7 +12,7 @@ Do not send answer to provided request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|req\_msg\_id|[CLICK ME long](../types/long.md) | Yes|The message ID of the request| +|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/old_docs/API_docs_v72/methods/set_client_DH_params.md b/old_docs/API_docs_v72/methods/set_client_DH_params.md index cf8ab321..5a173688 100644 --- a/old_docs/API_docs_v72/methods/set_client_DH_params.md +++ b/old_docs/API_docs_v72/methods/set_client_DH_params.md @@ -12,9 +12,9 @@ Sets client diffie-hellman parameters | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[CLICK ME int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[CLICK ME string](../types/string.md) | Yes|Encrypted message| +|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| +|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/old_docs/API_docs_v72/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v72/methods/stickers_addStickerToSet.md index 7c4191d8..6e1d680c 100644 --- a/old_docs/API_docs_v72/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v72/methods/stickers_addStickerToSet.md @@ -12,8 +12,8 @@ Add sticker to stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -21,14 +21,6 @@ Add sticker to stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.addStickerToSet({stickerset=InputStickerSet, sticker=InputStickerSetItem, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v72/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v72/methods/stickers_changeStickerPosition.md index d25129c5..6e8e2505 100644 --- a/old_docs/API_docs_v72/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v72/methods/stickers_changeStickerPosition.md @@ -13,7 +13,7 @@ Change sticker position in photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[CLICK ME int](../types/int.md) | Yes|New position| +|position|[int](../types/int.md) | Yes|New position| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -21,14 +21,6 @@ Change sticker position in photo ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKER_INVALID|The provided sticker is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.changeStickerPosition({sticker=InputDocument, position=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v72/methods/stickers_createStickerSet.md b/old_docs/API_docs_v72/methods/stickers_createStickerSet.md index 95775849..371033ca 100644 --- a/old_docs/API_docs_v72/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v72/methods/stickers_createStickerSet.md @@ -12,11 +12,11 @@ Create stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Masks?| +|masks|[Bool](../types/Bool.md) | Optional|Masks?| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[CLICK ME string](../types/string.md) | Yes|The stickerset title| -|short\_name|[CLICK ME string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +|title|[string](../types/string.md) | Yes|The stickerset title| +|short\_name|[string](../types/string.md) | Yes|The stickerset short name| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -24,21 +24,6 @@ Create stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|PACK_SHORT_NAME_INVALID|Short pack name invalid| -|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| -|PEER_ID_INVALID|The provided peer id is invalid| -|STICKER_EMOJI_INVALID|Sticker emoji invalid| -|STICKER_FILE_INVALID|Sticker file invalid| -|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| -|STICKERS_EMPTY|No sticker provided| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -92,3 +77,18 @@ Or, if you're into Lua: messages_StickerSet = stickers.createStickerSet({masks=Bool, user_id=InputUser, title='string', short_name='string', stickers={InputStickerSetItem}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|PACK_SHORT_NAME_INVALID|Short pack name invalid| +|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| +|PEER_ID_INVALID|The provided peer id is invalid| +|STICKER_EMOJI_INVALID|Sticker emoji invalid| +|STICKER_FILE_INVALID|Sticker file invalid| +|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| +|STICKERS_EMPTY|No sticker provided| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v72/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v72/methods/stickers_removeStickerFromSet.md index 73ed78d5..5e3a4291 100644 --- a/old_docs/API_docs_v72/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v72/methods/stickers_removeStickerFromSet.md @@ -20,14 +20,6 @@ Remove sticker from stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKER_INVALID|The provided sticker is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.removeStickerFromSet({sticker=InputDocument, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v72/methods/upload_getWebFile.md b/old_docs/API_docs_v72/methods/upload_getWebFile.md index 11634633..f869519a 100644 --- a/old_docs/API_docs_v72/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v72/methods/upload_getWebFile.md @@ -12,9 +12,9 @@ Download a file through telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[int](../types/int.md) | Yes|The offset in bytes| +|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) @@ -22,13 +22,6 @@ Download a file through telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LOCATION_INVALID|The provided location is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: upload_WebFile = upload.getWebFile({location=InputWebFileLocation, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LOCATION_INVALID|The provided location is invalid| + + diff --git a/old_docs/API_docs_v72/methods/users_getUsers.md b/old_docs/API_docs_v72/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v72/methods/users_getUsers.md +++ b/old_docs/API_docs_v72/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/account_changePhone.md b/old_docs/API_docs_v73/methods/account_changePhone.md index 65f0b0d0..30ef40e4 100644 --- a/old_docs/API_docs_v73/methods/account_changePhone.md +++ b/old_docs/API_docs_v73/methods/account_changePhone.md @@ -12,9 +12,9 @@ Change the phone number associated to this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| ### Return type: [User](../types/User.md) @@ -22,13 +22,6 @@ Change the phone number associated to this account ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_checkUsername.md b/old_docs/API_docs_v73/methods/account_checkUsername.md index 08107762..2185b32d 100644 --- a/old_docs/API_docs_v73/methods/account_checkUsername.md +++ b/old_docs/API_docs_v73/methods/account_checkUsername.md @@ -12,7 +12,7 @@ Check if this username is available | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The username to check| +|username|[string](../types/string.md) | Yes|The username to check| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Check if this username is available ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.checkUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v73/methods/account_confirmPhone.md b/old_docs/API_docs_v73/methods/account_confirmPhone.md index 68490f35..7ffabc24 100644 --- a/old_docs/API_docs_v73/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v73/methods/account_confirmPhone.md @@ -12,8 +12,8 @@ Confirm this phone number is associated to this account, obtain phone_code_hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| -|phone\_code|[CLICK ME string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| +|phone\_code\_hash|[string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Confirm this phone number is associated to this account, obtain phone_code_hash ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_HASH_INVALID|Code hash invalid| -|PHONE_CODE_EMPTY|phone_code is missing| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_HASH_INVALID|Code hash invalid| +|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/old_docs/API_docs_v73/methods/account_deleteAccount.md b/old_docs/API_docs_v73/methods/account_deleteAccount.md index 3a6f4700..401680e4 100644 --- a/old_docs/API_docs_v73/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v73/methods/account_deleteAccount.md @@ -12,7 +12,7 @@ Delete this account | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reason|[CLICK ME string](../types/string.md) | Yes|Why are you going away? :(| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/account_getNotifySettings.md b/old_docs/API_docs_v73/methods/account_getNotifySettings.md index ad492f49..2967148c 100644 --- a/old_docs/API_docs_v73/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v73/methods/account_getNotifySettings.md @@ -12,7 +12,7 @@ Get notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | ### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) @@ -20,13 +20,6 @@ Get notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_getPasswordSettings.md b/old_docs/API_docs_v73/methods/account_getPasswordSettings.md index 2039d405..0075005d 100644 --- a/old_docs/API_docs_v73/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v73/methods/account_getPasswordSettings.md @@ -12,7 +12,7 @@ Get the current 2FA settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| ### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) @@ -20,13 +20,6 @@ Get the current 2FA settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_getPrivacy.md b/old_docs/API_docs_v73/methods/account_getPrivacy.md index 5480ffbb..2fd4a90e 100644 --- a/old_docs/API_docs_v73/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v73/methods/account_getPrivacy.md @@ -12,7 +12,7 @@ Get privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -20,13 +20,6 @@ Get privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_getTmpPassword.md b/old_docs/API_docs_v73/methods/account_getTmpPassword.md index 01b1ebfc..c82ff37a 100644 --- a/old_docs/API_docs_v73/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v73/methods/account_getTmpPassword.md @@ -12,8 +12,8 @@ Get temporary password for buying products through bots | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|The password hash| -|period|[CLICK ME int](../types/int.md) | Yes|The validity period| +|password\_hash|[bytes](../types/bytes.md) | Yes|The password hash| +|period|[int](../types/int.md) | Yes|The validity period| ### Return type: [account\_TmpPassword](../types/account_TmpPassword.md) @@ -21,14 +21,6 @@ Get temporary password for buying products through bots ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| -|TMP_PASSWORD_DISABLED|The temporary password is disabled| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: account_TmpPassword = account.getTmpPassword({password_hash='bytes', period=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|TMP_PASSWORD_DISABLED|The temporary password is disabled| + + diff --git a/old_docs/API_docs_v73/methods/account_registerDevice.md b/old_docs/API_docs_v73/methods/account_registerDevice.md index 4e148a7f..cbac71d3 100644 --- a/old_docs/API_docs_v73/methods/account_registerDevice.md +++ b/old_docs/API_docs_v73/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Register device for push notifications ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.registerDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_reportPeer.md b/old_docs/API_docs_v73/methods/account_reportPeer.md index c5fe7073..60205334 100644 --- a/old_docs/API_docs_v73/methods/account_reportPeer.md +++ b/old_docs/API_docs_v73/methods/account_reportPeer.md @@ -13,7 +13,7 @@ Report for spam | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| -|reason|[CLICK ME ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Report for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_resetAuthorization.md b/old_docs/API_docs_v73/methods/account_resetAuthorization.md index 543aee08..80f4ddcd 100644 --- a/old_docs/API_docs_v73/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v73/methods/account_resetAuthorization.md @@ -12,7 +12,7 @@ Delete a certain session | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Delete a certain session ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.resetAuthorization({hash=long, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v73/methods/account_sendChangePhoneCode.md index bdf7331f..476b6d79 100644 --- a/old_docs/API_docs_v73/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v73/methods/account_sendChangePhoneCode.md @@ -12,9 +12,9 @@ Change the phone number | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|New phone number| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|Current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Change the phone number ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v73/methods/account_sendConfirmPhoneCode.md index 86035d19..8917355f 100644 --- a/old_docs/API_docs_v73/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v73/methods/account_sendConfirmPhoneCode.md @@ -12,9 +12,9 @@ Send confirmation phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|allow\_flashcall|[CLICK ME Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| -|hash|[CLICK ME string](../types/string.md) | Yes|The hash| -|current\_number|[CLICK ME Bool](../types/Bool.md) | Optional|The current phone number| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| +|hash|[string](../types/string.md) | Yes|The hash| +|current\_number|[Bool](../types/Bool.md) | Optional|The current phone number| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -22,13 +22,6 @@ Send confirmation phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|HASH_INVALID|The provided hash is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: auth_SentCode = account.sendConfirmPhoneCode({allow_flashcall=Bool, hash='string', current_number=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_setAccountTTL.md b/old_docs/API_docs_v73/methods/account_setAccountTTL.md index bacdd77a..70f131ef 100644 --- a/old_docs/API_docs_v73/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v73/methods/account_setAccountTTL.md @@ -12,7 +12,7 @@ Set account TTL | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ttl|[CLICK ME AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Set account TTL ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TTL_DAYS_INVALID|The provided TTL is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_setPrivacy.md b/old_docs/API_docs_v73/methods/account_setPrivacy.md index 6e24ded7..5c8fbd08 100644 --- a/old_docs/API_docs_v73/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v73/methods/account_setPrivacy.md @@ -12,8 +12,8 @@ Set privacy settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|key|[CLICK ME InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| -|rules|Array of [CLICK ME InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| ### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) @@ -21,13 +21,6 @@ Set privacy settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PRIVACY_KEY_INVALID|The privacy key is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_unregisterDevice.md b/old_docs/API_docs_v73/methods/account_unregisterDevice.md index b666d91a..c61aa3cb 100644 --- a/old_docs/API_docs_v73/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v73/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Stop sending PUSH notifications to app ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TOKEN_INVALID|The provided token is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.unregisterDevice({token_type=int, token='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v73/methods/account_updateDeviceLocked.md index cd52093a..32497ee3 100644 --- a/old_docs/API_docs_v73/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v73/methods/account_updateDeviceLocked.md @@ -12,7 +12,7 @@ Disable all notifications for a certain period | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|period|[CLICK ME int](../types/int.md) | Yes|For how long should notifications be disabled| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/account_updateNotifySettings.md b/old_docs/API_docs_v73/methods/account_updateNotifySettings.md index db020309..729bfe3e 100644 --- a/old_docs/API_docs_v73/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v73/methods/account_updateNotifySettings.md @@ -12,8 +12,8 @@ Change notification settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| -|settings|[CLICK ME InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Change notification settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v73/methods/account_updatePasswordSettings.md index 8af1e37f..24491558 100644 --- a/old_docs/API_docs_v73/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v73/methods/account_updatePasswordSettings.md @@ -12,8 +12,8 @@ Update the 2FA password settings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| -|new\_settings|[CLICK ME account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Update the 2FA password settings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EMAIL_UNCONFIRMED|Email unconfirmed| -|NEW_SALT_INVALID|The new salt is invalid| -|NEW_SETTINGS_INVALID|The new settings are invalid| -|PASSWORD_HASH_INVALID|The provided password hash is invalid| - - ### MadelineProto Example: @@ -69,3 +59,13 @@ Or, if you're into Lua: Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_updateProfile.md b/old_docs/API_docs_v73/methods/account_updateProfile.md index 59629188..ef19dc00 100644 --- a/old_docs/API_docs_v73/methods/account_updateProfile.md +++ b/old_docs/API_docs_v73/methods/account_updateProfile.md @@ -12,9 +12,9 @@ Update profile info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|first\_name|[CLICK ME string](../types/string.md) | Optional|The first name| -|last\_name|[CLICK ME string](../types/string.md) | Optional|The last name| -|about|[CLICK ME string](../types/string.md) | Optional|The bio/about field| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| ### Return type: [User](../types/User.md) @@ -22,14 +22,6 @@ Update profile info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ABOUT_TOO_LONG|The provided bio is too long| -|FIRSTNAME_INVALID|The first name is invalid| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v73/methods/account_updateStatus.md b/old_docs/API_docs_v73/methods/account_updateStatus.md index 50b99b1e..e4ee3750 100644 --- a/old_docs/API_docs_v73/methods/account_updateStatus.md +++ b/old_docs/API_docs_v73/methods/account_updateStatus.md @@ -12,7 +12,7 @@ Update online status | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offline|[CLICK ME Bool](../types/Bool.md) | Yes|offline to set the status to offline| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Update online status ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = account.updateStatus({offline=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v73/methods/account_updateUsername.md b/old_docs/API_docs_v73/methods/account_updateUsername.md index 7276e2aa..afe7f58d 100644 --- a/old_docs/API_docs_v73/methods/account_updateUsername.md +++ b/old_docs/API_docs_v73/methods/account_updateUsername.md @@ -12,7 +12,7 @@ Update this user's username | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [User](../types/User.md) @@ -20,15 +20,6 @@ Update this user's username ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_NOT_MODIFIED|The username was not modified| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: User = account.updateUsername({username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v73/methods/auth_cancelCode.md b/old_docs/API_docs_v73/methods/auth_cancelCode.md index 52b85d4c..84401c62 100644 --- a/old_docs/API_docs_v73/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v73/methods/auth_cancelCode.md @@ -12,8 +12,8 @@ Invalidate sent phone code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invalidate sent phone code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v73/methods/auth_checkPhone.md b/old_docs/API_docs_v73/methods/auth_checkPhone.md index 1826ce63..1b16eff9 100644 --- a/old_docs/API_docs_v73/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v73/methods/auth_checkPhone.md @@ -12,7 +12,7 @@ Check if this phone number is registered on telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check| +|phone\_number|[string](../types/string.md) | Yes|The phone number to check| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) @@ -20,15 +20,6 @@ Check if this phone number is registered on telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|PHONE_NUMBER_INVALID|The phone number is invalid| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: auth_CheckedPhone = auth.checkPhone({phone_number='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|PHONE_NUMBER_INVALID|The phone number is invalid| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v73/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v73/methods/auth_dropTempAuthKeys.md index 5aa98b3b..537afbc1 100644 --- a/old_docs/API_docs_v73/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v73/methods/auth_dropTempAuthKeys.md @@ -12,7 +12,7 @@ Delete all temporary authorization keys except the ones provided | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_auth\_keys|Array of [CLICK ME long](../types/long.md) | Yes|The temporary authorization keys to keep| +|except\_auth\_keys|Array of [long](../types/long.md) | Yes|The temporary authorization keys to keep| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/auth_recoverPassword.md b/old_docs/API_docs_v73/methods/auth_recoverPassword.md index 5e37b0f3..238e893a 100644 --- a/old_docs/API_docs_v73/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v73/methods/auth_recoverPassword.md @@ -12,7 +12,7 @@ Use the code that was emailed to you after running $MadelineProto->auth->request | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[CLICK ME string](../types/string.md) | Yes|The code that was emailed to you| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| ### Return type: [auth\_Authorization](../types/auth_Authorization.md) @@ -20,13 +20,6 @@ Use the code that was emailed to you after running $MadelineProto->auth->request ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CODE_EMPTY|The provided code is empty| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: auth_Authorization = auth.recoverPassword({code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v73/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v73/methods/auth_requestPasswordRecovery.md index c69d0c49..e4de900d 100644 --- a/old_docs/API_docs_v73/methods/auth_requestPasswordRecovery.md +++ b/old_docs/API_docs_v73/methods/auth_requestPasswordRecovery.md @@ -15,13 +15,6 @@ Send an email to recover the 2FA password ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PASSWORD_EMPTY|The provided password is empty| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: auth_PasswordRecovery = auth.requestPasswordRecovery({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v73/methods/auth_resendCode.md b/old_docs/API_docs_v73/methods/auth_resendCode.md index 253480a3..4402bfe6 100644 --- a/old_docs/API_docs_v73/methods/auth_resendCode.md +++ b/old_docs/API_docs_v73/methods/auth_resendCode.md @@ -12,8 +12,8 @@ Resend the SMS verification code | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number| -|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) @@ -21,13 +21,6 @@ Resend the SMS verification code ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PHONE_NUMBER_INVALID|The phone number is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v73/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v73/methods/auth_resetAuthorizations.md index a46c880d..a45f8fe6 100644 --- a/old_docs/API_docs_v73/methods/auth_resetAuthorizations.md +++ b/old_docs/API_docs_v73/methods/auth_resetAuthorizations.md @@ -15,13 +15,6 @@ Delete all logged-in sessions. ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Bool = auth.resetAuthorizations({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/auth_sendInvites.md b/old_docs/API_docs_v73/methods/auth_sendInvites.md index 9b88b4a3..e4af744d 100644 --- a/old_docs/API_docs_v73/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v73/methods/auth_sendInvites.md @@ -12,8 +12,8 @@ Invite friends to telegram! | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_numbers|Array of [CLICK ME string](../types/string.md) | Yes|Phone numbers to invite| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| +|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| +|message|[string](../types/string.md) | Yes|The message to send| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Invite friends to telegram! ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_EMPTY|The provided message is empty| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v73/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v73/methods/bots_answerWebhookJSONQuery.md index 40cb0477..3dbf62ef 100644 --- a/old_docs/API_docs_v73/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v73/methods/bots_answerWebhookJSONQuery.md @@ -12,8 +12,8 @@ Send webhook request via bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|data|[DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Send webhook request via bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Bool = bots.answerWebhookJSONQuery({query_id=long, data=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v73/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v73/methods/bots_sendCustomRequest.md index 5a7f4e86..cb7c32e2 100644 --- a/old_docs/API_docs_v73/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v73/methods/bots_sendCustomRequest.md @@ -12,8 +12,8 @@ Send a custom request to the bot API | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| +|custom\_method|[string](../types/string.md) | Yes|The method to call| +|params|[DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) @@ -21,13 +21,6 @@ Send a custom request to the bot API ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: DataJSON = bots.sendCustomRequest({custom_method='string', params=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v73/methods/channels_checkUsername.md b/old_docs/API_docs_v73/methods/channels_checkUsername.md index 7e3d5a89..244d17b0 100644 --- a/old_docs/API_docs_v73/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v73/methods/channels_checkUsername.md @@ -13,7 +13,7 @@ Check if this username is free and can be assigned to a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) @@ -21,15 +21,6 @@ Check if this username is free and can be assigned to a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ID_INVALID|The provided chat id is invalid| -|USERNAME_INVALID|The provided username is not valid| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Bool = channels.checkUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v73/methods/channels_createChannel.md b/old_docs/API_docs_v73/methods/channels_createChannel.md index a5ddc379..c8a69a30 100644 --- a/old_docs/API_docs_v73/methods/channels_createChannel.md +++ b/old_docs/API_docs_v73/methods/channels_createChannel.md @@ -12,10 +12,10 @@ Create channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| -|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| -|about|[CLICK ME string](../types/string.md) | Yes|About text| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) @@ -23,14 +23,6 @@ Create channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_TITLE_EMPTY|No chat title provided| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v73/methods/channels_deleteChannel.md b/old_docs/API_docs_v73/methods/channels_deleteChannel.md index 69dad9a3..90dc02d3 100644 --- a/old_docs/API_docs_v73/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v73/methods/channels_deleteChannel.md @@ -20,14 +20,6 @@ Delete a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Updates = channels.deleteChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v73/methods/channels_deleteHistory.md b/old_docs/API_docs_v73/methods/channels_deleteHistory.md index 856a32e8..f7c225f6 100644 --- a/old_docs/API_docs_v73/methods/channels_deleteHistory.md +++ b/old_docs/API_docs_v73/methods/channels_deleteHistory.md @@ -13,7 +13,7 @@ Delete the history of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to delete| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/channels_deleteMessages.md b/old_docs/API_docs_v73/methods/channels_deleteMessages.md index b12270b3..2cea7935 100644 --- a/old_docs/API_docs_v73/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v73/methods/channels_deleteMessages.md @@ -13,7 +13,7 @@ Delete channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,15 +21,6 @@ Delete channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v73/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v73/methods/channels_deleteUserHistory.md index 75f531bb..331aabd9 100644 --- a/old_docs/API_docs_v73/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v73/methods/channels_deleteUserHistory.md @@ -21,14 +21,6 @@ Delete all messages of a user in a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v73/methods/channels_editAbout.md b/old_docs/API_docs_v73/methods/channels_editAbout.md index 67521065..a4154565 100644 --- a/old_docs/API_docs_v73/methods/channels_editAbout.md +++ b/old_docs/API_docs_v73/methods/channels_editAbout.md @@ -13,7 +13,7 @@ Edit the about text of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|about|[CLICK ME string](../types/string.md) | Yes|The new about text| +|about|[string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) @@ -21,16 +21,6 @@ Edit the about text of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|CHAT_ABOUT_TOO_LONG|Chat about too long| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Bool = channels.editAbout({channel=InputChannel, about='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v73/methods/channels_editAdmin.md b/old_docs/API_docs_v73/methods/channels_editAdmin.md index 7cecbd64..f08473eb 100644 --- a/old_docs/API_docs_v73/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v73/methods/channels_editAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| +|admin\_rights|[ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| ### Return type: [Updates](../types/Updates.md) @@ -22,22 +22,6 @@ Edit admin permissions of a user in a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ADMINS_TOO_MUCH|Too many admins| -|BOT_CHANNELS_NA|Bots can't edit admin privileges| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| -|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -87,3 +71,19 @@ Or, if you're into Lua: Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, admin_rights=ChannelAdminRights, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v73/methods/channels_editBanned.md b/old_docs/API_docs_v73/methods/channels_editBanned.md index ca9f2596..03dc70a5 100644 --- a/old_docs/API_docs_v73/methods/channels_editBanned.md +++ b/old_docs/API_docs_v73/methods/channels_editBanned.md @@ -14,7 +14,7 @@ Kick or ban a user from a channel/supergroup |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban| -|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| +|banned\_rights|[ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| ### Return type: [Updates](../types/Updates.md) @@ -22,17 +22,6 @@ Kick or ban a user from a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ADMIN_INVALID|You're not an admin| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +71,14 @@ Or, if you're into Lua: Updates = channels.editBanned({channel=InputChannel, user_id=InputUser, banned_rights=ChannelBannedRights, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ADMIN_INVALID|You're not an admin| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v73/methods/channels_editPhoto.md b/old_docs/API_docs_v73/methods/channels_editPhoto.md index c854c64a..39bc93a1 100644 --- a/old_docs/API_docs_v73/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v73/methods/channels_editPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the photo of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|PHOTO_INVALID|Photo invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v73/methods/channels_editTitle.md b/old_docs/API_docs_v73/methods/channels_editTitle.md index 9bc6773e..3265ff39 100644 --- a/old_docs/API_docs_v73/methods/channels_editTitle.md +++ b/old_docs/API_docs_v73/methods/channels_editTitle.md @@ -13,7 +13,7 @@ Edit the title of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Edit the title of a supergroup/channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = channels.editTitle({channel=InputChannel, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v73/methods/channels_exportInvite.md b/old_docs/API_docs_v73/methods/channels_exportInvite.md index ca65dcc8..492dc4dd 100644 --- a/old_docs/API_docs_v73/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v73/methods/channels_exportInvite.md @@ -20,15 +20,6 @@ Export the invite link of a channel ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INVITE_HASH_EXPIRED|The invite link has expired| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v73/methods/channels_exportMessageLink.md b/old_docs/API_docs_v73/methods/channels_exportMessageLink.md index b4a3c645..20f6e998 100644 --- a/old_docs/API_docs_v73/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v73/methods/channels_exportMessageLink.md @@ -13,7 +13,7 @@ Get the link of a message in a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| +|id|[int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -21,13 +21,6 @@ Get the link of a message in a channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v73/methods/channels_getAdminLog.md b/old_docs/API_docs_v73/methods/channels_getAdminLog.md index 4a419778..1ffcf5c3 100644 --- a/old_docs/API_docs_v73/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v73/methods/channels_getAdminLog.md @@ -13,12 +13,12 @@ Get admin log of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|q|[CLICK ME string](../types/string.md) | Yes|Search query| -|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| +|q|[string](../types/string.md) | Yes|Search query| +|events\_filter|[ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| |admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME long](../types/long.md) | Yes|Minimum message ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[long](../types/long.md) | Yes|Maximum message ID to fetch| +|min\_id|[long](../types/long.md) | Yes|Minimum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) @@ -26,15 +26,6 @@ Get admin log of a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -83,3 +74,12 @@ Or, if you're into Lua: channels_AdminLogResults = channels.getAdminLog({channel=InputChannel, q='string', events_filter=ChannelAdminLogEventsFilter, admins={InputUser}, max_id=long, min_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v73/methods/channels_getChannels.md b/old_docs/API_docs_v73/methods/channels_getChannels.md index af22556f..1e9bfe7d 100644 --- a/old_docs/API_docs_v73/methods/channels_getChannels.md +++ b/old_docs/API_docs_v73/methods/channels_getChannels.md @@ -20,15 +20,6 @@ Get info about multiple channels/supergroups ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -74,3 +65,12 @@ Or, if you're into Lua: messages_Chats = channels.getChannels({id={InputChannel}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v73/methods/channels_getMessages.md b/old_docs/API_docs_v73/methods/channels_getMessages.md index eda13d0b..6776acd1 100644 --- a/old_docs/API_docs_v73/methods/channels_getMessages.md +++ b/old_docs/API_docs_v73/methods/channels_getMessages.md @@ -13,7 +13,7 @@ Get channel/supergroup messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -21,15 +21,6 @@ Get channel/supergroup messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|MESSAGE_IDS_EMPTY|No message ids were provided| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: messages_Messages = channels.getMessages({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v73/methods/channels_getParticipant.md b/old_docs/API_docs_v73/methods/channels_getParticipant.md index be5fe96a..3e7632d3 100644 --- a/old_docs/API_docs_v73/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v73/methods/channels_getParticipant.md @@ -21,17 +21,6 @@ Get info about a certain channel/supergroup participant ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v73/methods/channels_getParticipants.md b/old_docs/API_docs_v73/methods/channels_getParticipants.md index 3772ef4b..32b677d5 100644 --- a/old_docs/API_docs_v73/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v73/methods/channels_getParticipants.md @@ -13,10 +13,10 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Limit| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched participant IDs)| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched participant IDs)| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) @@ -24,17 +24,6 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -88,3 +77,14 @@ Or, if you're into Lua: channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/channels_inviteToChannel.md b/old_docs/API_docs_v73/methods/channels_inviteToChannel.md index e7d12db7..6e37ad7f 100644 --- a/old_docs/API_docs_v73/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v73/methods/channels_inviteToChannel.md @@ -21,28 +21,6 @@ Add users to channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_GROUPS_BLOCKED|This bot can't be added to groups| -|BOTS_TOO_MUCH|There are too many bots in this chat/channel| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_BLOCKED|User blocked| -|USER_BOT|Bots can only be admins in channels.| -|USER_ID_INVALID|The provided user ID is invalid| -|USER_KICKED|This user was kicked from this supergroup/channel| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -81,3 +59,25 @@ Or, if you're into Lua: Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v73/methods/channels_joinChannel.md b/old_docs/API_docs_v73/methods/channels_joinChannel.md index 3ac2b326..0ce57109 100644 --- a/old_docs/API_docs_v73/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v73/methods/channels_joinChannel.md @@ -20,15 +20,6 @@ Join a channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = channels.joinChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v73/methods/channels_leaveChannel.md b/old_docs/API_docs_v73/methods/channels_leaveChannel.md index 95b60a90..6f0f31eb 100644 --- a/old_docs/API_docs_v73/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v73/methods/channels_leaveChannel.md @@ -20,17 +20,6 @@ Leave a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|USER_CREATOR|You can't leave this channel, because you're its creator| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| -|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: Updates = channels.leaveChannel({channel=InputChannel, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v73/methods/channels_readHistory.md b/old_docs/API_docs_v73/methods/channels_readHistory.md index c6b14541..90d42f10 100644 --- a/old_docs/API_docs_v73/methods/channels_readHistory.md +++ b/old_docs/API_docs_v73/methods/channels_readHistory.md @@ -13,7 +13,7 @@ Mark channel/supergroup history as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup history as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readHistory({channel=InputChannel, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v73/methods/channels_readMessageContents.md b/old_docs/API_docs_v73/methods/channels_readMessageContents.md index aa9893c2..912adfcf 100644 --- a/old_docs/API_docs_v73/methods/channels_readMessageContents.md +++ b/old_docs/API_docs_v73/methods/channels_readMessageContents.md @@ -13,7 +13,7 @@ Mark channel/supergroup messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| -|id|Array of [CLICK ME int](../types/int.md) | Yes|List of message IDs| +|id|Array of [int](../types/int.md) | Yes|List of message IDs| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Mark channel/supergroup messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = channels.readMessageContents({channel=InputChannel, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v73/methods/channels_reportSpam.md b/old_docs/API_docs_v73/methods/channels_reportSpam.md index debef1a2..e62e613e 100644 --- a/old_docs/API_docs_v73/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v73/methods/channels_reportSpam.md @@ -14,7 +14,7 @@ Report a message in a supergroup/channel for spam |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) @@ -22,14 +22,6 @@ Report a message in a supergroup/channel for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| - - ### MadelineProto Example: @@ -70,3 +62,11 @@ Or, if you're into Lua: Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v73/methods/channels_setStickers.md b/old_docs/API_docs_v73/methods/channels_setStickers.md index d9be32a4..b5142d9f 100644 --- a/old_docs/API_docs_v73/methods/channels_setStickers.md +++ b/old_docs/API_docs_v73/methods/channels_setStickers.md @@ -13,7 +13,7 @@ Set the supergroup/channel stickerpack | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergoup| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Set the supergroup/channel stickerpack ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PARTICIPANTS_TOO_FEW|Not enough participants| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Bool = channels.setStickers({channel=InputChannel, stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PARTICIPANTS_TOO_FEW|Not enough participants| + + diff --git a/old_docs/API_docs_v73/methods/channels_toggleInvites.md b/old_docs/API_docs_v73/methods/channels_toggleInvites.md index e9e6450d..d437682f 100644 --- a/old_docs/API_docs_v73/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v73/methods/channels_toggleInvites.md @@ -13,7 +13,7 @@ Allow or disallow any user to invite users to this channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) @@ -21,15 +21,6 @@ Allow or disallow any user to invite users to this channel/supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v73/methods/channels_togglePreHistoryHidden.md b/old_docs/API_docs_v73/methods/channels_togglePreHistoryHidden.md index d07784de..4374991f 100644 --- a/old_docs/API_docs_v73/methods/channels_togglePreHistoryHidden.md +++ b/old_docs/API_docs_v73/methods/channels_togglePreHistoryHidden.md @@ -13,7 +13,7 @@ Enable or disable hidden history for new channel/supergroup users | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable hidden history for new channel/supergroup users| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable hidden history for new channel/supergroup users| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_toggleSignatures.md b/old_docs/API_docs_v73/methods/channels_toggleSignatures.md index 36d1eccb..d40bf67b 100644 --- a/old_docs/API_docs_v73/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v73/methods/channels_toggleSignatures.md @@ -13,7 +13,7 @@ Toggle channel signatures | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Toggle channel signatures ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v73/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v73/methods/channels_updatePinnedMessage.md index f8d10ece..aa2cc783 100644 --- a/old_docs/API_docs_v73/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v73/methods/channels_updatePinnedMessage.md @@ -12,9 +12,9 @@ Set the pinned message of a channel/supergroup | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Set the pinned message of a channel/supergroup ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -81,3 +71,13 @@ Or, if you're into Lua: Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v73/methods/channels_updateUsername.md b/old_docs/API_docs_v73/methods/channels_updateUsername.md index 2093b6ce..7a75ad3a 100644 --- a/old_docs/API_docs_v73/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v73/methods/channels_updateUsername.md @@ -13,7 +13,7 @@ Update the username of a supergroup/channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| -|username|[CLICK ME string](../types/string.md) | Yes|The new username| +|username|[string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) @@ -21,17 +21,6 @@ Update the username of a supergroup/channel ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|USERNAME_INVALID|The provided username is not valid| -|USERNAME_OCCUPIED|The provided username is already occupied| - - ### MadelineProto Example: @@ -70,3 +59,14 @@ Or, if you're into Lua: Bool = channels.updateUsername({channel=InputChannel, username='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v73/methods/contacts_block.md b/old_docs/API_docs_v73/methods/contacts_block.md index e592cace..f9ac4099 100644 --- a/old_docs/API_docs_v73/methods/contacts_block.md +++ b/old_docs/API_docs_v73/methods/contacts_block.md @@ -20,13 +20,6 @@ Block a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.block({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v73/methods/contacts_deleteContact.md b/old_docs/API_docs_v73/methods/contacts_deleteContact.md index 1a3f2a27..d191cf92 100644 --- a/old_docs/API_docs_v73/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v73/methods/contacts_deleteContact.md @@ -20,13 +20,6 @@ Delete a contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: contacts_Link = contacts.deleteContact({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v73/methods/contacts_deleteContacts.md b/old_docs/API_docs_v73/methods/contacts_deleteContacts.md index f6627599..e35061b0 100644 --- a/old_docs/API_docs_v73/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v73/methods/contacts_deleteContacts.md @@ -20,14 +20,6 @@ Delete multiple contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = contacts.deleteContacts({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/contacts_getBlocked.md b/old_docs/API_docs_v73/methods/contacts_getBlocked.md index 44d24aba..ffc71426 100644 --- a/old_docs/API_docs_v73/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v73/methods/contacts_getBlocked.md @@ -12,8 +12,8 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| -|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| ### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) diff --git a/old_docs/API_docs_v73/methods/contacts_getContacts.md b/old_docs/API_docs_v73/methods/contacts_getContacts.md index 589572dc..25085a19 100644 --- a/old_docs/API_docs_v73/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v73/methods/contacts_getContacts.md @@ -12,7 +12,7 @@ Get info about a certain contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|$ids is the list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`| +|hash|[int](../types/int.md) | Yes|$ids is the list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v73/methods/contacts_getTopPeers.md b/old_docs/API_docs_v73/methods/contacts_getTopPeers.md index 4958e6b2..a8cd4c57 100644 --- a/old_docs/API_docs_v73/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v73/methods/contacts_getTopPeers.md @@ -12,15 +12,15 @@ Get most used chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|correspondents|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch users?| -|bots\_pm|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch bots?| -|bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| -|phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?| -|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| -|channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| +|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?| +|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?| +|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?| +|phone\_calls|[Bool](../types/Bool.md) | Optional|Fetch phone calls?| +|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?| +|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| +|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|limit|[int](../types/int.md) | Yes|How many results to fetch| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| ### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) @@ -28,13 +28,6 @@ Get most used chats ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|TYPES_EMPTY|The types field is empty| - - ### MadelineProto Example: @@ -87,3 +80,10 @@ Or, if you're into Lua: contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, phone_calls=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field is empty| + + diff --git a/old_docs/API_docs_v73/methods/contacts_importCard.md b/old_docs/API_docs_v73/methods/contacts_importCard.md index 89c96657..7a0120af 100644 --- a/old_docs/API_docs_v73/methods/contacts_importCard.md +++ b/old_docs/API_docs_v73/methods/contacts_importCard.md @@ -12,7 +12,7 @@ Import card as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|export\_card|Array of [CLICK ME int](../types/int.md) | Yes|The card| +|export\_card|Array of [int](../types/int.md) | Yes|The card| ### Return type: [User](../types/User.md) @@ -20,14 +20,6 @@ Import card as contact ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|EXPORT_CARD_INVALID|Provided card is invalid| -|NEED_MEMBER_INVALID|The provided member is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: User = contacts.importCard({export_card={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v73/methods/contacts_importContacts.md b/old_docs/API_docs_v73/methods/contacts_importContacts.md index ccc0eada..5b07237e 100644 --- a/old_docs/API_docs_v73/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v73/methods/contacts_importContacts.md @@ -12,7 +12,7 @@ Add phone number as contact | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v73/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v73/methods/contacts_resetTopPeerRating.md index 4b5e96f1..15b07f96 100644 --- a/old_docs/API_docs_v73/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v73/methods/contacts_resetTopPeerRating.md @@ -12,7 +12,7 @@ Reset top peer rating for a certain category/peer | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| @@ -21,13 +21,6 @@ Reset top peer rating for a certain category/peer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/contacts_search.md b/old_docs/API_docs_v73/methods/contacts_search.md index 64ff748e..5947e5f4 100644 --- a/old_docs/API_docs_v73/methods/contacts_search.md +++ b/old_docs/API_docs_v73/methods/contacts_search.md @@ -12,8 +12,8 @@ Search contacts | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| ### Return type: [contacts\_Found](../types/contacts_Found.md) @@ -21,15 +21,6 @@ Search contacts ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_TOO_SHORT|The query string is too short| -|SEARCH_QUERY_EMPTY|The search query is empty| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -68,3 +59,12 @@ Or, if you're into Lua: contacts_Found = contacts.search({q='string', limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/contacts_unblock.md b/old_docs/API_docs_v73/methods/contacts_unblock.md index ec72ae2d..2e9836ee 100644 --- a/old_docs/API_docs_v73/methods/contacts_unblock.md +++ b/old_docs/API_docs_v73/methods/contacts_unblock.md @@ -20,13 +20,6 @@ Unblock a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONTACT_ID_INVALID|The provided contact ID is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = contacts.unblock({id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v73/methods/help_getAppChangelog.md b/old_docs/API_docs_v73/methods/help_getAppChangelog.md index eda473a6..183ebb8c 100644 --- a/old_docs/API_docs_v73/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v73/methods/help_getAppChangelog.md @@ -12,7 +12,7 @@ Get the changelog of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| +|prev\_app\_version|[string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/help_getCdnConfig.md b/old_docs/API_docs_v73/methods/help_getCdnConfig.md index b98949ed..b7af5bb4 100644 --- a/old_docs/API_docs_v73/methods/help_getCdnConfig.md +++ b/old_docs/API_docs_v73/methods/help_getCdnConfig.md @@ -15,13 +15,6 @@ Get CDN configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: CdnConfig = help.getCdnConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/help_getConfig.md b/old_docs/API_docs_v73/methods/help_getConfig.md index ca4bfc25..ede1f1f6 100644 --- a/old_docs/API_docs_v73/methods/help_getConfig.md +++ b/old_docs/API_docs_v73/methods/help_getConfig.md @@ -15,13 +15,6 @@ Get server configuration ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -65,3 +58,10 @@ Or, if you're into Lua: Config = help.getConfig({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/help_getRecentMeUrls.md b/old_docs/API_docs_v73/methods/help_getRecentMeUrls.md index 29d2e21f..7a41f33c 100644 --- a/old_docs/API_docs_v73/methods/help_getRecentMeUrls.md +++ b/old_docs/API_docs_v73/methods/help_getRecentMeUrls.md @@ -12,7 +12,7 @@ Get recent t.me URLs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|referer|[CLICK ME string](../types/string.md) | Yes|Referrer| +|referer|[string](../types/string.md) | Yes|Referrer| ### Return type: [help\_RecentMeUrls](../types/help_RecentMeUrls.md) diff --git a/old_docs/API_docs_v73/methods/help_saveAppLog.md b/old_docs/API_docs_v73/methods/help_saveAppLog.md index a7884c47..ec75aa39 100644 --- a/old_docs/API_docs_v73/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v73/methods/help_saveAppLog.md @@ -12,7 +12,7 @@ Log data for developer of this app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v73/methods/help_setBotUpdatesStatus.md index a1a3ab1b..1766ee14 100644 --- a/old_docs/API_docs_v73/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v73/methods/help_setBotUpdatesStatus.md @@ -12,8 +12,8 @@ Set the update status of webhook | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| -|message|[CLICK ME string](../types/string.md) | Yes|Message| +|pending\_updates\_count|[int](../types/int.md) | Yes|Pending update count| +|message|[string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/initConnection.md b/old_docs/API_docs_v73/methods/initConnection.md index c66aa8b1..2d195613 100644 --- a/old_docs/API_docs_v73/methods/initConnection.md +++ b/old_docs/API_docs_v73/methods/initConnection.md @@ -12,14 +12,14 @@ Initializes connection and save information on the user's device and application | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|api\_id|[CLICK ME int](../types/int.md) | Yes|Application identifier| -|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model| -|system\_version|[CLICK ME string](../types/string.md) | Yes|System version| -|app\_version|[CLICK ME string](../types/string.md) | Yes|App version| -|system\_lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| -|lang\_pack|[CLICK ME string](../types/string.md) | Yes|Language pack to use| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code to set| -|query|[CLICK ME !X](../types/!X.md) | Yes|Nested query| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|system\_lang\_code|[string](../types/string.md) | Yes|Language code| +|lang\_pack|[string](../types/string.md) | Yes|Language pack to use| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|query|[!X](../types/!X.md) | Yes|Nested query| ### Return type: [X](../types/X.md) @@ -27,14 +27,6 @@ Initializes connection and save information on the user's device and application ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CONNECTION_LAYER_INVALID|Layer invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| - - ### MadelineProto Example: @@ -94,3 +86,11 @@ Or, if you're into Lua: X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', system_lang_code='string', lang_pack='string', lang_code='string', query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v73/methods/invokeAfterMsg.md b/old_docs/API_docs_v73/methods/invokeAfterMsg.md index 8e953e78..83018099 100644 --- a/old_docs/API_docs_v73/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v73/methods/invokeAfterMsg.md @@ -12,8 +12,8 @@ Invokes a query after successfull completion of one of the previous queries. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME long](../types/long.md) | Yes|Message identifier on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v73/methods/invokeAfterMsgs.md b/old_docs/API_docs_v73/methods/invokeAfterMsgs.md index bc8a83b7..23ed7037 100644 --- a/old_docs/API_docs_v73/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v73/methods/invokeAfterMsgs.md @@ -12,8 +12,8 @@ Result type returned by a current query. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_ids|Array of [CLICK ME long](../types/long.md) | Yes|List of messages on which a current query depends| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query itself| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v73/methods/invokeWithLayer.md b/old_docs/API_docs_v73/methods/invokeWithLayer.md index 8a0c4e79..051e0d45 100644 --- a/old_docs/API_docs_v73/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v73/methods/invokeWithLayer.md @@ -12,8 +12,8 @@ Invoke this method with layer X | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|layer|[CLICK ME int](../types/int.md) | Yes|The layer version| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) @@ -21,23 +21,6 @@ Invoke this method with layer X ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|AUTH_BYTES_INVALID|The provided authorization is invalid| -|CDN_METHOD_INVALID|You can't call this method in a CDN DC| -|CONNECTION_API_ID_INVALID|The provided API id is invalid| -|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| -|CONNECTION_LANG_PACK_INVALID|Language pack invalid| -|CONNECTION_NOT_INITED|Connection not initialized| -|CONNECTION_SYSTEM_EMPTY|Connection system empty| -|INPUT_LAYER_INVALID|The provided layer is invalid| -|INVITE_HASH_EXPIRED|The invite link has expired| -|NEED_MEMBER_INVALID|The provided member is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -85,3 +68,20 @@ Or, if you're into Lua: X = invokeWithLayer({layer=int, query=!X, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v73/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v73/methods/invokeWithoutUpdates.md index 2d90a776..33238cda 100644 --- a/old_docs/API_docs_v73/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v73/methods/invokeWithoutUpdates.md @@ -12,7 +12,7 @@ Invoke with method without returning updates in the socket | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query|[CLICK ME !X](../types/!X.md) | Yes|The query| +|query|[!X](../types/!X.md) | Yes|The query| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v73/methods/langpack_getDifference.md b/old_docs/API_docs_v73/methods/langpack_getDifference.md index 0a6512e4..1860cc49 100644 --- a/old_docs/API_docs_v73/methods/langpack_getDifference.md +++ b/old_docs/API_docs_v73/methods/langpack_getDifference.md @@ -12,7 +12,7 @@ Get language pack updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|from\_version|[CLICK ME int](../types/int.md) | Yes|Previous version| +|from\_version|[int](../types/int.md) | Yes|Previous version| ### Return type: [LangPackDifference](../types/LangPackDifference.md) @@ -20,13 +20,6 @@ Get language pack updates ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: LangPackDifference = langpack.getDifference({from_version=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v73/methods/langpack_getLangPack.md b/old_docs/API_docs_v73/methods/langpack_getLangPack.md index 45a9ca47..7e64aec9 100644 --- a/old_docs/API_docs_v73/methods/langpack_getLangPack.md +++ b/old_docs/API_docs_v73/methods/langpack_getLangPack.md @@ -12,7 +12,7 @@ Get language pack | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| +|lang\_code|[string](../types/string.md) | Yes|Language code| ### Return type: [LangPackDifference](../types/LangPackDifference.md) @@ -20,13 +20,6 @@ Get language pack ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: LangPackDifference = langpack.getLangPack({lang_code='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v73/methods/langpack_getLanguages.md b/old_docs/API_docs_v73/methods/langpack_getLanguages.md index b573a5eb..c4ea44ca 100644 --- a/old_docs/API_docs_v73/methods/langpack_getLanguages.md +++ b/old_docs/API_docs_v73/methods/langpack_getLanguages.md @@ -15,13 +15,6 @@ Get available languages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -56,3 +49,10 @@ Or, if you're into Lua: Vector_of_LangPackLanguage = langpack.getLanguages({}) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v73/methods/langpack_getStrings.md b/old_docs/API_docs_v73/methods/langpack_getStrings.md index 841b02db..4953e1c0 100644 --- a/old_docs/API_docs_v73/methods/langpack_getStrings.md +++ b/old_docs/API_docs_v73/methods/langpack_getStrings.md @@ -12,8 +12,8 @@ Get language pack strings | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code| -|keys|Array of [CLICK ME string](../types/string.md) | Yes|Keys| +|lang\_code|[string](../types/string.md) | Yes|Language code| +|keys|Array of [string](../types/string.md) | Yes|Keys| ### Return type: [Vector\_of\_LangPackString](../types/LangPackString.md) @@ -21,13 +21,6 @@ Get language pack strings ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LANG_PACK_INVALID|The provided language pack is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Vector_of_LangPackString = langpack.getStrings({lang_code='string', keys={'string'}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_addChatUser.md b/old_docs/API_docs_v73/methods/messages_addChatUser.md index c6ef275f..c73562b2 100644 --- a/old_docs/API_docs_v73/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v73/methods/messages_addChatUser.md @@ -14,7 +14,7 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| -|fwd\_limit|[CLICK ME int](../types/int.md) | Yes|Number of old messages the user will see| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| ### Return type: [Updates](../types/Updates.md) @@ -22,21 +22,6 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USER_ID_INVALID|The provided user ID is invalid| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| -|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| - - ### MadelineProto Example: @@ -77,3 +62,18 @@ Or, if you're into Lua: Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v73/methods/messages_checkChatInvite.md b/old_docs/API_docs_v73/methods/messages_checkChatInvite.md index cea63313..30e39334 100644 --- a/old_docs/API_docs_v73/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v73/methods/messages_checkChatInvite.md @@ -12,7 +12,7 @@ Check if an invitation link is valid | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) @@ -20,15 +20,6 @@ Check if an invitation link is valid ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: ChatInvite = messages.checkChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v73/methods/messages_clearRecentStickers.md index 1d6ec8c9..72c4844b 100644 --- a/old_docs/API_docs_v73/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v73/methods/messages_clearRecentStickers.md @@ -12,7 +12,7 @@ Clear all recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_createChat.md b/old_docs/API_docs_v73/methods/messages_createChat.md index 966f58dc..69442044 100644 --- a/old_docs/API_docs_v73/methods/messages_createChat.md +++ b/old_docs/API_docs_v73/methods/messages_createChat.md @@ -13,7 +13,7 @@ Create a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new chat's title| +|title|[string](../types/string.md) | Yes|The new chat's title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Create a chat (not supergroup) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USERS_TOO_FEW|Not enough users (to create a chat, for example)| -|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.createChat({users={InputUser}, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v73/methods/messages_deleteChatUser.md b/old_docs/API_docs_v73/methods/messages_deleteChatUser.md index 9a9227ba..413de42f 100644 --- a/old_docs/API_docs_v73/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v73/methods/messages_deleteChatUser.md @@ -21,15 +21,6 @@ Delete a user from a chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v73/methods/messages_deleteHistory.md b/old_docs/API_docs_v73/methods/messages_deleteHistory.md index 45e9890d..601d1876 100644 --- a/old_docs/API_docs_v73/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v73/methods/messages_deleteHistory.md @@ -12,9 +12,9 @@ Delete chat history | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|just\_clear|[CLICK ME Bool](../types/Bool.md) | Optional|Only clear it from your side| +|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to delete| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) @@ -22,13 +22,6 @@ Delete chat history ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_deleteMessages.md b/old_docs/API_docs_v73/methods/messages_deleteMessages.md index c8670444..900e9d0e 100644 --- a/old_docs/API_docs_v73/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v73/methods/messages_deleteMessages.md @@ -12,8 +12,8 @@ Delete messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|revoke|[CLICK ME Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [CLICK ME int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,13 +21,6 @@ Delete messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_AffectedMessages = messages.deleteMessages({revoke=Bool, id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v73/methods/messages_editChatAdmin.md b/old_docs/API_docs_v73/methods/messages_editChatAdmin.md index 5bba0559..7126939c 100644 --- a/old_docs/API_docs_v73/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v73/methods/messages_editChatAdmin.md @@ -14,7 +14,7 @@ Edit admin permissions |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Edit admin permissions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_editChatPhoto.md b/old_docs/API_docs_v73/methods/messages_editChatPhoto.md index 5827a5cc..0db38b41 100644 --- a/old_docs/API_docs_v73/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v73/methods/messages_editChatPhoto.md @@ -13,7 +13,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| ### Return type: [Updates](../types/Updates.md) @@ -21,17 +21,6 @@ Edit the photo of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_FETCH_FAIL|Failed deserializing TL payload| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -79,3 +68,14 @@ Or, if you're into Lua: Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_editChatTitle.md b/old_docs/API_docs_v73/methods/messages_editChatTitle.md index 2e69d790..98bd1a78 100644 --- a/old_docs/API_docs_v73/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v73/methods/messages_editChatTitle.md @@ -13,7 +13,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[CLICK ME string](../types/string.md) | Yes|The new title| +|title|[string](../types/string.md) | Yes|The new title| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Edit the title of a normal chat (not supergroup) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|NEED_CHAT_INVALID|The provided chat is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v73/methods/messages_editInlineBotMessage.md index 21a55e36..5a6b840e 100644 --- a/old_docs/API_docs_v73/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v73/methods/messages_editInlineBotMessage.md @@ -12,14 +12,14 @@ Edit a sent inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional|Stop live location| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| ### Return type: [Bool](../types/Bool.md) @@ -27,14 +27,6 @@ Edit a sent inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| - - ### MadelineProto Example: @@ -124,3 +116,11 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v73/methods/messages_editMessage.md b/old_docs/API_docs_v73/methods/messages_editMessage.md index e3178d97..7c85d566 100644 --- a/old_docs/API_docs_v73/methods/messages_editMessage.md +++ b/old_docs/API_docs_v73/methods/messages_editMessage.md @@ -12,15 +12,15 @@ Edit a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional|Stop live location| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|message|[CLICK ME string](../types/string.md) | Optional|The new message| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| ### Return type: [Updates](../types/Updates.md) @@ -28,22 +28,6 @@ Edit a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_NOT_MODIFIED|The message text has not changed| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -133,3 +117,19 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v73/methods/messages_exportChatInvite.md b/old_docs/API_docs_v73/methods/messages_exportChatInvite.md index ec80e207..f43b39d4 100644 --- a/old_docs/API_docs_v73/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v73/methods/messages_exportChatInvite.md @@ -20,13 +20,6 @@ Export chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_faveSticker.md b/old_docs/API_docs_v73/methods/messages_faveSticker.md index ee1eb66a..8b1534ea 100644 --- a/old_docs/API_docs_v73/methods/messages_faveSticker.md +++ b/old_docs/API_docs_v73/methods/messages_faveSticker.md @@ -13,7 +13,7 @@ Add a sticker to favorites | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| -|unfave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove it from favorites?| +|unfave|[Bool](../types/Bool.md) | Yes|Remove it from favorites?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Add a sticker to favorites ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.faveSticker({id=InputDocument, unfave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_forwardMessage.md b/old_docs/API_docs_v73/methods/messages_forwardMessage.md index d6916437..3404afc0 100644 --- a/old_docs/API_docs_v73/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v73/methods/messages_forwardMessage.md @@ -13,7 +13,7 @@ Forward message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [Updates](../types/Updates.md) @@ -21,16 +21,6 @@ Forward message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|YOU_BLOCKED_USER|You blocked this user| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: Updates = messages.forwardMessage({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|YOU_BLOCKED_USER|You blocked this user| + + diff --git a/old_docs/API_docs_v73/methods/messages_forwardMessages.md b/old_docs/API_docs_v73/methods/messages_forwardMessages.md index 2dbcfe21..e4a3d241 100644 --- a/old_docs/API_docs_v73/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v73/methods/messages_forwardMessages.md @@ -12,12 +12,12 @@ Forward messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[CLICK ME Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|grouped|[CLICK ME Bool](../types/Bool.md) | Optional|Set to true if forwarding albums| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| +|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| +|grouped|[Bool](../types/Bool.md) | Optional|Set to true if forwarding albums| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| +|id|Array of [int](../types/int.md) | Yes|The message IDs| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| @@ -26,34 +26,6 @@ Forward messages ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|GROUPED_MEDIA_INVALID|Invalid grouped media| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_EMPTY|The provided media object is invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|MESSAGE_IDS_EMPTY|No message ids were provided| -|PEER_ID_INVALID|The provided peer id is invalid| -|RANDOM_ID_INVALID|A provided random ID is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|PTS_CHANGE_EMPTY|No PTS change| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -111,3 +83,31 @@ Or, if you're into Lua: Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, grouped=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/messages_getAllChats.md b/old_docs/API_docs_v73/methods/messages_getAllChats.md index 513fc06f..c4851369 100644 --- a/old_docs/API_docs_v73/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v73/methods/messages_getAllChats.md @@ -12,7 +12,7 @@ Get all chats (not supergroups or channels) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v73/methods/messages_getAllStickers.md b/old_docs/API_docs_v73/methods/messages_getAllStickers.md index 2ba37a91..b2de553f 100644 --- a/old_docs/API_docs_v73/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getAllStickers.md @@ -12,7 +12,7 @@ Get all stickerpacks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v73/methods/messages_getArchivedStickers.md index ee36b542..dfd5c006 100644 --- a/old_docs/API_docs_v73/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getArchivedStickers.md @@ -12,9 +12,9 @@ Get all archived stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| +|masks|[Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| +|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v73/methods/messages_getAttachedStickers.md index 9f8a66c5..8f51f38d 100644 --- a/old_docs/API_docs_v73/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getAttachedStickers.md @@ -12,7 +12,7 @@ Get stickers attachable to images | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v73/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v73/methods/messages_getBotCallbackAnswer.md index 0136227f..4b8887ad 100644 --- a/old_docs/API_docs_v73/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v73/methods/messages_getBotCallbackAnswer.md @@ -12,10 +12,10 @@ Get the callback answer of a bot (after clicking a button) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|game|[Bool](../types/Bool.md) | Optional|Is this a game?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) @@ -23,17 +23,6 @@ Get the callback answer of a bot (after clicking a button) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|DATA_INVALID|Encrypted data invalid| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -76,3 +65,14 @@ Or, if you're into Lua: messages_BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/messages_getChats.md b/old_docs/API_docs_v73/methods/messages_getChats.md index e84c7193..7b8ee026 100644 --- a/old_docs/API_docs_v73/methods/messages_getChats.md +++ b/old_docs/API_docs_v73/methods/messages_getChats.md @@ -12,7 +12,7 @@ Get info about chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -20,14 +20,6 @@ Get info about chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_Chats = messages.getChats({id={int}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_getCommonChats.md b/old_docs/API_docs_v73/methods/messages_getCommonChats.md index 15ed6713..6ffa0948 100644 --- a/old_docs/API_docs_v73/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v73/methods/messages_getCommonChats.md @@ -13,8 +13,8 @@ Get chats in common with a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) @@ -22,13 +22,6 @@ Get chats in common with a user ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: messages_Chats = messages.getCommonChats({user_id=InputUser, max_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_getDialogs.md b/old_docs/API_docs_v73/methods/messages_getDialogs.md index 53f9ac62..1035e8ce 100644 --- a/old_docs/API_docs_v73/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v73/methods/messages_getDialogs.md @@ -12,11 +12,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|exclude\_pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|end($res['messages'])['id'];| +|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) @@ -24,16 +24,6 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v73/methods/messages_getDocumentByHash.md index ad8e22be..859f1f54 100644 --- a/old_docs/API_docs_v73/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v73/methods/messages_getDocumentByHash.md @@ -12,9 +12,9 @@ Get document by SHA256 hash | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[CLICK ME int](../types/int.md) | Yes|The file size| -|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) @@ -22,13 +22,6 @@ Get document by SHA256 hash ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_getFavedStickers.md b/old_docs/API_docs_v73/methods/messages_getFavedStickers.md index 8ef3e565..dea1e5ec 100644 --- a/old_docs/API_docs_v73/methods/messages_getFavedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getFavedStickers.md @@ -12,7 +12,7 @@ Get favorite stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v73/methods/messages_getFeaturedStickers.md index 8e49e1ef..af7f69a0 100644 --- a/old_docs/API_docs_v73/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getFeaturedStickers.md @@ -12,7 +12,7 @@ Get featured stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getGameHighScores.md b/old_docs/API_docs_v73/methods/messages_getGameHighScores.md index 113e4647..af3f3915 100644 --- a/old_docs/API_docs_v73/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v73/methods/messages_getGameHighScores.md @@ -13,7 +13,7 @@ Get high scores of a game | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -22,14 +22,6 @@ Get high scores of a game ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -79,3 +71,11 @@ Or, if you're into Lua: messages_HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v73/methods/messages_getHistory.md b/old_docs/API_docs_v73/methods/messages_getHistory.md index 585a2b52..86a20101 100644 --- a/old_docs/API_docs_v73/methods/messages_getHistory.md +++ b/old_docs/API_docs_v73/methods/messages_getHistory.md @@ -13,13 +13,13 @@ Get previous messages of a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message ID to fetch| -|hash|[CLICK ME int](../types/int.md) | Yes|hash of old messages, $MadelineProto->gen_vector_hash($parsedMessageIds)| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +|hash|[int](../types/int.md) | Yes|hash of old messages, $MadelineProto->gen_vector_hash($parsedMessageIds)| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -27,18 +27,6 @@ Get previous messages of a group ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -89,3 +77,15 @@ Or, if you're into Lua: messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v73/methods/messages_getInlineBotResults.md index 4d86caf5..207624a7 100644 --- a/old_docs/API_docs_v73/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v73/methods/messages_getInlineBotResults.md @@ -14,9 +14,9 @@ Call inline bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| -|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) @@ -24,16 +24,6 @@ Call inline bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INLINE_DISABLED|This bot can't be used in inline mode| -|BOT_INVALID|This is not a valid bot| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -78,3 +68,13 @@ Or, if you're into Lua: messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v73/methods/messages_getInlineGameHighScores.md index d5a80005..e03bc273 100644 --- a/old_docs/API_docs_v73/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v73/methods/messages_getInlineGameHighScores.md @@ -12,7 +12,7 @@ Get high scores of a game sent in an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| @@ -21,14 +21,6 @@ Get high scores of a game sent in an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v73/methods/messages_getMaskStickers.md b/old_docs/API_docs_v73/methods/messages_getMaskStickers.md index 70e2e6d4..1fbd9346 100644 --- a/old_docs/API_docs_v73/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getMaskStickers.md @@ -12,7 +12,7 @@ Get masks | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getMessageEditData.md b/old_docs/API_docs_v73/methods/messages_getMessageEditData.md index 34f8534f..00c63d28 100644 --- a/old_docs/API_docs_v73/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v73/methods/messages_getMessageEditData.md @@ -13,7 +13,7 @@ Check if about to edit a message or a media caption | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) @@ -21,14 +21,6 @@ Check if about to edit a message or a media caption ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|MESSAGE_AUTHOR_REQUIRED|Message author required| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v73/methods/messages_getMessages.md b/old_docs/API_docs_v73/methods/messages_getMessages.md index d538cb5f..45b627f7 100644 --- a/old_docs/API_docs_v73/methods/messages_getMessages.md +++ b/old_docs/API_docs_v73/methods/messages_getMessages.md @@ -12,7 +12,7 @@ Get messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v73/methods/messages_getMessagesViews.md b/old_docs/API_docs_v73/methods/messages_getMessagesViews.md index 934adc16..01766543 100644 --- a/old_docs/API_docs_v73/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v73/methods/messages_getMessagesViews.md @@ -13,8 +13,8 @@ Get and increase message views | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) @@ -22,15 +22,6 @@ Get and increase message views ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -71,3 +62,12 @@ Or, if you're into Lua: Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v73/methods/messages_getPeerDialogs.md index 063b6e7d..000e8eb6 100644 --- a/old_docs/API_docs_v73/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v73/methods/messages_getPeerDialogs.md @@ -20,14 +20,6 @@ Get dialog info of peers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: messages_PeerDialogs = messages.getPeerDialogs({peers={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_getPeerSettings.md b/old_docs/API_docs_v73/methods/messages_getPeerSettings.md index a18126f0..5a3e9349 100644 --- a/old_docs/API_docs_v73/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v73/methods/messages_getPeerSettings.md @@ -20,14 +20,6 @@ Get the settings of apeer ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: PeerSettings = messages.getPeerSettings({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_getRecentLocations.md b/old_docs/API_docs_v73/methods/messages_getRecentLocations.md index a1bad267..ab3fb8e4 100644 --- a/old_docs/API_docs_v73/methods/messages_getRecentLocations.md +++ b/old_docs/API_docs_v73/methods/messages_getRecentLocations.md @@ -13,7 +13,7 @@ Get recent locations | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to search locations| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| +|limit|[int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v73/methods/messages_getRecentStickers.md b/old_docs/API_docs_v73/methods/messages_getRecentStickers.md index 0c5ae0c6..629a2bda 100644 --- a/old_docs/API_docs_v73/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getRecentStickers.md @@ -12,8 +12,8 @@ Get recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getSavedGifs.md b/old_docs/API_docs_v73/methods/messages_getSavedGifs.md index 38585538..ea3c55bc 100644 --- a/old_docs/API_docs_v73/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v73/methods/messages_getSavedGifs.md @@ -12,7 +12,7 @@ Get saved gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v73/methods/messages_getStickerSet.md b/old_docs/API_docs_v73/methods/messages_getStickerSet.md index c9140ab2..b3f17168 100644 --- a/old_docs/API_docs_v73/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v73/methods/messages_getStickerSet.md @@ -12,7 +12,7 @@ Get a stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -20,13 +20,6 @@ Get a stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_getUnreadMentions.md b/old_docs/API_docs_v73/methods/messages_getUnreadMentions.md index b8d7b5a5..6abe55c6 100644 --- a/old_docs/API_docs_v73/methods/messages_getUnreadMentions.md +++ b/old_docs/API_docs_v73/methods/messages_getUnreadMentions.md @@ -13,11 +13,11 @@ Get unread mentions | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|The offset| -|add\_offset|[CLICK ME int](../types/int.md) | Yes|The additional offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to fetch| -|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum message ID to fetch| -|min\_id|[CLICK ME int](../types/int.md) | Yes|The minumum message ID to fetch| +|offset\_id|[int](../types/int.md) | Yes|The offset| +|add\_offset|[int](../types/int.md) | Yes|The additional offset| +|limit|[int](../types/int.md) | Yes|The number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|The minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -25,13 +25,6 @@ Get unread mentions ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: messages_Messages = messages.getUnreadMentions({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_getWebPage.md b/old_docs/API_docs_v73/methods/messages_getWebPage.md index 19ca94b9..1b533ebd 100644 --- a/old_docs/API_docs_v73/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v73/methods/messages_getWebPage.md @@ -12,8 +12,8 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|url|[CLICK ME string](../types/string.md) | Yes|URL| -|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| +|url|[string](../types/string.md) | Yes|URL| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) @@ -21,13 +21,6 @@ Get webpage preview ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|WC_CONVERT_URL_INVALID|WC convert URL invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: WebPage = messages.getWebPage({url='string', hash=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|WC_CONVERT_URL_INVALID|WC convert URL invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v73/methods/messages_getWebPagePreview.md index e8b20c5d..f258896f 100644 --- a/old_docs/API_docs_v73/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v73/methods/messages_getWebPagePreview.md @@ -12,7 +12,7 @@ Get webpage preview | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|message|[string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v73/methods/messages_hideReportSpam.md b/old_docs/API_docs_v73/methods/messages_hideReportSpam.md index 30523f2a..0bf711ea 100644 --- a/old_docs/API_docs_v73/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v73/methods/messages_hideReportSpam.md @@ -20,13 +20,6 @@ Hide report spam popup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.hideReportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_importChatInvite.md b/old_docs/API_docs_v73/methods/messages_importChatInvite.md index b1830a9b..b4454622 100644 --- a/old_docs/API_docs_v73/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v73/methods/messages_importChatInvite.md @@ -12,7 +12,7 @@ Import chat invite | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) @@ -20,19 +20,6 @@ Import chat invite ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| -|INVITE_HASH_EMPTY|The invite hash is empty| -|INVITE_HASH_EXPIRED|The invite link has expired| -|INVITE_HASH_INVALID|The invite hash is invalid| -|USER_ALREADY_PARTICIPANT|The user is already in the group| -|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| - - ### MadelineProto Example: @@ -69,3 +56,16 @@ Or, if you're into Lua: Updates = messages.importChatInvite({hash='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v73/methods/messages_installStickerSet.md b/old_docs/API_docs_v73/methods/messages_installStickerSet.md index 20f90b71..d6caf555 100644 --- a/old_docs/API_docs_v73/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v73/methods/messages_installStickerSet.md @@ -12,8 +12,8 @@ Add a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) @@ -21,13 +21,6 @@ Add a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_migrateChat.md b/old_docs/API_docs_v73/methods/messages_migrateChat.md index 22ccfcc1..67880d42 100644 --- a/old_docs/API_docs_v73/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v73/methods/messages_migrateChat.md @@ -20,15 +20,6 @@ Convert chat to supergroup ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| - - ### MadelineProto Example: @@ -65,3 +56,12 @@ Or, if you're into Lua: Updates = messages.migrateChat({chat_id=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v73/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v73/methods/messages_readEncryptedHistory.md index 2ba4cca4..24ca27a1 100644 --- a/old_docs/API_docs_v73/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v73/methods/messages_readEncryptedHistory.md @@ -13,7 +13,7 @@ Mark messages as read in secret chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Mark messages as read in secret chats ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v73/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v73/methods/messages_readFeaturedStickers.md index 050371da..3b01171b 100644 --- a/old_docs/API_docs_v73/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_readFeaturedStickers.md @@ -12,7 +12,7 @@ Mark new featured stickers as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| +|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_readHistory.md b/old_docs/API_docs_v73/methods/messages_readHistory.md index 26b608af..276a804b 100644 --- a/old_docs/API_docs_v73/methods/messages_readHistory.md +++ b/old_docs/API_docs_v73/methods/messages_readHistory.md @@ -13,7 +13,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) @@ -21,14 +21,6 @@ Mark messages as read ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/messages_readMessageContents.md b/old_docs/API_docs_v73/methods/messages_readMessageContents.md index a09cb63e..5ac316d1 100644 --- a/old_docs/API_docs_v73/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v73/methods/messages_readMessageContents.md @@ -12,7 +12,7 @@ Mark message as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v73/methods/messages_receivedMessages.md b/old_docs/API_docs_v73/methods/messages_receivedMessages.md index b5e87992..a969b673 100644 --- a/old_docs/API_docs_v73/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v73/methods/messages_receivedMessages.md @@ -12,7 +12,7 @@ Mark messages as read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v73/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v73/methods/messages_reorderPinnedDialogs.md index 94d3b2d4..232117e8 100644 --- a/old_docs/API_docs_v73/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v73/methods/messages_reorderPinnedDialogs.md @@ -12,7 +12,7 @@ Reorder pinned dialogs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|force|[Bool](../types/Bool.md) | Optional|Force reordering| |order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| @@ -21,13 +21,6 @@ Reorder pinned dialogs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.reorderPinnedDialogs({force=Bool, order={InputPeer}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v73/methods/messages_reorderStickerSets.md index 66f5e682..6a71da86 100644 --- a/old_docs/API_docs_v73/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v73/methods/messages_reorderStickerSets.md @@ -12,8 +12,8 @@ Reorder sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| +|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v73/methods/messages_reportEncryptedSpam.md index cd03c35c..988e0101 100644 --- a/old_docs/API_docs_v73/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v73/methods/messages_reportEncryptedSpam.md @@ -20,13 +20,6 @@ Report for spam a secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportEncryptedSpam({peer=InputEncryptedChat, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_reportSpam.md b/old_docs/API_docs_v73/methods/messages_reportSpam.md index 09c1e63b..824fa1e2 100644 --- a/old_docs/API_docs_v73/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v73/methods/messages_reportSpam.md @@ -20,13 +20,6 @@ Report a peer for spam ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.reportSpam({peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_saveDraft.md b/old_docs/API_docs_v73/methods/messages_saveDraft.md index 59b33b03..60d72c1e 100644 --- a/old_docs/API_docs_v73/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v73/methods/messages_saveDraft.md @@ -12,11 +12,11 @@ Save a message draft | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[CLICK ME string](../types/string.md) | Yes|The message| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -25,13 +25,6 @@ Save a message draft ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -104,3 +97,10 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_saveGif.md b/old_docs/API_docs_v73/methods/messages_saveGif.md index 145039e7..acbb0d1b 100644 --- a/old_docs/API_docs_v73/methods/messages_saveGif.md +++ b/old_docs/API_docs_v73/methods/messages_saveGif.md @@ -13,7 +13,7 @@ Save a GIF | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Save a GIF ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|GIF_ID_INVALID|The provided GIF ID is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v73/methods/messages_saveRecentSticker.md index 55757080..d2418881 100644 --- a/old_docs/API_docs_v73/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v73/methods/messages_saveRecentSticker.md @@ -12,9 +12,9 @@ Add a sticker to recent stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Add a sticker to recent stickers ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKER_ID_INVALID|The provided sticker ID is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Bool = messages.saveRecentSticker({attached=Bool, id=InputDocument, unsave=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_search.md b/old_docs/API_docs_v73/methods/messages_search.md index 9253828a..96e0463e 100644 --- a/old_docs/API_docs_v73/methods/messages_search.md +++ b/old_docs/API_docs_v73/methods/messages_search.md @@ -13,16 +13,16 @@ Search peers or messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[CLICK ME string](../types/string.md) | Yes|What to search| +|q|[string](../types/string.md) | Yes|What to search| |from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|Offset | -|add\_offset|[CLICK ME int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| -|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return| -|min\_id|[CLICK ME int](../types/int.md) | Yes|Minumum message id to return| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset\_id|[int](../types/int.md) | Yes|Offset | +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of results to return| +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|min\_id|[int](../types/int.md) | Yes|Minumum message id to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -30,19 +30,6 @@ Search peers or messages ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|PEER_ID_INVALID|The provided peer id is invalid| -|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| -|SEARCH_QUERY_EMPTY|The search query is empty| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -99,3 +86,16 @@ Or, if you're into Lua: messages_Messages = messages.search({peer=InputPeer, q='string', from_id=InputUser, filter=MessagesFilter, min_date=int, max_date=int, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_searchGifs.md b/old_docs/API_docs_v73/methods/messages_searchGifs.md index 9677bf24..43feea48 100644 --- a/old_docs/API_docs_v73/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v73/methods/messages_searchGifs.md @@ -12,8 +12,8 @@ Search gifs | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The search query| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset | +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) @@ -21,13 +21,6 @@ Search gifs ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v73/methods/messages_searchGlobal.md b/old_docs/API_docs_v73/methods/messages_searchGlobal.md index 6ad4aec0..9ca9cfe7 100644 --- a/old_docs/API_docs_v73/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v73/methods/messages_searchGlobal.md @@ -12,11 +12,11 @@ Global message search | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|q|[CLICK ME string](../types/string.md) | Yes|The query| -|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) @@ -24,13 +24,6 @@ Global message search ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SEARCH_QUERY_EMPTY|The search query is empty| - - ### MadelineProto Example: @@ -75,3 +68,10 @@ Or, if you're into Lua: messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v73/methods/messages_sendEncrypted.md b/old_docs/API_docs_v73/methods/messages_sendEncrypted.md index 76305f32..c6f21904 100644 --- a/old_docs/API_docs_v73/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v73/methods/messages_sendEncrypted.md @@ -13,7 +13,7 @@ Send message to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send message to secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v73/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v73/methods/messages_sendEncryptedFile.md index 8db2ead9..f992f5bf 100644 --- a/old_docs/API_docs_v73/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v73/methods/messages_sendEncryptedFile.md @@ -13,7 +13,7 @@ Send a file to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| @@ -22,13 +22,6 @@ Send a file to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MSG_WAIT_FAILED|A waiting call returned an error| - - ### MadelineProto Example: @@ -84,3 +77,10 @@ messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v73/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v73/methods/messages_sendEncryptedService.md index c7836c94..b1fb44dc 100644 --- a/old_docs/API_docs_v73/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v73/methods/messages_sendEncryptedService.md @@ -13,7 +13,7 @@ Send a service message to a secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) @@ -21,16 +21,6 @@ Send a service message to a secret chat ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|DATA_INVALID|Encrypted data invalid| -|ENCRYPTION_DECLINED|The secret chat was declined| -|MSG_WAIT_FAILED|A waiting call returned an error| -|USER_IS_BLOCKED|User is blocked| - - ### MadelineProto Example: @@ -84,3 +74,13 @@ messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncrypt If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v73/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v73/methods/messages_sendInlineBotResult.md index 758aa97f..d1f9fbd0 100644 --- a/old_docs/API_docs_v73/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v73/methods/messages_sendInlineBotResult.md @@ -12,13 +12,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| -|id|[CLICK ME string](../types/string.md) | Yes|The ID of one of the inline results| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| ### Return type: [Updates](../types/Updates.md) @@ -26,18 +26,6 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|INLINE_RESULT_EXPIRED|The inline query expired| -|PEER_ID_INVALID|The provided peer id is invalid| -|QUERY_ID_EMPTY|The query ID is empty| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -86,3 +74,15 @@ Or, if you're into Lua: Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v73/methods/messages_sendMedia.md b/old_docs/API_docs_v73/methods/messages_sendMedia.md index 770d1b65..94e27b83 100644 --- a/old_docs/API_docs_v73/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v73/methods/messages_sendMedia.md @@ -12,13 +12,13 @@ Send a media | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| ### Return type: [Updates](../types/Updates.md) @@ -26,34 +26,6 @@ Send a media ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|EXTERNAL_URL_INVALID|External URL invalid| -|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MEDIA_CAPTION_TOO_LONG|The caption is too long| -|MEDIA_EMPTY|The provided media object is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| -|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| -|WEBPAGE_MEDIA_EMPTY|Webpage media empty| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|STORAGE_CHECK_FAILED|Server storage check failed| -|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -117,3 +89,31 @@ Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, pe You can provide bot API reply_markup objects here. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/messages_sendMessage.md b/old_docs/API_docs_v73/methods/messages_sendMessage.md index 83dc6c8b..ba76f230 100644 --- a/old_docs/API_docs_v73/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v73/methods/messages_sendMessage.md @@ -12,15 +12,15 @@ Send a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|message|[CLICK ME string](../types/string.md) | Yes|The message to send| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -29,33 +29,6 @@ Send a message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|CHAT_ID_INVALID|The provided chat id is invalid| -|ENTITY_MENTION_USER_INVALID|You can't use this entity| -|INPUT_USER_DEACTIVATED|The specified user was deleted| -|MESSAGE_EMPTY|The provided message is empty| -|MESSAGE_TOO_LONG|The provided message is too long| -|PEER_ID_INVALID|The provided peer id is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|YOU_BLOCKED_USER|You blocked this user| -|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| -|tanti SALUTI da peppe lg .|Ciao da un pony| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -143,3 +116,30 @@ You can also use normal markdown, note that to create mentions you must use the ``` MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v73/methods/messages_sendMultiMedia.md b/old_docs/API_docs_v73/methods/messages_sendMultiMedia.md index 4831ff6f..77fa2031 100644 --- a/old_docs/API_docs_v73/methods/messages_sendMultiMedia.md +++ b/old_docs/API_docs_v73/methods/messages_sendMultiMedia.md @@ -12,12 +12,12 @@ Send an album | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notification?| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear draft?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notification?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear draft?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the album| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| -|multi\_media|Array of [CLICK ME InputSingleMedia](../types/InputSingleMedia.md) | Yes|The album| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|multi\_media|Array of [InputSingleMedia](../types/InputSingleMedia.md) | Yes|The album| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v73/methods/messages_sendScreenshotNotification.md index e823fd52..9db86b56 100644 --- a/old_docs/API_docs_v73/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v73/methods/messages_sendScreenshotNotification.md @@ -13,7 +13,7 @@ Send screenshot notification | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes|Reply to message by ID| +|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| ### Return type: [Updates](../types/Updates.md) @@ -21,13 +21,6 @@ Send screenshot notification ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Updates = messages.sendScreenshotNotification({peer=InputPeer, reply_to_msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v73/methods/messages_setBotCallbackAnswer.md index e221ccca..34c7bb16 100644 --- a/old_docs/API_docs_v73/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v73/methods/messages_setBotCallbackAnswer.md @@ -12,11 +12,11 @@ Bots only: set the callback answer (after a button was clicked) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| -|message|[CLICK ME string](../types/string.md) | Optional|The message| -|url|[CLICK ME string](../types/string.md) | Optional|The URL| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| +|url|[string](../types/string.md) | Optional|The URL| +|cache\_time|[int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) @@ -24,13 +24,6 @@ Bots only: set the callback answer (after a button was clicked) ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -90,3 +83,10 @@ Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v73/methods/messages_setBotPrecheckoutResults.md index 7e3fc3c2..f631bf0c 100644 --- a/old_docs/API_docs_v73/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v73/methods/messages_setBotPrecheckoutResults.md @@ -12,9 +12,9 @@ Bots only: set precheckout results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| +|success|[Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set precheckout results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ERROR_TEXT_EMPTY|The provided error message is empty| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotPrecheckoutResults({success=Bool, query_id=long, error='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ERROR_TEXT_EMPTY|The provided error message is empty| + + diff --git a/old_docs/API_docs_v73/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v73/methods/messages_setBotShippingResults.md index 3d9f0ae2..915cfebf 100644 --- a/old_docs/API_docs_v73/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v73/methods/messages_setBotShippingResults.md @@ -12,9 +12,9 @@ Bots only: set shipping results | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|error|[CLICK ME string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) @@ -22,13 +22,6 @@ Bots only: set shipping results ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|QUERY_ID_INVALID|The query ID is invalid| - - ### MadelineProto Example: @@ -78,3 +71,10 @@ Or, if you're into Lua: Bool = messages.setBotShippingResults({query_id=long, error='string', shipping_options={ShippingOption}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v73/methods/messages_setEncryptedTyping.md index 4e7450eb..6448b58f 100644 --- a/old_docs/API_docs_v73/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v73/methods/messages_setEncryptedTyping.md @@ -13,7 +13,7 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) @@ -21,13 +21,6 @@ Send typing notification to secret chat ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_setGameScore.md b/old_docs/API_docs_v73/methods/messages_setGameScore.md index 90594a1d..c3d5a2c7 100644 --- a/old_docs/API_docs_v73/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v73/methods/messages_setGameScore.md @@ -12,12 +12,12 @@ Set the game score | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|id|[int](../types/int.md) | Yes|The message ID| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) @@ -25,14 +25,6 @@ Set the game score ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -88,3 +80,11 @@ Or, if you're into Lua: Updates = messages.setGameScore({edit_message=Bool, force=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v73/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v73/methods/messages_setInlineBotResults.md index d4ba6e65..e46598e2 100644 --- a/old_docs/API_docs_v73/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v73/methods/messages_setInlineBotResults.md @@ -12,13 +12,13 @@ Bots only: set the results of an inline query | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| -|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) @@ -26,23 +26,6 @@ Bots only: set the results of an inline query ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|ARTICLE_TITLE_EMPTY|The title of the article is empty| -|BUTTON_DATA_INVALID|The provided button data is invalid| -|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| -|BUTTON_URL_INVALID|Button URL invalid| -|MESSAGE_EMPTY|The provided message is empty| -|QUERY_ID_INVALID|The query ID is invalid| -|REPLY_MARKUP_INVALID|The provided reply markup is invalid| -|RESULT_TYPE_INVALID|Result type invalid| -|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| -|START_PARAM_INVALID|Start parameter invalid| -|USER_BOT_INVALID|This method can only be called by a bot| - - ### MadelineProto Example: @@ -100,3 +83,20 @@ Or, if you're into Lua: Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v73/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v73/methods/messages_setInlineGameScore.md index 2b7326f3..d33da5ef 100644 --- a/old_docs/API_docs_v73/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v73/methods/messages_setInlineGameScore.md @@ -12,11 +12,11 @@ Set the game score of an inline message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[CLICK ME int](../types/int.md) | Yes|The score| +|score|[int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) @@ -24,14 +24,6 @@ Set the game score of an inline message ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| -|USER_BOT_REQUIRED|This method can only be called by a bot| - - ### MadelineProto Example: @@ -85,3 +77,11 @@ Or, if you're into Lua: Bool = messages.setInlineGameScore({edit_message=Bool, force=Bool, id=InputBotInlineMessageID, user_id=InputUser, score=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v73/methods/messages_setTyping.md b/old_docs/API_docs_v73/methods/messages_setTyping.md index a2b94823..02ff82dd 100644 --- a/old_docs/API_docs_v73/methods/messages_setTyping.md +++ b/old_docs/API_docs_v73/methods/messages_setTyping.md @@ -13,7 +13,7 @@ Change typing status | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[CLICK ME SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| ### Return type: [Bool](../types/Bool.md) @@ -21,20 +21,6 @@ Change typing status ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHANNEL_INVALID|The provided channel is invalid| -|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| -|CHAT_ID_INVALID|The provided chat id is invalid| -|PEER_ID_INVALID|The provided peer id is invalid| -|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| -|USER_IS_BLOCKED|User is blocked| -|USER_IS_BOT|Bots can't send messages to other bots| -|CHAT_WRITE_FORBIDDEN|You can't write in this chat| - - ### MadelineProto Example: @@ -82,3 +68,17 @@ Or, if you're into Lua: Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v73/methods/messages_startBot.md b/old_docs/API_docs_v73/methods/messages_startBot.md index 50d6f475..408cff54 100644 --- a/old_docs/API_docs_v73/methods/messages_startBot.md +++ b/old_docs/API_docs_v73/methods/messages_startBot.md @@ -14,7 +14,7 @@ Start a bot |----------|---------------|----------|-------------| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) @@ -22,16 +22,6 @@ Start a bot ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_INVALID|This is not a valid bot| -|PEER_ID_INVALID|The provided peer id is invalid| -|START_PARAM_EMPTY|The start parameter is empty| -|START_PARAM_INVALID|Start parameter invalid| - - ### MadelineProto Example: @@ -72,3 +62,13 @@ Or, if you're into Lua: Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v73/methods/messages_toggleChatAdmins.md index 349ea0e6..76d194eb 100644 --- a/old_docs/API_docs_v73/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v73/methods/messages_toggleChatAdmins.md @@ -13,7 +13,7 @@ Enable all users are admins in normal groups (not supergroups) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) @@ -21,14 +21,6 @@ Enable all users are admins in normal groups (not supergroups) ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CHAT_ID_INVALID|The provided chat id is invalid| -|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v73/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v73/methods/messages_toggleDialogPin.md index 14332533..6c57ce0a 100644 --- a/old_docs/API_docs_v73/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v73/methods/messages_toggleDialogPin.md @@ -12,7 +12,7 @@ Pin or unpin dialog | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| @@ -21,13 +21,6 @@ Pin or unpin dialog ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -66,3 +59,10 @@ Or, if you're into Lua: Bool = messages.toggleDialogPin({pinned=Bool, peer=InputPeer, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v73/methods/messages_uninstallStickerSet.md index 26b2fbb3..46efb377 100644 --- a/old_docs/API_docs_v73/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v73/methods/messages_uninstallStickerSet.md @@ -12,7 +12,7 @@ Remove a sticker set | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) @@ -20,13 +20,6 @@ Remove a sticker set ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v73/methods/messages_uploadMedia.md b/old_docs/API_docs_v73/methods/messages_uploadMedia.md index c09da017..4d511a15 100644 --- a/old_docs/API_docs_v73/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v73/methods/messages_uploadMedia.md @@ -21,15 +21,6 @@ Upload a file without sending it to anyone ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|MEDIA_INVALID|Media invalid| -|PEER_ID_INVALID|The provided peer id is invalid| - - ### MadelineProto Example: @@ -77,3 +68,12 @@ Or, if you're into Lua: MessageMedia = messages.uploadMedia({peer=InputPeer, media=InputMedia, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|MEDIA_INVALID|Media invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v73/methods/payments_clearSavedInfo.md index 8b83266f..117db209 100644 --- a/old_docs/API_docs_v73/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v73/methods/payments_clearSavedInfo.md @@ -12,8 +12,8 @@ Clear saved payments info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| +|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/payments_getPaymentForm.md b/old_docs/API_docs_v73/methods/payments_getPaymentForm.md index 3bdb9ff2..f68aa039 100644 --- a/old_docs/API_docs_v73/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v73/methods/payments_getPaymentForm.md @@ -12,7 +12,7 @@ Get payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|msg\_id|[int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) @@ -20,13 +20,6 @@ Get payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentForm = payments.getPaymentForm({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v73/methods/payments_getPaymentReceipt.md index a881aeb7..13073925 100644 --- a/old_docs/API_docs_v73/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v73/methods/payments_getPaymentReceipt.md @@ -12,7 +12,7 @@ Get payment receipt | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|msg\_id|[int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) @@ -20,13 +20,6 @@ Get payment receipt ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -63,3 +56,10 @@ Or, if you're into Lua: payments_PaymentReceipt = payments.getPaymentReceipt({msg_id=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v73/methods/payments_sendPaymentForm.md index 79758b56..678b749b 100644 --- a/old_docs/API_docs_v73/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v73/methods/payments_sendPaymentForm.md @@ -12,10 +12,10 @@ Bots only: send payment form | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +|msg\_id|[int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) @@ -23,13 +23,6 @@ Bots only: send payment form ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -72,3 +65,10 @@ Or, if you're into Lua: payments_PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v73/methods/payments_validateRequestedInfo.md index d473f97c..df6a9ba9 100644 --- a/old_docs/API_docs_v73/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v73/methods/payments_validateRequestedInfo.md @@ -12,9 +12,9 @@ Validate requested payment info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +|save|[Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) @@ -22,13 +22,6 @@ Validate requested payment info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MESSAGE_ID_INVALID|The provided message id is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: payments_ValidatedRequestedInfo = payments.validateRequestedInfo({save=Bool, msg_id=int, info=PaymentRequestedInfo, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v73/methods/phone_receivedCall.md b/old_docs/API_docs_v73/methods/phone_receivedCall.md index 17095622..6141a0ab 100644 --- a/old_docs/API_docs_v73/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v73/methods/phone_receivedCall.md @@ -12,7 +12,7 @@ Notify server that you received a call (server will refuse all incoming calls un | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| ### Return type: [Bool](../types/Bool.md) @@ -20,14 +20,6 @@ Notify server that you received a call (server will refuse all incoming calls un ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_ALREADY_DECLINED|The call was already declined| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -64,3 +56,11 @@ Or, if you're into Lua: Bool = phone.receivedCall({peer=InputPhoneCall, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_ALREADY_DECLINED|The call was already declined| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v73/methods/phone_saveCallDebug.md b/old_docs/API_docs_v73/methods/phone_saveCallDebug.md index 0ff049a8..9f3daa18 100644 --- a/old_docs/API_docs_v73/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v73/methods/phone_saveCallDebug.md @@ -12,8 +12,8 @@ Save call debugging info | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Debugging info| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| +|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| ### Return type: [Bool](../types/Bool.md) @@ -21,14 +21,6 @@ Save call debugging info ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| -|DATA_JSON_INVALID|The provided JSON data is invalid| - - ### MadelineProto Example: @@ -67,3 +59,11 @@ Or, if you're into Lua: Bool = phone.saveCallDebug({peer=InputPhoneCall, debug=DataJSON, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| +|DATA_JSON_INVALID|The provided JSON data is invalid| + + diff --git a/old_docs/API_docs_v73/methods/phone_setCallRating.md b/old_docs/API_docs_v73/methods/phone_setCallRating.md index d0aab7e0..d9833492 100644 --- a/old_docs/API_docs_v73/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v73/methods/phone_setCallRating.md @@ -12,9 +12,9 @@ Set phone call rating | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[CLICK ME int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[CLICK ME string](../types/string.md) | Yes|An optional comment| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| +|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| +|comment|[string](../types/string.md) | Yes|An optional comment| ### Return type: [Updates](../types/Updates.md) @@ -22,13 +22,6 @@ Set phone call rating ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|CALL_PEER_INVALID|The provided call peer object is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: Updates = phone.setCallRating({peer=InputPhoneCall, rating=int, comment='string', }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v73/methods/photos_getUserPhotos.md b/old_docs/API_docs_v73/methods/photos_getUserPhotos.md index d1c15e90..03a763e3 100644 --- a/old_docs/API_docs_v73/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v73/methods/photos_getUserPhotos.md @@ -13,9 +13,9 @@ Get the profile photos of a user | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[CLICK ME int](../types/int.md) | Yes|Offset| -|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) @@ -23,14 +23,6 @@ Get the profile photos of a user ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|MAX_ID_INVALID|The provided max ID is invalid| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -82,3 +74,11 @@ Or, if you're into Lua: photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v73/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v73/methods/photos_uploadProfilePhoto.md index c7ec3063..0c994ffe 100644 --- a/old_docs/API_docs_v73/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v73/methods/photos_uploadProfilePhoto.md @@ -20,16 +20,6 @@ Upload profile photo ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|FILE_PARTS_INVALID|The number of file parts is invalid| -|IMAGE_PROCESS_FAILED|Failure while processing image| -|PHOTO_CROP_SIZE_SMALL|Photo is too small| -|PHOTO_EXT_INVALID|The extension of the photo is invalid| - - ### MadelineProto Example: @@ -66,3 +56,13 @@ Or, if you're into Lua: photos_Photo = photos.uploadProfilePhoto({file=InputFile, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v73/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v73/methods/stickers_addStickerToSet.md index 7c4191d8..6e1d680c 100644 --- a/old_docs/API_docs_v73/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v73/methods/stickers_addStickerToSet.md @@ -12,8 +12,8 @@ Add sticker to stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -21,14 +21,6 @@ Add sticker to stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKERSET_INVALID|The provided sticker set is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.addStickerToSet({stickerset=InputStickerSet, sticker=InputStickerSetItem, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v73/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v73/methods/stickers_changeStickerPosition.md index d25129c5..6e8e2505 100644 --- a/old_docs/API_docs_v73/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v73/methods/stickers_changeStickerPosition.md @@ -13,7 +13,7 @@ Change sticker position in photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[CLICK ME int](../types/int.md) | Yes|New position| +|position|[int](../types/int.md) | Yes|New position| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -21,14 +21,6 @@ Change sticker position in photo ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKER_INVALID|The provided sticker is invalid| - - ### MadelineProto Example: @@ -76,3 +68,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.changeStickerPosition({sticker=InputDocument, position=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v73/methods/stickers_createStickerSet.md b/old_docs/API_docs_v73/methods/stickers_createStickerSet.md index 95775849..371033ca 100644 --- a/old_docs/API_docs_v73/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v73/methods/stickers_createStickerSet.md @@ -12,11 +12,11 @@ Create stickerset | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Masks?| +|masks|[Bool](../types/Bool.md) | Optional|Masks?| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[CLICK ME string](../types/string.md) | Yes|The stickerset title| -|short\_name|[CLICK ME string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +|title|[string](../types/string.md) | Yes|The stickerset title| +|short\_name|[string](../types/string.md) | Yes|The stickerset short name| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) @@ -24,21 +24,6 @@ Create stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|PACK_SHORT_NAME_INVALID|Short pack name invalid| -|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| -|PEER_ID_INVALID|The provided peer id is invalid| -|STICKER_EMOJI_INVALID|Sticker emoji invalid| -|STICKER_FILE_INVALID|Sticker file invalid| -|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| -|STICKERS_EMPTY|No sticker provided| -|USER_ID_INVALID|The provided user ID is invalid| - - ### MadelineProto Example: @@ -92,3 +77,18 @@ Or, if you're into Lua: messages_StickerSet = stickers.createStickerSet({masks=Bool, user_id=InputUser, title='string', short_name='string', stickers={InputStickerSetItem}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|PACK_SHORT_NAME_INVALID|Short pack name invalid| +|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| +|PEER_ID_INVALID|The provided peer id is invalid| +|STICKER_EMOJI_INVALID|Sticker emoji invalid| +|STICKER_FILE_INVALID|Sticker file invalid| +|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| +|STICKERS_EMPTY|No sticker provided| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v73/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v73/methods/stickers_removeStickerFromSet.md index 73ed78d5..5e3a4291 100644 --- a/old_docs/API_docs_v73/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v73/methods/stickers_removeStickerFromSet.md @@ -20,14 +20,6 @@ Remove sticker from stickerset ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|BOT_MISSING|This method can only be run by a bot| -|STICKER_INVALID|The provided sticker is invalid| - - ### MadelineProto Example: @@ -73,3 +65,11 @@ Or, if you're into Lua: messages_StickerSet = stickers.removeStickerFromSet({sticker=InputDocument, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v73/methods/upload_getWebFile.md b/old_docs/API_docs_v73/methods/upload_getWebFile.md index 11634633..f869519a 100644 --- a/old_docs/API_docs_v73/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v73/methods/upload_getWebFile.md @@ -12,9 +12,9 @@ Download a file through telegram | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| -|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[int](../types/int.md) | Yes|The offset in bytes| +|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) @@ -22,13 +22,6 @@ Download a file through telegram ### Can bots use this method: **NO** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|LOCATION_INVALID|The provided location is invalid| - - ### MadelineProto Example: @@ -69,3 +62,10 @@ Or, if you're into Lua: upload_WebFile = upload.getWebFile({location=InputWebFileLocation, offset=int, limit=int, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LOCATION_INVALID|The provided location is invalid| + + diff --git a/old_docs/API_docs_v73/methods/users_getUsers.md b/old_docs/API_docs_v73/methods/users_getUsers.md index bce13ee6..f8d789cd 100644 --- a/old_docs/API_docs_v73/methods/users_getUsers.md +++ b/old_docs/API_docs_v73/methods/users_getUsers.md @@ -20,16 +20,6 @@ Get info about users ### Can bots use this method: **YES** -### Errors this method can return: - -| Error | Description | -|----------|---------------| -|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| -|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| -|NEED_MEMBER_INVALID|The provided member is invalid| -|Timeout|A timeout occurred while fetching data from the bot| - - ### MadelineProto Example: @@ -75,3 +65,13 @@ Or, if you're into Lua: Vector_of_User = users.getUsers({id={InputUser}, }) ``` +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/src/danog/MadelineProto/DocsBuilder/Methods.php b/src/danog/MadelineProto/DocsBuilder/Methods.php index d77c0eae..c3361318 100644 --- a/src/danog/MadelineProto/DocsBuilder/Methods.php +++ b/src/danog/MadelineProto/DocsBuilder/Methods.php @@ -111,7 +111,7 @@ trait Methods case 'false': $ptype = 'Bool'; } - $human_ptype = 'CLICK ME '.$ptype; + $human_ptype = $ptype; if (in_array($ptype, ['User', 'InputUser', 'Chat', 'InputChannel', 'Peer', 'InputPeer']) && !isset($this->settings['td'])) { $human_ptype = 'Username, chat ID, Update, Message or '.$ptype; } @@ -199,17 +199,6 @@ description: '.$description.' $example = ''; if (!isset($this->settings['td'])) { $example .= '### Can bots use this method: **'.($bot ? 'YES' : 'NO')."**\n\n\n"; - if (isset($errors['result'][$data['method']])) { - $example .= '### Errors this method can return: - -| Error | Description | -|----------|---------------| -'; - foreach ($errors['result'][$data['method']] as $error) { - $example .= '|'.$error.'|'.$errors['human_result'][$error][0].'|'."\n"; - } - $example .= "\n\n"; - } $example .= str_replace('[]', '', '### MadelineProto Example: @@ -306,6 +295,17 @@ You can also use normal markdown, note that to create mentions you must use the MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). '; } + if (isset($errors['result'][$data['method']])) { + $example .= '### Errors this method can return: + +| Error | Description | +|----------|---------------| +'; + foreach ($errors['result'][$data['method']] as $error) { + $example .= '|'.$error.'|'.$errors['human_result'][$error][0].'|'."\n"; + } + $example .= "\n\n"; + } } file_put_contents('methods/'.$method.'.md', $header.$table.$return.$example); }