auth.cancelCode
auth.cancelCode
Section titled “auth.cancelCode”No description provided by the pinned schema.
Signature
Section titled “Signature”auth.cancelCode#1f040578 phone_number:string phone_code_hash:string = Bool;Result type
Section titled “Result type”Bool
Parameters
Section titled “Parameters”| Name | Type | Flag | Default | Description |
|---|---|---|---|---|
| phone_number | string | — | — | No description provided by the pinned schema. |
| phone_code_hash | string | — | — | No description provided by the pinned schema. |
Python binding
Section titled “Python binding”from miniproto.raw.functions import AuthCancelCodePublic access: miniproto.raw.functions.AuthCancelCode.
Safe usage shape
Section titled “Safe usage shape”from miniproto.raw.functions import AuthCancelCode
# Naming the raw request class is local only; it performs no I/O or network request.request_type = AuthCancelCodeResult family
Section titled “Result family”RPC errors
Section titled “RPC errors”| Code | Error | Description |
|---|---|---|
| 400 | BUSINESS_CONNECTION_NOT_ALLOWED | This method was invoked over a business connection using invokeWithBusinessConnection, but either (1) we’re a user, and users cannot invoke methods over a business connection; (2) we’re a bot, but business mode was disabled in @botfather or (3); we’re a bot, but this method cannot be invoked over a business connection. |
| 400 | PHONE_CODE_EXPIRED | The phone code you provided has expired. |
| 400 | PHONE_NUMBER_INVALID | The phone number is invalid. |
| 406 | PHONE_NUMBER_INVALID | The phone number is invalid. |
Accepted types
Section titled “Accepted types”No non-primitive type relationships were found.
Returned types
Section titled “Returned types”Bool
Known selected constructors: boolFalse, boolTrue
Related methods
Section titled “Related methods”account.acceptAuthorization, account.cancelPasswordEmail, account.changeAuthorizationSettings, account.checkUsername, account.clearRecentEmojiStatuses, account.confirmBotConnection, account.confirmPasswordEmail, account.confirmPhone, account.declinePasswordReset, account.deleteAccount, account.deleteAutoSaveExceptions, account.deleteBusinessChatLink, account.deletePasskey, account.deleteSecureValue, account.disablePeerConnectedBot, account.finishTakeoutSession, account.getContactSignUpNotification, account.installTheme, account.installWallPaper, account.invalidateSignInCodes, account.registerDevice, account.reorderUsernames, account.reportPeer, account.reportProfilePhoto, account.resendPasswordEmail, account.resetAuthorization, account.resetNotifySettings, account.resetWallPapers, account.resetWebAuthorization, account.resetWebAuthorizations, account.saveAutoDownloadSettings, account.saveAutoSaveSettings, account.saveMusic, account.saveRingtone, account.saveTheme, account.saveWallPaper, account.setAccountTTL, account.setAuthorizationTTL, account.setContactSignUpNotification, account.setContentSettings, account.setMainProfileTab, account.toggleConnectedBotPaused, account.toggleNoPaidMessagesException, account.toggleSponsoredMessages, account.toggleUsername, account.toggleWebBrowserSettingsException, account.unregisterDevice, account.updateBirthday, account.updateBusinessAwayMessage, account.updateBusinessGreetingMessage, account.updateBusinessIntro, account.updateBusinessLocation, account.updateBusinessWorkHours, account.updateColor, account.updateDeviceLocked, account.updateEmojiStatus, account.updateNotifySettings, account.updatePasswordSettings, account.updatePersonalChannel, account.updateStatus, account.verifyPhone, aicompose.deleteTone, aicompose.saveTone, aicompose.updateTone, auth.bindTempAuthKey, auth.checkRecoveryPassword, auth.dropTempAuthKeys, auth.reportMissingCode, auth.requestFirebaseSms, auth.resetAuthorizations, bots.answerWebhookJSONQuery, bots.canSendMessage, bots.checkDownloadFileParams, bots.checkUsername, bots.deletePreviewMedia, bots.editAccessSettings, bots.exportBotToken, bots.reorderPreviewMedias, bots.reorderUsernames, bots.resetBotCommands, bots.setBotBroadcastDefaultAdminRights, bots.setBotCommands, bots.setBotGroupDefaultAdminRights, bots.setBotInfo, bots.setBotMenuButton, bots.setCustomVerification, bots.setJoinChatResults, bots.toggleUserEmojiStatusPermission, bots.toggleUsername, bots.updateUserEmojiStatus, channels.checkUsername, channels.deactivateAllUsernames, channels.editLocation, channels.readHistory, channels.readMessageContents, channels.reorderUsernames, channels.reportAntiSpamFalsePositive, channels.reportSpam, channels.restrictSponsoredMessages, channels.setDiscussionGroup, channels.setEmojiStickers, channels.setMainProfileTab, channels.setStickers, channels.toggleAntiSpam, channels.toggleAutotranslation, channels.toggleForum, channels.toggleJoinRequest, channels.toggleJoinToSend, channels.toggleParticipantsHidden, channels.togglePreHistoryHidden, channels.toggleUsername, channels.toggleViewForumAsMessages, channels.updateUsername, chatlists.deleteExportedInvite, chatlists.hideChatlistUpdates, communities.toggleAllPeerLinkRequestApproval, communities.toggleParticipantBanned, communities.togglePeerLink, communities.togglePeerLinkRequestApproval, contacts.block, contacts.deleteByPhones, contacts.editCloseFriends, contacts.resetSaved, contacts.resetTopPeerRating, contacts.setBlocked, contacts.toggleTopPeers, contacts.unblock, contacts.updateContactNote, ephemeral.deleteMessage, help.acceptTermsOfService, help.dismissSuggestion, help.hidePromoData, help.saveAppLog, help.setBotUpdatesStatus, messages.checkQuickReplyShortcut, messages.checkUrlAuthMatchCode, messages.clearAllDrafts, messages.clearRecentReactions, messages.clearRecentStickers, messages.clickSponsoredMessage, messages.declineUrlAuth, messages.deleteChat, messages.deleteExportedChatInvite, messages.deleteParticipantReactions, messages.deleteQuickReplyShortcut, messages.deleteRevokedExportedChatInvites, messages.discardEncryption, messages.editChatAbout, messages.editChatAdmin, messages.editExportedChatInvite, messages.editForumTopic, messages.editInlineBotMessage, messages.editQuickReplyShortcut, messages.faveSticker, messages.getMessagesViews, messages.hidePeerSettingsBar, messages.installStickerSet, messages.markDialogUnread, messages.prolongWebView, messages.rateTranscribedAudio, messages.readDiscussion, messages.readEncryptedHistory, messages.readFeaturedStickers, messages.readSavedHistory, messages.reorderPinnedDialogs, messages.reorderPinnedSavedDialogs, messages.reorderQuickReplies, messages.reorderStickerSets, messages.reportEncryptedSpam, messages.reportMessagesDelivery, messages.reportMusicListen, messages.reportReaction, messages.reportReadMetrics, messages.reportSpam, messages.saveDefaultSendAs, messages.saveDraft, messages.saveGif, messages.saveRecentSticker, messages.setBotCallbackAnswer, messages.setBotPrecheckoutResults, messages.setBotShippingResults, messages.setChatAvailableReactions, messages.setDefaultHistoryTTL, messages.setDefaultReaction, messages.setEncryptedTyping, messages.setInlineBotResults, messages.setInlineGameScore, messages.setTyping, messages.startHistoryImport, messages.toggleBotInAttachMenu, messages.toggleDialogFilterTags, messages.toggleDialogPin, messages.toggleNoForwards, messages.togglePaidReactionPrivacy, messages.togglePeerTranslations, messages.toggleSavedDialogPin, messages.toggleStickerSets, messages.uninstallStickerSet, messages.updateDialogFilter, messages.updateDialogFiltersOrder, messages.updatePinnedForumTopic, messages.updateSavedReactionTag, messages.viewSponsoredMessage, payments.botCancelStarsSubscription, payments.canPurchaseStore, payments.changeStarsSubscription, payments.clearSavedInfo, payments.convertStarGift, payments.deleteStarGiftCollection, payments.fulfillStarsSubscription, payments.reorderStarGiftCollections, payments.saveStarGift, payments.toggleChatStarGiftNotifications, payments.toggleStarGiftsPinnedToTop, phone.editGroupCallParticipant, phone.getGroupCallStreamRtmpUrl, phone.receivedCall, phone.saveCallDebug, phone.saveCallLog, phone.saveDefaultGroupCallJoinAs, phone.saveDefaultSendAs, phone.sendGroupCallEncryptedMessage, phone.sendSignalingData, phone.toggleGroupCallRecord, phone.toggleGroupCallSettings, phone.toggleGroupCallStartSubscription, smsjobs.finishJob, smsjobs.join, smsjobs.leave, smsjobs.updateSettings, stickers.checkShortName, stickers.deleteStickerSet, stories.deleteAlbum, stories.incrementStoryViews, stories.reorderAlbums, stories.startLive, stories.toggleAllStoriesHidden, stories.togglePeerStoriesHidden, stories.togglePinned, stories.togglePinnedToTop, upload.saveBigFilePart, upload.saveFilePart, users.setSecureValueErrors
Availability evidence
Section titled “Availability evidence”- unauthenticated allowed
- user only
Provenance
Section titled “Provenance”- layer: 228
- structural source:
tdlib - canonical schema: https://raw.githubusercontent.com/tdlib/td/refs/heads/master/td/generate/scheme/telegram_api.tl
- prose merge precedence: TDLib → Telegram Desktop → Core JSON
- source note: Canonical structure is the pinned TDLib telegram_api.tl; Layer 228 comes only from the matching Telegram Desktop end-of-file marker; core.telegram.org inputs enrich documentation and RPC error metadata without overriding structure.
Source-diff notes
Section titled “Source-diff notes”- tdlib_vs_core: changed_count=68; core_only_count=1; overlap_count=2302; tdlib_only_count=158
- tdlib_vs_tdesktop: changed_count=0; overlap_count=2448; tdesktop_only=null; tdlib_only=accessPointRule, ephemeral.editMessage, help.configSimple, inputPeerPhotoFileLocationLegacy, inputStickerSetThumbLegacy, invokeWithApnsSecretPrefix, invokeWithBusinessConnectionPrefix, invokeWithGooglePlayIntegrityPrefix, invokeWithReCaptchaPrefix, ipPort, ipPortSecret, updateEphemeralBotCallbackQuery
miniprotoFast paths where they count. Explicit boundaries everywhere else.