Cluster · разработчикам
TL bots · методы
Каталог и общие правила · Справочник SDK
bots.AddPreviewMedia
Аргументы
bot: 'TypeInputUser', обязательный.lang_code: str, обязательный.media: 'TypeInputMedia', обязательный.
Результат
BotPreviewMedia, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.AddPreviewMedia(bot=bot, lang_code=lang_code, media=media)bots.AllowSendMessage
Аргументы
bot: 'TypeInputUser', обязательный.
Результат
Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.AllowSendMessage(bot=bot)bots.AnswerWebhookJSONQuery
Аргументы
data: 'TypeDataJSON', обязательный.query_id: int, обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод заблокирован для модулей.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.AnswerWebhookJSONQuery(data=data, query_id=query_id)bots.CanSendMessage
Аргументы
bot: 'TypeInputUser', обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.CanSendMessage(bot=bot)bots.CheckDownloadFileParams
Аргументы
bot: 'TypeInputUser', обязательный.file_name: str, обязательный.url: str, обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.CheckDownloadFileParams(bot=bot, file_name=file_name, url=url)bots.CheckUsername
Аргументы
username: str, обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.CheckUsername(username=username)bots.CreateBot
Аргументы
manager_id: 'TypeInputUser', обязательный.name: str, обязательный.username: str, обязательный.via_deeplink: Optional[bool], необязательный; значение None.
Результат
User, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.CreateBot(manager_id=manager_id, name=name, username=username)bots.DeletePreviewMedia
Аргументы
bot: 'TypeInputUser', обязательный.lang_code: str, обязательный.media: List[ForwardRef('TypeInputMedia')], обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.DeletePreviewMedia(bot=bot, lang_code=lang_code, media=media)bots.EditAccessSettings
Аргументы
add_users: Optional[List[ForwardRef('TypeInputUser')]], необязательный; значение None.bot: 'TypeInputUser', обязательный.restricted: Optional[bool], необязательный; значение None.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.EditAccessSettings(bot=bot)bots.EditPreviewMedia
Аргументы
bot: 'TypeInputUser', обязательный.lang_code: str, обязательный.media: 'TypeInputMedia', обязательный.new_media: 'TypeInputMedia', обязательный.
Результат
BotPreviewMedia, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.EditPreviewMedia(bot=bot, lang_code=lang_code, media=media, new_media=new_media)bots.ExportBotToken
Аргументы
bot: 'TypeInputUser', обязательный.revoke: bool, обязательный.
Результат
bots.ExportedBotToken, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод заблокирован для модулей.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.ExportBotToken(bot=bot, revoke=revoke)bots.GetAccessSettings
Аргументы
bot: 'TypeInputUser', обязательный.
Результат
bots.AccessSettings, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.GetAccessSettings(bot=bot)bots.GetAdminedBots
Аргументы
Нет.
Результат
Vector<User>, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.GetAdminedBots()bots.GetBotCommands
Аргументы
lang_code: str, обязательный.scope: 'TypeBotCommandScope', обязательный.
Результат
Vector<BotCommand>, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.GetBotCommands(lang_code=lang_code, scope=scope)bots.GetBotInfo
Аргументы
bot: Optional[ForwardRef('TypeInputUser')], необязательный; значение None.lang_code: str, обязательный.
Результат
bots.BotInfo, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.GetBotInfo(lang_code=lang_code)bots.GetBotMenuButton
Аргументы
user_id: 'TypeInputUser', обязательный.
Результат
BotMenuButton, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.GetBotMenuButton(user_id=user_id)bots.GetBotRecommendations
Аргументы
bot: 'TypeInputUser', обязательный.
Результат
users.Users, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.GetBotRecommendations(bot=bot)bots.GetPopularAppBots
Аргументы
limit: int, обязательный.offset: str, обязательный.
Результат
bots.PopularAppBots, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.GetPopularAppBots(limit=limit, offset=offset)bots.GetPreviewInfo
Аргументы
bot: 'TypeInputUser', обязательный.lang_code: str, обязательный.
Результат
bots.PreviewInfo, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.GetPreviewInfo(bot=bot, lang_code=lang_code)bots.GetPreviewMedias
Аргументы
bot: 'TypeInputUser', обязательный.
Результат
Vector<BotPreviewMedia>, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.GetPreviewMedias(bot=bot)bots.GetRequestedWebViewButton
Аргументы
bot: 'TypeInputUser', обязательный.webapp_req_id: str, обязательный.
Результат
KeyboardButton, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.GetRequestedWebViewButton(bot=bot, webapp_req_id=webapp_req_id)bots.InvokeWebViewCustomMethod
Аргументы
bot: 'TypeInputUser', обязательный.custom_method: str, обязательный.params: 'TypeDataJSON', обязательный.
Результат
DataJSON, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.InvokeWebViewCustomMethod(bot=bot, custom_method=custom_method, params=params)bots.ReorderPreviewMedias
Аргументы
bot: 'TypeInputUser', обязательный.lang_code: str, обязательный.order: List[ForwardRef('TypeInputMedia')], обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.ReorderPreviewMedias(bot=bot, lang_code=lang_code, order=order)bots.ReorderUsernames
Аргументы
bot: 'TypeInputUser', обязательный.order: List[str], обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.ReorderUsernames(bot=bot, order=order)bots.RequestWebViewButton
Аргументы
button: 'TypeKeyboardButton', обязательный.user_id: 'TypeInputUser', обязательный.
Результат
bots.RequestedButton, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.RequestWebViewButton(button=button, user_id=user_id)bots.ResetBotCommands
Аргументы
lang_code: str, обязательный.scope: 'TypeBotCommandScope', обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.ResetBotCommands(lang_code=lang_code, scope=scope)bots.SendCustomRequest
Аргументы
custom_method: str, обязательный.params: 'TypeDataJSON', обязательный.
Результат
DataJSON, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.SendCustomRequest(custom_method=custom_method, params=params)bots.SetBotBroadcastDefaultAdminRights
Аргументы
admin_rights: 'TypeChatAdminRights', обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.SetBotBroadcastDefaultAdminRights(admin_rights=admin_rights)bots.SetBotCommands
Аргументы
commands: List[ForwardRef('TypeBotCommand')], обязательный.lang_code: str, обязательный.scope: 'TypeBotCommandScope', обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.SetBotCommands(commands=commands, lang_code=lang_code, scope=scope)bots.SetBotGroupDefaultAdminRights
Аргументы
admin_rights: 'TypeChatAdminRights', обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.SetBotGroupDefaultAdminRights(admin_rights=admin_rights)bots.SetBotInfo
Аргументы
about: Optional[str], необязательный; значение None.bot: Optional[ForwardRef('TypeInputUser')], необязательный; значение None.description: Optional[str], необязательный; значение None.lang_code: str, обязательный.name: Optional[str], необязательный; значение None.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.SetBotInfo(lang_code=lang_code)bots.SetBotMenuButton
Аргументы
button: 'TypeBotMenuButton', обязательный.user_id: 'TypeInputUser', обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.SetBotMenuButton(button=button, user_id=user_id)bots.SetCustomVerification
Аргументы
bot: Optional[ForwardRef('TypeInputUser')], необязательный; значение None.custom_description: Optional[str], необязательный; значение None.enabled: Optional[bool], необязательный; значение None.peer: 'TypeInputPeer', обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.SetCustomVerification(peer=peer)bots.SetJoinChatResults
Аргументы
query_id: int, обязательный.result: 'TypeJoinChatBotResult', обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.SetJoinChatResults(query_id=query_id, result=result)bots.TL
Аргументы
Нет.
Результат
Недоступный служебный тип, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.TL()bots.ToggleUserEmojiStatusPermission
Аргументы
bot: 'TypeInputUser', обязательный.enabled: bool, обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.ToggleUserEmojiStatusPermission(bot=bot, enabled=enabled)bots.ToggleUsername
Аргументы
active: bool, обязательный.bot: 'TypeInputUser', обязательный.username: str, обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.ToggleUsername(active=active, bot=bot, username=username)bots.UpdateStarRefProgram
Аргументы
bot: 'TypeInputUser', обязательный.commission_permille: int, обязательный.duration_months: Optional[int], необязательный; значение None.
Результат
StarRefProgram, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.UpdateStarRefProgram(bot=bot, commission_permille=commission_permille)bots.UpdateUserEmojiStatus
Аргументы
emoji_status: 'TypeEmojiStatus', обязательный.user_id: 'TypeInputUser', обязательный.
Результат
Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.
Права
telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.
Ошибки
ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.
Пример
Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.
result = await app.client.api.bots.UpdateUserEmojiStatus(emoji_status=emoji_status, user_id=user_id)