Cluster · разработчикам
TL auth · типы
Каталог и общие правила · Справочник SDK
auth.Authorization
Аргументы
future_auth_token: Optional[bytes], необязательный; значение None.otherwise_relogin_days: Optional[int], необязательный; значение None.setup_password_required: Optional[bool], необязательный; значение None.tmp_sessions: Optional[int], необязательный; значение None.user: 'TypeUser', обязательный.
Результат
Словарь параметров с _="auth.Authorization".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.Authorization(user=user)auth.AuthorizationSignUpRequired
Аргументы
terms_of_service: Optional[ForwardRef('TypeTermsOfService')], необязательный; значение None.
Результат
Словарь параметров с _="auth.AuthorizationSignUpRequired".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.AuthorizationSignUpRequired()auth.CodeTypeCall
Аргументы
Нет.
Результат
Словарь параметров с _="auth.CodeTypeCall".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.CodeTypeCall()auth.CodeTypeFlashCall
Аргументы
Нет.
Результат
Словарь параметров с _="auth.CodeTypeFlashCall".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.CodeTypeFlashCall()auth.CodeTypeFragmentSms
Аргументы
Нет.
Результат
Словарь параметров с _="auth.CodeTypeFragmentSms".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.CodeTypeFragmentSms()auth.CodeTypeMissedCall
Аргументы
Нет.
Результат
Словарь параметров с _="auth.CodeTypeMissedCall".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.CodeTypeMissedCall()auth.CodeTypeSms
Аргументы
Нет.
Результат
Словарь параметров с _="auth.CodeTypeSms".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.CodeTypeSms()auth.ExportedAuthorization
Аргументы
bytes: bytes, обязательный.id: int, обязательный.
Результат
Словарь параметров с _="auth.ExportedAuthorization".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.ExportedAuthorization(bytes=bytes, id=id)auth.FirebasePnvIntent
Аргументы
digital_credential_payload: str, обязательный.nonce: str, обязательный.
Результат
Словарь параметров с _="auth.FirebasePnvIntent".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.FirebasePnvIntent(digital_credential_payload=digital_credential_payload, nonce=nonce)auth.LoggedOut
Аргументы
future_auth_token: Optional[bytes], необязательный; значение None.
Результат
Словарь параметров с _="auth.LoggedOut".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.LoggedOut()auth.LoginToken
Аргументы
expires: Optional[datetime.datetime], обязательный.token: bytes, обязательный.
Результат
Словарь параметров с _="auth.LoginToken".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.LoginToken(expires=expires, token=token)auth.LoginTokenMigrateTo
Аргументы
dc_id: int, обязательный.token: bytes, обязательный.
Результат
Словарь параметров с _="auth.LoginTokenMigrateTo".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.LoginTokenMigrateTo(dc_id=dc_id, token=token)auth.LoginTokenSuccess
Аргументы
authorization: 'TypeAuthorization', обязательный.
Результат
Словарь параметров с _="auth.LoginTokenSuccess".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.LoginTokenSuccess(authorization=authorization)auth.PasskeyLoginOptions
Аргументы
options: 'TypeDataJSON', обязательный.
Результат
Словарь параметров с _="auth.PasskeyLoginOptions".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.PasskeyLoginOptions(options=options)auth.PasswordRecovery
Аргументы
email_pattern: str, обязательный.
Результат
Словарь параметров с _="auth.PasswordRecovery".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.PasswordRecovery(email_pattern=email_pattern)auth.SentCode
Аргументы
next_type: Optional[ForwardRef('TypeCodeType')], необязательный; значение None.phone_code_hash: str, обязательный.timeout: Optional[int], необязательный; значение None.type: 'TypeSentCodeType', обязательный.
Результат
Словарь параметров с _="auth.SentCode".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCode(phone_code_hash=phone_code_hash, type=type)auth.SentCodePaymentRequired
Аргументы
amount: int, обязательный.currency: str, обязательный.phone_code_hash: str, обязательный.premium_days: int, обязательный.store_product: str, обязательный.support_email_address: str, обязательный.support_email_subject: str, обязательный.
Результат
Словарь параметров с _="auth.SentCodePaymentRequired".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCodePaymentRequired(amount=amount, currency=currency, phone_code_hash=phone_code_hash, premium_days=premium_days, store_product=store_product, support_email_address=support_email_address, support_email_subject=support_email_subject)auth.SentCodeSuccess
Аргументы
authorization: 'TypeAuthorization', обязательный.
Результат
Словарь параметров с _="auth.SentCodeSuccess".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCodeSuccess(authorization=authorization)auth.SentCodeTypeApp
Аргументы
length: int, обязательный.
Результат
Словарь параметров с _="auth.SentCodeTypeApp".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCodeTypeApp(length=length)auth.SentCodeTypeCall
Аргументы
length: int, обязательный.
Результат
Словарь параметров с _="auth.SentCodeTypeCall".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCodeTypeCall(length=length)auth.SentCodeTypeEmailCode
Аргументы
apple_signin_allowed: Optional[bool], необязательный; значение None.email_pattern: str, обязательный.google_signin_allowed: Optional[bool], необязательный; значение None.length: int, обязательный.reset_available_period: Optional[int], необязательный; значение None.reset_pending_date: Optional[datetime.datetime], необязательный; значение None.
Результат
Словарь параметров с _="auth.SentCodeTypeEmailCode".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCodeTypeEmailCode(email_pattern=email_pattern, length=length)auth.SentCodeTypeFirebaseSms
Аргументы
length: int, обязательный.nonce: Optional[bytes], необязательный; значение None.play_integrity_nonce: Optional[bytes], необязательный; значение None.play_integrity_project_id: Optional[int], необязательный; значение None.push_timeout: Optional[int], необязательный; значение None.receipt: Optional[str], необязательный; значение None.
Результат
Словарь параметров с _="auth.SentCodeTypeFirebaseSms".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCodeTypeFirebaseSms(length=length)auth.SentCodeTypeFlashCall
Аргументы
pattern: str, обязательный.
Результат
Словарь параметров с _="auth.SentCodeTypeFlashCall".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCodeTypeFlashCall(pattern=pattern)auth.SentCodeTypeFragmentSms
Аргументы
length: int, обязательный.url: str, обязательный.
Результат
Словарь параметров с _="auth.SentCodeTypeFragmentSms".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCodeTypeFragmentSms(length=length, url=url)auth.SentCodeTypeMissedCall
Аргументы
length: int, обязательный.prefix: str, обязательный.
Результат
Словарь параметров с _="auth.SentCodeTypeMissedCall".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCodeTypeMissedCall(length=length, prefix=prefix)auth.SentCodeTypeSetUpEmailRequired
Аргументы
apple_signin_allowed: Optional[bool], необязательный; значение None.google_signin_allowed: Optional[bool], необязательный; значение None.
Результат
Словарь параметров с _="auth.SentCodeTypeSetUpEmailRequired".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCodeTypeSetUpEmailRequired()auth.SentCodeTypeSms
Аргументы
length: int, обязательный.
Результат
Словарь параметров с _="auth.SentCodeTypeSms".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCodeTypeSms(length=length)auth.SentCodeTypeSmsPhrase
Аргументы
beginning: Optional[str], необязательный; значение None.
Результат
Словарь параметров с _="auth.SentCodeTypeSmsPhrase".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCodeTypeSmsPhrase()auth.SentCodeTypeSmsWord
Аргументы
beginning: Optional[str], необязательный; значение None.
Результат
Словарь параметров с _="auth.SentCodeTypeSmsWord".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.SentCodeTypeSmsWord()auth.TLObject
Аргументы
Нет.
Результат
Словарь параметров с _="auth.TLObject".
Права
Не требует прав; это локальная сборка параметров. При использовании результата проверяются права выполняемого метода.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
value = app.client.types.auth.TLObject()