Cluster · разработчикам
TL help · методы
Каталог и общие правила · Справочник SDK
help.AcceptTermsOfService
Аргументы
id: 'TypeDataJSON', обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.AcceptTermsOfService(id=id)help.DismissSuggestion
Аргументы
peer: 'TypeInputPeer', обязательный.suggestion: str, обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.DismissSuggestion(peer=peer, suggestion=suggestion)help.EditUserInfo
Аргументы
entities: List[ForwardRef('TypeMessageEntity')], обязательный.message: str, обязательный.user_id: 'TypeInputUser', обязательный.
Результат
help.UserInfo, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.EditUserInfo(entities=entities, message=message, user_id=user_id)help.GetAppConfig
Аргументы
hash: int, обязательный.
Результат
help.AppConfig, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetAppConfig(hash=hash)help.GetAppUpdate
Аргументы
source: str, обязательный.
Результат
help.AppUpdate, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetAppUpdate(source=source)help.GetCdnConfig
Аргументы
Нет.
Результат
CdnConfig, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetCdnConfig()help.GetConfig
Аргументы
Нет.
Результат
Config, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetConfig()help.GetCountriesList
Аргументы
hash: int, обязательный.lang_code: str, обязательный.
Результат
help.CountriesList, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetCountriesList(hash=hash, lang_code=lang_code)help.GetDeepLinkInfo
Аргументы
path: str, обязательный.
Результат
help.DeepLinkInfo, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetDeepLinkInfo(path=path)help.GetInviteText
Аргументы
Нет.
Результат
help.InviteText, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetInviteText()help.GetNearestDc
Аргументы
Нет.
Результат
NearestDc, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetNearestDc()help.GetPassportConfig
Аргументы
hash: int, обязательный.
Результат
help.PassportConfig, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetPassportConfig(hash=hash)help.GetPeerColors
Аргументы
hash: int, обязательный.
Результат
help.PeerColors, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetPeerColors(hash=hash)help.GetPeerProfileColors
Аргументы
hash: int, обязательный.
Результат
help.PeerColors, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetPeerProfileColors(hash=hash)help.GetPremiumPromo
Аргументы
Нет.
Результат
help.PremiumPromo, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetPremiumPromo()help.GetPromoData
Аргументы
Нет.
Результат
help.PromoData | help.PromoDataEmpty, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetPromoData()help.GetRecentMeUrls
Аргументы
referer: str, обязательный.
Результат
help.RecentMeUrls, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetRecentMeUrls(referer=referer)help.GetSupport
Аргументы
Нет.
Результат
help.Support, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetSupport()help.GetSupportName
Аргументы
Нет.
Результат
help.SupportName, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetSupportName()help.GetTermsOfServiceUpdate
Аргументы
Нет.
Результат
help.TermsOfServiceUpdate | help.TermsOfServiceUpdateEmpty, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetTermsOfServiceUpdate()help.GetTimezonesList
Аргументы
hash: int, обязательный.
Результат
help.TimezonesList, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetTimezonesList(hash=hash)help.GetUserInfo
Аргументы
user_id: 'TypeInputUser', обязательный.
Результат
help.UserInfo, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.GetUserInfo(user_id=user_id)help.HidePromoData
Аргументы
peer: 'TypeInputPeer', обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.HidePromoData(peer=peer)help.SaveAppLog
Аргументы
events: List[ForwardRef('TypeInputAppEvent')], обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.SaveAppLog(events=events)help.SetBotUpdatesStatus
Аргументы
message: str, обязательный.pending_updates_count: int, обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.SetBotUpdatesStatus(message=message, pending_updates_count=pending_updates_count)help.TL
Аргументы
Нет.
Результат
Недоступный служебный тип, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.help.TL()