Cluster · разработчикам

TL auth · методы

Каталог и общие правила · Справочник SDK

auth.AcceptLoginToken

Аргументы

• token: bytes, обязательный.

Результат

Authorization, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.AcceptLoginToken(token=token)

Описание Telegram

auth.BindTempAuthKey

Аргументы

• encrypted_message: bytes, обязательный.
• expires_at: Optional[datetime.datetime], обязательный.
• nonce: int, обязательный.
• perm_auth_key_id: int, обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.BindTempAuthKey(encrypted_message=encrypted_message, expires_at=expires_at, nonce=nonce, perm_auth_key_id=perm_auth_key_id)

Описание Telegram

auth.CancelCode

Аргументы

• phone_code_hash: str, обязательный.
• phone_number: str, обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.CancelCode(phone_code_hash=phone_code_hash, phone_number=phone_number)

Описание Telegram

auth.CheckPaidAuth

Аргументы

• form_id: int, обязательный.
• phone_code_hash: str, обязательный.
• phone_number: str, обязательный.

Результат

auth.SentCode, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.CheckPaidAuth(form_id=form_id, phone_code_hash=phone_code_hash, phone_number=phone_number)

Описание Telegram

auth.CheckPassword

Аргументы

• password: 'TypeInputCheckPasswordSRP', обязательный.

Результат

auth.Authorization, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.CheckPassword(password=password)

Описание Telegram

auth.CheckRecoveryPassword

Аргументы

• code: str, обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.CheckRecoveryPassword(code=code)

Описание Telegram

auth.DropTempAuthKeys

Аргументы

• except_auth_keys: List[int], обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.DropTempAuthKeys(except_auth_keys=except_auth_keys)

Описание Telegram

auth.ExportAuthorization

Аргументы

• dc_id: int, обязательный.

Результат

auth.ExportedAuthorization, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.ExportAuthorization(dc_id=dc_id)

Описание Telegram

auth.ExportLoginToken

Аргументы

• api_hash: str, обязательный.
• api_id: int, обязательный.
• except_ids: List[int], обязательный.

Результат

auth.LoginToken, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.ExportLoginToken(api_hash=api_hash, api_id=api_id, except_ids=except_ids)

Описание Telegram

auth.FinishFirebasePnvLogin

Аргументы

• google_token: str, обязательный.

Результат

auth.Authorization, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.FinishFirebasePnvLogin(google_token=google_token)

Описание Telegram

auth.FinishPasskeyLogin

Аргументы

• credential: 'TypeInputPasskeyCredential', обязательный.
• from_auth_key_id: Optional[int], необязательный; значение None.
• from_dc_id: Optional[int], необязательный; значение None.

Результат

auth.Authorization, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.FinishPasskeyLogin(credential=credential)

Описание Telegram

auth.FirebasePnvSignUp

Аргументы

• first_name: str, обязательный.
• last_name: str, обязательный.
• no_joined_notifications: Optional[bool], необязательный; значение None.

Результат

auth.Authorization, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.FirebasePnvSignUp(first_name=first_name, last_name=last_name)

Описание Telegram

auth.ImportAuthorization

Аргументы

• bytes: bytes, обязательный.
• id: int, обязательный.

Результат

auth.Authorization, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.ImportAuthorization(bytes=bytes, id=id)

Описание Telegram

auth.ImportBotAuthorization

Аргументы

• api_hash: str, обязательный.
• api_id: int, обязательный.
• bot_auth_token: str, обязательный.
• flags: int, обязательный.

Результат

auth.Authorization, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.ImportBotAuthorization(api_hash=api_hash, api_id=api_id, bot_auth_token=bot_auth_token, flags=flags)

Описание Telegram

auth.ImportLoginToken

Аргументы

• token: bytes, обязательный.

Результат

auth.LoginToken, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.ImportLoginToken(token=token)

Описание Telegram

auth.ImportWebTokenAuthorization

Аргументы

• api_hash: str, обязательный.
• api_id: int, обязательный.
• web_auth_token: str, обязательный.

Результат

auth.Authorization, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.ImportWebTokenAuthorization(api_hash=api_hash, api_id=api_id, web_auth_token=web_auth_token)

Описание Telegram

auth.InitFirebasePnvLogin

Аргументы

• api_hash: str, обязательный.
• api_id: int, обязательный.

Результат

auth.FirebasePnvIntent, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.InitFirebasePnvLogin(api_hash=api_hash, api_id=api_id)

Описание Telegram

auth.InitPasskeyLogin

Аргументы

• api_hash: str, обязательный.
• api_id: int, обязательный.

Результат

auth.PasskeyLoginOptions, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.InitPasskeyLogin(api_hash=api_hash, api_id=api_id)

Описание Telegram

auth.LogOut

Аргументы

Нет.

Результат

auth.LoggedOut, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.LogOut()

Описание Telegram

auth.RecoverPassword

Аргументы

• code: str, обязательный.
• new_settings: Optional[ForwardRef('TypePasswordInputSettings')], необязательный; значение None.

Результат

auth.Authorization, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.RecoverPassword(code=code)

Описание Telegram

auth.ReportMissingCode

Аргументы

• mnc: str, обязательный.
• phone_code_hash: str, обязательный.
• phone_number: str, обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.ReportMissingCode(mnc=mnc, phone_code_hash=phone_code_hash, phone_number=phone_number)

Описание Telegram

auth.RequestFirebaseSms

Аргументы

• ios_push_secret: Optional[str], необязательный; значение None.
• phone_code_hash: str, обязательный.
• phone_number: str, обязательный.
• play_integrity_token: Optional[str], необязательный; значение None.
• safety_net_token: Optional[str], необязательный; значение None.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.RequestFirebaseSms(phone_code_hash=phone_code_hash, phone_number=phone_number)

Описание Telegram

auth.RequestPasswordRecovery

Аргументы

Нет.

Результат

auth.PasswordRecovery, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.RequestPasswordRecovery()

Описание Telegram

auth.ResendCode

Аргументы

• phone_code_hash: str, обязательный.
• phone_number: str, обязательный.
• reason: Optional[str], необязательный; значение None.

Результат

auth.SentCode, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.ResendCode(phone_code_hash=phone_code_hash, phone_number=phone_number)

Описание Telegram

auth.ResetAuthorizations

Аргументы

Нет.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.ResetAuthorizations()

Описание Telegram

auth.ResetLoginEmail

Аргументы

• phone_code_hash: str, обязательный.
• phone_number: str, обязательный.

Результат

auth.SentCode, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.ResetLoginEmail(phone_code_hash=phone_code_hash, phone_number=phone_number)

Описание Telegram

auth.SendCode

Аргументы

• api_hash: str, обязательный.
• api_id: int, обязательный.
• phone_number: str, обязательный.
• settings: 'TypeCodeSettings', обязательный.

Результат

auth.SentCode, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.SendCode(api_hash=api_hash, api_id=api_id, phone_number=phone_number, settings=settings)

Описание Telegram

auth.SignIn

Аргументы

• email_verification: Optional[ForwardRef('TypeEmailVerification')], необязательный; значение None.
• phone_code: Optional[str], необязательный; значение None.
• phone_code_hash: str, обязательный.
• phone_number: str, обязательный.

Результат

auth.Authorization, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.SignIn(phone_code_hash=phone_code_hash, phone_number=phone_number)

Описание Telegram

auth.SignUp

Аргументы

• first_name: str, обязательный.
• last_name: str, обязательный.
• no_joined_notifications: Optional[bool], необязательный; значение None.
• phone_code_hash: str, обязательный.
• phone_number: str, обязательный.

Результат

auth.Authorization, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.SignUp(first_name=first_name, last_name=last_name, phone_code_hash=phone_code_hash, phone_number=phone_number)

Описание Telegram

auth.TL

Аргументы

Нет.

Результат

Недоступный служебный тип, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.auth.TL()

Описание Telegram