AsyncTeleBot¶

Методы класса AsyncTeleBot¶

class telebot.async_telebot.AsyncTeleBot(token: str, parse_mode: str | None = None, offset: int | None = None, exception_handler: ExceptionHandler | None = None, state_storage: StateStorageBase | None = <telebot.asyncio_storage.memory_storage.StateMemoryStorage object>, disable_web_page_preview: bool | None = None, disable_notification: bool | None = None, protect_content: bool | None = None, allow_sending_without_reply: bool | None = None, colorful_logs: bool | None = False, validate_token: bool | None = True)¶

Базовые классы: object

Это основной класс для асинхронного бота.

Позволяет добавить хендлеры для различных апдейтов.

Использование:

Использование асинхронной реализации TeleBot-а.¶

from telebot.async_telebot import AsyncTeleBot
bot = AsyncTeleBot('token') # get token from @BotFather
# now you can register other handlers/update listeners,
# and use bot methods.
# Remember to use async/await keywords when necessary.

Больше примеров в папке examples/ : https://github.com/eternnoir/pyTelegramBotAPI/tree/master/examples

Примечание

Установите пакет coloredlogs для использования colorful_los=True

Параметры:

token (str) – Токен бота, нужно получить от @BotFather
parse_mode (str, optional) – Глобальный parse_mode, по умолчанию None
offset (int, optional) – Смещение, используемое в get_updates, по умолчанию None
exception_handler (Optional[ExceptionHandler], optional) – Класс для обработки исключений, по умолчанию None
state_storage (telebot.asyncio_storage.StateMemoryStorage, optional) – Хранилище состояний (стейтов), по умолчанию StateMemoryStorage()
disable_web_page_preview (bool, optional) – Глобальное значение disable_web_page_preview, по умолчанию None
disable_notification (bool, optional) – Глобальное значение disable_notification, по умолчанию None
protect_content (bool, optional) – Глобальное значение protect_content, по умолчанию None
allow_sending_without_reply (bool, optional) – Deprecated - Use reply_parameters instead. Default value for allow_sending_without_reply, defaults to None
colorful_logs (bool, optional) – Использовать разноцветные логи
validate_token (bool, optional) – Validate token, defaults to True;

Исключение:

ImportError – If coloredlogs module is not installed and colorful_logs is True
ValueError – If token is invalid

add_custom_filter(custom_filter: SimpleCustomFilter | AdvancedCustomFilter)¶

Создать кастомный фильтр.

Пример проверки текста сообщения¶

class TextMatchFilter(AdvancedCustomFilter):
    key = 'text'

    async def check(self, message, text):
        return text == message.text

Параметры:: custom_filter (telebot.asyncio_filters.SimpleCustomFilter or telebot.asyncio_filters.AdvancedCustomFilter) – Класс с методом check(message)
Результат:: None

async add_data(user_id: int, chat_id: int | None = None, business_connection_id: str | None = None, message_thread_id: int | None = None, bot_id: int | None = None, **kwargs) → None¶

Добавить данные в состояние (стейт).

Параметры:

user_id (int) – id пользователя
chat_id (int) – id чата
bot_id (int) – Bot’s identifier, defaults to current bot id
business_connection_id (str) – Business identifier
message_thread_id (int) – Identifier of the message thread
kwargs – Данные для добавления

Результат:

None

Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.

Примечание

**_sticker, mask_position, emojis parameters are deprecated, use stickers instead

Документация Telegram: https://core.telegram.org/bots/api#addstickertoset

Параметры:

user_id (int) – id пользователя, создавшего стикерпак
name (str) – Имя стикерпака
emojis (str) – Один или несколько эмодзи, относящихся к стикеру
png_sticker (str or filelike object) – Изображение стикера в формате PNG, весом не более 512 килобайт, размеры не должны превышать 512px, либо ширина, либо высота должны быть ровно 512px. Передайте file_id в формате str, чтобы отправить уже загруженный на сервера Telegram файл, передайте HTTP URL в формате str, чтобы Telegram скачал файл из интернета, или загрузите новый файл с помощью multipart/form-data.
tgs_sticker (str or filelike object) – Анимированный стикер в формате TGS, загруженный с помощью multipart/form-data.
webm_sticker (str or filelike object) – Анимированный стикер в формате WebM, загруженный с помощью multipart/form-data.
mask_position (telebot.types.MaskPosition) – Позиция для размещения маски на лицах в формате JSON
sticker (telebot.types.InputSticker) – A JSON-serialized object for sticker to be added to the sticker set

Результат:

В случае успеха возвращается True.

Тип результата:

bool

async answer_callback_query(callback_query_id: int, text: str | None = None, show_alert: bool | None = None, url: str | None = None, cache_time: int | None = None) → bool¶

Используйте этот метод для отправки ответов на callback запросы, отправленные с помощью inline кнопок. Ответ будет показан пользователю как уведомление поверх чата или pop-up предупреждение.

Документация Telegram: https://core.telegram.org/bots/api#answercallbackquery

Параметры:

callback_query_id (int) – Уникальный id запроса для ответа
text (str) – Текст уведомления. если не задан, то уведомление не будет показано, 0-200 символов
show_alert (bool) – Если True, вместо уведомления поверх чата будет показано pop-up предупреждение, по умолчанию False.
url (str) – URL, который будет открыт пользовательским клиентом. Если вы создали игру и приняли условия через @BotFather, задайте URL, открывающий вашу игру - учитывайте, что это сработает только если запрос был отправлен с помощью callback_game кнопки.
cache_time – Максимальная длительность хранения ответа на callback запрос пользовательским клиентом в секундах. Приложения Telegram поддерживают хранение ответов начиная с версии 3.14, по умолчанию 0.

Результат:

В случае успеха возвращается True.

Тип результата:

bool

async answer_guest_query(guest_query_id: str, result: InlineQueryResultBase) → SentGuestMessage¶

Use this method to reply to a received guest message. On success, a SentGuestMessage object is returned.

Telegram documentation: https://core.telegram.org/bots/api#answerguestquery

Параметры:

guest_query_id (str) – Уникальный id запроса для ответа
result (types.InlineQueryResult) – Объект в формате JSON, описывающий сообщение, которое нужно отправить

Результат:

On success, a SentGuestMessage object is returned.

Тип результата:

types.SentGuestMessage

async answer_inline_query(inline_query_id: str, results: List[Any], cache_time: int | None = None, is_personal: bool | None = None, next_offset: str | None = None, switch_pm_text: str | None = None, switch_pm_parameter: str | None = None, button: InlineQueryResultsButton | None = None) → bool¶

Используйте этот метод для отправки ответов на inline запрос. В случае успеха возвращается True. Разрешено отправить не более 50 результатов на один запрос.

Документация Telegram: https://core.telegram.org/bots/api#answerinlinequery

Параметры:

inline_query_id (str) – Уникальный id запроса для ответа
results (list of types.InlineQueryResult) – Массив результатов для ответа на inline запрос
cache_time (int) – Максимальная длительность хранения результатов inline запроса на сервере в секундах.
is_personal (bool) – Передайте True, если результаты должны быть сохранены на сервере только для пользователя, отправившего запрос.
next_offset (str) – Передайте смещение, которое клиент должен отправить в следующем запросе с таким же текстом, чтобы получить новые результаты.
switch_pm_parameter (str) – Параметр для команды /start, отправляемой боту, когда пользователь нажимает кнопку переключения. 1-64 символа, разрешены только A-Z, a-z, 0-9, _ и -. Пример: Inline бот, который отправляет видео с YouTube может попросить пользователя подключить бота к его YouTube аккаунту, чтобы поиск соответствовал предпочтениям пользователя. Чтобы это сделать, бот отправляет пользователю кнопку „Подключить YouTube аккаунт“ над результатами, или даже до их показа. Пользователь нажимает на кнопку, автоматически переходит в приватный чат с ботом и в это время передаёт стартовый параметр, по которому бот возвращает ссылку для авторизации (OAuth). Как только авторизация пройдена, бот может предложить switch_inline кнопку, чтобы пользователь мог легко вернуться в чат, где он хотел использовать возможности inline бота.
switch_pm_text (str) – Параметр для передачи боту вместе с сообщением /start, отправленному при нажатии кнопки переключения
button (types.InlineQueryResultsButton) – A JSON-serialized object describing a button to be shown above inline query results

Результат:

В случае успеха возвращается True.

Тип результата:

bool

async answer_pre_checkout_query(pre_checkout_query_id: str, ok: bool, error_message: str | None = None) → bool¶

Как только пользователь подтвердил детали оплаты и доставки, Bot API отправляет финальное подтверждение в виде апдейта с полем pre_checkout_query. Используйте этот метод для ответа на такие pre-checkout запросы. В случае успеха возвращается True.

Примечание

Bot API должно получить ответ в течение 10 секунд после отправки pre-checkout запроса.

Документация Telegram: https://core.telegram.org/bots/api#answerprecheckoutquery

Параметры:

pre_checkout_query_id (int) – Уникальный id запроса для ответа
ok (bool) – Задайте True если всё правильно (выбранные товары доступны и т.д.) и бот готов обработать заказ. Задайте False если есть какие-то проблемы.
error_message (str) – Обязательный в случае, когда ok - False. Сообщение об ошибке, которое может прочитать человек, объясняющее причину, по которой бот не может обработать заказ (например «Извините, кто-то только что купил последнюю из наших прекрасных черных футболок с коротким рукавом пока вы заполняли детали оплаты. Пожалуйста выберите другой цвет или фасон!»). Telegram покажет это сообщение пользователю.

Результат:

В случае успеха возвращается True.

Тип результата:

bool

async answer_shipping_query(shipping_query_id: str, ok: bool, shipping_options: List[ShippingOption] | None = None, error_message: str | None = None) → bool¶

Запрашивает ответ на вопрос о доставке.

Документация Telegram: https://core.telegram.org/bots/api#answershippingquery

Параметры:

shipping_query_id (str) – Уникальный id запроса для ответа
ok (bool) – Задайте True если доставка по выбранному адресу возможна и False, если есть какие-то проблемы (например, доставка по выбранному адресу не осуществляется)
shipping_options (list of ShippingOption) – Обязательный в случае, когда ok - True. Массив вариантов доставки в формате JSON.
error_message (str) – Обязательный в случае, когда ok - False. Сообщение об ошибке, которое может прочитать человек, объясняющее причину, по которой невозможно завершить заказ (например «Извините, доставка по запрошенному адресу недоступна»). Telegram покажет это сообщение пользователю.

Результат:

В случае успеха возвращается True.

Тип результата:

bool

async answer_web_app_query(web_app_query_id: str, result: InlineQueryResultBase) → SentWebAppMessage¶

Используйте этот метод, чтобы задать результат взаимодействия с Web App и отправить соответствующее сообщение от лица пользователя в чат, из которого пришел запрос. В случае успеха возвращается объект SentWebAppMessage.

Документация Telegram: https://core.telegram.org/bots/api#answerwebappquery

Параметры:

web_app_query_id (str) – Уникальный id запроса для ответа
result (telebot.types.InlineQueryResultBase) – Объект в формате JSON, описывающий сообщение, которое нужно отправить

Результат:

В случае успеха возвращается объект SentWebAppMessage.

Тип результата:

telebot.types.SentWebAppMessage

async approve_chat_join_request(chat_id: str | int, user_id: int | str) → bool¶

Используйте этот метод, чтобы одобрить запрос на вступление в чат. Бот должен быть администратором чата и иметь права администратора can_invite_users. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#approvechatjoinrequest

Параметры:

chat_id (int or str) – Уникальный id чата или username супергруппы (в формате @supergroupusername)
user_id (int or str) – Уникальный id сделавшего запрос пользователя

Результат:

True в случае успеха.

Тип результата:

bool

async approve_suggested_post(chat_id: int, message_id: int, send_date: int | None = None) → bool¶

Use this method to approve a suggested post in a direct messages chat. The bot must have the „can_post_messages“ administrator right in the corresponding channel chat. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#approvesuggestedpost

Параметры:

chat_id (int) – Unique identifier for the target direct messages chat
message_id (int) – Identifier of a suggested post message to approve
send_date (int) – Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async ban_chat_member(chat_id: int | str, user_id: int, until_date: int | datetime | None = None, revoke_messages: bool | None = None) → bool¶

Используйте этот метод, чтобы заблокировать пользователя в группе, супергруппе или канале. В случае супергрупп и каналов, пользователь не сможет вернуться в чат самостоятельно, используя ссылки с приглашением и т.д., пока не будет разблокирован. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#banchatmember

Параметры:

chat_id (int or str) – Уникальный id группы или username супергруппы или канала (в формате @channelusername)
user_id (int) – Уникальный id сделавшего запрос пользователя
until_date (int or datetime) – Дата, когда пользователь будет разблокирован, в формате UNIX time. Если пользователь заблокирован больше чем на 366 дней или меньше чем на 30 секунд, то он будет заблокирован до ручной разблокировки
revoke_messages (bool) – Bool: Передайте True, чтобы удалить все сообщения пользователя из чата. Если False, пользователю будут доступны все сообщения в группе, отправленные до его блокировки. Всегда True для супергрупп и каналов.

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async ban_chat_sender_chat(chat_id: int | str, sender_chat_id: int | str) → bool¶

Используйте этот метод, чтобы заблокировать канал в супергруппе или канале. Владелец канала не сможет отправлять сообщения и участвовать в прямых эфирах от лица канала, пока канал не будет разблокирован. Бот должен быть администратором супергруппы или канала и иметь соответствующие права администратора.Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#banchatsenderchat

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
sender_chat_id (int or str) – Уникальный id канала для блокировки

Результат:

True в случае успеха.

Тип результата:

bool

business_connection_handler(func=None, **kwargs)¶

Handles new incoming business connection state.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

business_message_handler(commands: List[str] | None = None, regexp: str | None = None, func: Callable | None = None, content_types: List[str] | None = None, **kwargs)¶

Handles New incoming message of any kind(for business accounts, see bot api 7.2 for more) - text, photo, sticker, etc. As a parameter to the decorator function, it passes telebot.types.Message object. All message handlers are tested in the order they were added.

Пример:

Usage of business_message_handler¶

bot = TeleBot('TOKEN')

# Handles all messages which text matches regexp.
@bot.business_message_handler(regexp='someregexp')
def command_help(message):
    bot.send_message(message.chat.id, 'Did someone call for help?')

# Handle all sent documents of type 'text/plain'.
@bot.business_message_handler(func=lambda message: message.document.mime_type == 'text/plain',
    content_types=['document'])
def command_handle_document(message):
    bot.send_message(message.chat.id, 'Document received, sir!')

# Handle all other messages.
@bot.business_message_handler(func=lambda message: True, content_types=['audio', 'photo', 'voice', 'video', 'document',
    'text', 'location', 'contact', 'sticker'])
def default_command(message):
    bot.send_message(message.chat.id, "This is the default command handler.")

Параметры:

commands (list of str) – Необязательный список строк - команд для обработки.
regexp (str) – Необязательное регулярное выражение.
func (lambda) – Необязательная lambda функция. Получает сообщение (объект Message) в качестве первого параметра. Функция должна вернуть True если хендлер должен обработать сообщение.
content_types (list of str) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

декорируемая функция

callback_query_handler(func=None, **kwargs)¶

Обрабатывает новый callback запрос. В качестве параметра передаёт в декорируемую функцию объект telebot.types.CallbackQuery.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

channel_post_handler(commands=None, regexp=None, func=None, content_types=None, **kwargs)¶

Обрабатывает новый пост любого типа в канале - текст, фото, стикер и т.д. В качестве параметра передаёт в декорируемую функцию объект telebot.types.Message.

Параметры:

commands (list of str) – Необязательный список строк - команд для обработки.
regexp (str) – Необязательное регулярное выражение.
func (function) – Функция, используемая в качестве фильтра
content_types (list of str) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

chat_boost_handler(func=None, **kwargs)¶

Handles new incoming chat boost state. it passes telebot.types.ChatBoostUpdated object.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

chat_join_request_handler(func=None, **kwargs)¶

Обрабатывает запрос на вступление в чат. Бот должен иметь права администратора can_invite_users в чате, чтобы получать такие апдейты. В качестве параметра передаёт в декорируемую функцию объект telebot.types.ChatJoinRequest.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

chat_member_handler(func=None, **kwargs)¶

Обрабатывает изменение статуса пользователя в чате. Бот должен быть администратором чата и явно указать “chat_member“ в allowed_updates, чтобы получать такие апдейты. В качестве параметра передаёт в декорируемую функцию объект telebot.types.ChatMemberUpdated.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

chosen_inline_handler(func, **kwargs)¶

Обрабатывает результат inline запроса, который был выбран пользователем и отправлен собеседнику в чате. Пожалуйста ознакомьтесь с документацией по сбору фидбека для получения таких апдейтов вашим ботом. В качестве параметра передаёт в декорируемую функцию объект telebot.types.ChosenInlineResult.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

async close() → bool¶

Используйте этот метод чтобы закрыть инстанс бота прежде чем перемещать его с одного локального сервера на другой. Вы должны удалить вебхук перед вызовом этого метода, чтобы убедиться. что бот не будет запущен повторно после перезапуска сервера. Метод будет возвращать ошибку 429 в течение 10 минут после запуска бота. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#close

Результат:: bool

async close_forum_topic(chat_id: str | int, message_thread_id: int) → bool¶

Используйте этот метод, чтобы закрыть открытый топик в чате супергруппы. Бот должен быть администратором чата и иметь права администратора can_manage_topics, за исключением случаев, когда бот является создателем топика. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#closeforumtopic

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
message_thread_id (int) – id топика для закрытия

Результат:

В случае успеха возвращается True.

Тип результата:

bool

async close_general_forum_topic(chat_id: int | str) → bool¶

Документация Telegram: https://core.telegram.org/bots/api#closeforumtopic

Параметры:: chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)

async static close_session()¶: Закрывает текущую aiohttp сессию. Используйте эту функцию для завершения работы поллинга или вебхука.

async convert_gift_to_stars(business_connection_id: str, owned_gift_id: str) → bool¶

Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#convertgifttostars

Параметры:

business_connection_id (str) – Unique identifier of the business connection
owned_gift_id (str) – Unique identifier of the regular gift that should be converted to Telegram Stars

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

Use this method to copy messages of any kind. If some of the specified messages can’t be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can’t be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don’t have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.

Документация Telegram: https://core.telegram.org/bots/api#copymessage

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
from_chat_id (int or str) – Уникальный id чата, в который было отправлено исходное сообщение (или username канала в формате @channelusername)
message_id (int) – id сообщения в чате, заданном в from_chat_id
video_start_timestamp (int) – New start timestamp for the forwarded video in the message
caption (str) – Новая подпись для медиа, 0-1024 символа после форматирования. Если не задано, используется исходная подпись
parse_mode (str) – Режим форматирования новой подписи.
caption_entities (Array of telebot.types.MessageEntity) – Список отформатированных частей новой подписи в формате JSON, можно использовать вместо parse_mode
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
timeout (int) – Таймаут запроса в секундах.
message_thread_id (int) – id топика, в который нужно отправить сообщение
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
show_caption_above_media (bool) – Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
message_effect_id (str) – Unique identifier of the message effect to be added to the message; only available when forwarding to private chats

Результат:

On success, the MessageId of the sent message is returned.

Тип результата:

telebot.types.MessageID

Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can’t be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn’t have a link to the original message. Returns the MessageId of the sent message on success.

Telegram documentation: https://core.telegram.org/bots/api#copymessages

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
from_chat_id (int or str) – Уникальный id чата, в который было отправлено исходное сообщение (или username канала в формате @channelusername)
message_ids (list of int) – Message identifiers in the chat specified in from_chat_id
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука
message_thread_id (int) – id топика, в который будет отправлена группа медиа
protect_content (bool) – Запретить пересылку и сохранение содержимого пересланного сообщения
remove_caption (bool) – Pass True to copy the messages without their captions
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

Результат:

On success, an array of MessageId of the sent messages is returned.

Тип результата:

list of telebot.types.MessageID

Используйте этот метод, чтобы создать дополнительную ссылку-приглашение в чат. Бот должен быть администратором чата и иметь соответствующие права администратора. Ссылка может быть аннулирована методом revokeChatInviteLink. Возвращает новую ссылку-приглашение (ChatInviteLink).

Документация Telegram: https://core.telegram.org/bots/api#createchatinvitelink

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
name (str) – Название ссылки-приглашения; 0-32 символа
expire_date (int or datetime) – Время, когда ссылка будет аннулирована в формате Unix timestamp
member_limit (int) – Максимальное количество пользователей в чате
creates_join_request (bool) – True, если пользователи, использующие эту ссылку должны быть одобрены администраторами чата. Нельзя использовать True вместе с member_limit

Результат:

Возвращает новую ссылку-приглашение (ChatInviteLink).

Тип результата:

telebot.types.ChatInviteLink

async create_chat_subscription_invite_link(chat_id: int | str, subscription_period: int, subscription_price: int, name: str | None = None) → ChatInviteLink¶

Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.

Telegram documentation: https://core.telegram.org/bots/api#createchatsubscriptioninvitelink

Параметры:

chat_id (int or str) – Unique identifier for the target channel chat or username of the target channel (in the format @channelusername)
name (str) – Название ссылки-приглашения; 0-32 символа
subscription_period (int) – The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).
subscription_price (int) – The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-2500

Результат:

Returns the new invite link as a ChatInviteLink object.

Тип результата:

telebot.types.ChatInviteLink

async create_forum_topic(chat_id: int, name: str, icon_color: int | None = None, icon_custom_emoji_id: str | None = None) → ForumTopic¶

Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.

Документация Telegram: https://core.telegram.org/bots/api#createforumtopic

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
name (str) – Имя топика, 1-128 символов
icon_color (int) – Цвет иконки топика в формате RGB. В текущий момент, доступны цвета 0x6FB9F0, 0xFFD67E, 0xCB86DB, 0x8EEE98, 0xFF93B2, or 0xFB6F5F
icon_custom_emoji_id (str) – Кастомный эмодзи для использования в качестве иконки топика. Должно быть “tgs” эмодзи и быть ровно 1 символом

Результат:

В случае успеха возвращается информация о созданном топике (ForumTopic).

Тип результата:

telebot.types.ForumTopic

async create_invoice_link(title: str, description: str, payload: str, provider_token: str | None, currency: str, prices: List[LabeledPrice], max_tip_amount: int | None = None, suggested_tip_amounts: List[int] | None = None, provider_data: str | None = None, photo_url: str | None = None, photo_size: int | None = None, photo_width: int | None = None, photo_height: int | None = None, need_name: bool | None = None, need_phone_number: bool | None = None, need_email: bool | None = None, need_shipping_address: bool | None = None, send_phone_number_to_provider: bool | None = None, send_email_to_provider: bool | None = None, is_flexible: bool | None = None, subscription_period: int | None = None, business_connection_id: str | None = None) → str¶

используйте этот метод, чтобы создать ссылку-инвойс. Возвращает созданную ссылку в случае успеха (String).

Документация Telegram: https://core.telegram.org/bots/api#createinvoicelink

Параметры:

business_connection_id (str) – Unique identifier of the business connection on behalf of which the link will be created
title (str) – Название товара, 1-32 символа
description (str) – Описание товара, 1-255 символов
payload (str) – Дополнительные данные, 1-128 байт. Не будет показано пользователю, используйте во внутренних процессах.
provider_token (str) – Payments provider token, obtained via @Botfather; Pass None to omit the parameter to use «XTR» currency
currency (str) – Трехбуквенный код валюты в формате ISO 4217, см. https://core.telegram.org/bots/payments#supported-currencies
prices (list of types.LabeledPrice) – Детали цены, список компонент (например цена продукта, налог, скидка, стоимость доставки, налог на доставку, бонус и т.д.)
subscription_period (int) – The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified.
max_tip_amount (int) – Максимальный размер чаевых в наименьших единицах выбранной валюты
suggested_tip_amounts (list of int) – Массив предлагаемых вариантов чаевых в наименьших единицах выбранной валюты в формате JSON. Можно задать не более 4 вариантов. Варианты чаевых должны быть больше нуля, перечисленные в порядке строгого возрастания и не превышать max_tip_amount.
provider_data (str) – Данные о инвойсе в формате JSON, которые будут переданы платежной системе. Подробное описание обязательных полей должно быть предоставлено провайдером платежной системы.
photo_url (str) – URL изображения товара для инвойса. Может быть изображением товаров или изображением инвойса. Людям больше нравится видеть фото товара, за который они платят.
photo_size (int) – Вес изображения в байтах
photo_width (int) – Ширина изображения
photo_height (int) – Высота изображения
need_name (bool) – Передайте True, если для совершения заказа требуется полное имя пользователя
need_phone_number (bool) – Передайте True, если для совершения заказа требуется номер телефона пользователя
need_email (bool) – Передайте True, если для совершения заказа требуется email пользователя
need_shipping_address (bool) – Передайте True, если для совершения заказа требуется адрес доставки
send_phone_number_to_provider (bool) – Передайте True, если номер телефона пользователя нужно отправить платежной системе
send_email_to_provider (bool) – Передайте True, если email пользователя нужно отправить платежной системе
is_flexible (bool) – Передайте True, если окончательная цена зависит от способа доставки

Результат:

Созданная ссылка-инвойс (String) в случае успеха.

Тип результата:

str

async create_new_sticker_set(user_id: int, name: str, title: str, emojis: List[str] | None = None, png_sticker: Any | str = None, tgs_sticker: Any | str = None, webm_sticker: Any | str = None, contains_masks: bool | None = None, sticker_type: str | None = None, mask_position: MaskPosition | None = None, needs_repainting: bool | None = None, stickers: List[InputSticker] = None, sticker_format: str | None = None) → bool¶

Используйте этот метод, чтобы создать новый стикерпак, владельцем которого станет пользователь. Бот будет иметь возможность редактировать созданный стикерпак. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#createnewstickerset

Примечание

Fields *_sticker are deprecated, pass a list of stickers to stickers parameter instead.

Параметры:

user_id (int) – id пользователя, создавшего стикерпак
name (str) – Короткое имя стикерпака для использования в ссылках вида t.me/addstickers/ (например animals). Может содержать только латинские буквы, цифры и нижние подчеркивания. Должно начинаться с буквы, не может содержать подряд идущие нижние подчеркивания и должно заканчиваться на «_by_<bot_username>». <bot_username> учитывает регистр. 1-64 символа.
title (str) – Название стикерпака, 1-64 символа
emojis (str) – Один или несколько эмодзи, относящихся к стикеру
png_sticker (str) – Изображение стикера в формате PNG, весом не более 512 килобайт, размеры не должны превышать 512px, либо ширина, либо высота должны быть ровно 512px. Передайте file_id в формате str, чтобы отправить уже загруженный на сервера Telegram файл, передайте HTTP URL в формате str, чтобы Telegram скачал файл из интернета, или загрузите новый файл с помощью multipart/form-data.
tgs_sticker (str) – Анимированный стикер в формате TGS, загруженный с помощью multipart/form-data.
webm_sticker (str) – Анимированный стикер в формате WebM, загруженный с помощью multipart/form-data.
contains_masks (bool) – Передайте True, если создаётся стикерпак масок. Устарело, начиная с Bot API 6.2, используйте sticker_type.
sticker_type (str) – Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created.
mask_position (telebot.types.MaskPosition) – Позиция для размещения маски на лицах в формате JSON
needs_repainting (bool) – Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only
stickers (list of telebot.types.InputSticker) – List of stickers to be added to the set
sticker_format (str) – deprecated

Результат:

В случае успеха возвращается True.

Тип результата:

bool

async decline_chat_join_request(chat_id: str | int, user_id: int | str) → bool¶

Используйте этот метод, чтобы отклонить запрос на вступление в чат. Бот должен быть администратором чата и иметь права администратора can_invite_users. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#declinechatjoinrequest

Параметры:

chat_id (int or str) – Уникальный id чата или username супергруппы (в формате @supergroupusername)
user_id (int or str) – Уникальный id сделавшего запрос пользователя

Результат:

True в случае успеха.

Тип результата:

bool

async decline_suggested_post(chat_id: int, message_id: int, comment: str | None = None) → bool¶

Use this method to decline a suggested post in a direct messages chat. The bot must have the „can_manage_direct_messages“ administrator right in the corresponding channel chat. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#declinesuggestedpost

Параметры:

chat_id (int) – Unique identifier for the target direct messages chat
message_id (int) – Identifier of a suggested post message to decline
comment (str) – Comment for the creator of the suggested post; 0-128 characters

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async delete_all_message_reactions(chat_id: int | str, user_id: int | None = None, actor_chat_id: int | None = None) → bool¶

Use this method to remove up to 10000 recent reactions in a group or a supergroup chat added by a given user or chat. The bot must have the „can_delete_messages“ administrator right in the chat. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#deleteallmessagereactions

Параметры:

chat_id (int or str) – Unique identifier for the target chat or username of the target supergroup (in the format @username)
user_id (int, optional) – Identifier of the user whose reactions will be removed, if the reactions were added by a user
actor_chat_id (int, optional) – Identifier of the chat whose reactions will be removed, if the reactions were added by a chat

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async delete_business_messages(business_connection_id: str, message_ids: List[int]) → bool¶

Delete messages on behalf of a business account. Requires the can_delete_outgoing_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#deletebusinessmessages

Параметры:

business_connection_id (str) – Unique identifier of the business connection on behalf of which to delete the messages
message_ids (list of int) – A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See deleteMessage for limitations on which messages can be deleted

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async delete_chat_photo(chat_id: int | str) → bool¶

Используйте этот метод, чтобы удалить фото чата. Нельзя изменить фото в приватных чатах. Бот должен быть администратором чата и иметь соответствующие права администратора. Возвращает True в случае успеха. Примечание: В обычных группах (не супергруппах), метод будет работать только в случаях, когда настройка ‘All Members Are Admins’ выключена.

Документация Telegram: https://core.telegram.org/bots/api#deletechatphoto

Параметры:: chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
Результат:: True в случае успеха.
Тип результата:: bool

async delete_chat_sticker_set(chat_id: int | str) → bool¶

Используйте этот метод, чтобы удалить стикерпак группы из супергруппы. Бот должен быть администратором чата и иметь соответствующие права администратора. Используйте поле can_set_sticker_set, возвращаемое методом getChat, чтобы проверить, что бот может использовать этот метод. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#deletechatstickerset

Параметры:: chat_id (int or str) – Уникальный id чата или username супергруппы (в формате @supergroupusername)
Результат:: Возвращает True в случае успеха.
Тип результата:: bool

async delete_forum_topic(chat_id: str | int, message_thread_id: int) → bool¶

Используйте этот метод, чтобы удалить топик в супергруппе. Бот должен быть администратором чата и иметь права администратора can_manage_topics, за исключением случае, когда бот является создателем топика. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#deleteforumtopic

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
message_thread_id (int) – id топика, который нужно удалить

Результат:

В случае успеха возвращается True.

Тип результата:

bool

async delete_message(chat_id: int | str, message_id: int, timeout: int | None = None) → bool¶

Используйте этот метод, чтобы удалить сообщение, в том числе сервисное, ограничения: - Сообщение может быть удалено только если оно было отправлено менее 48 часов назад. - Dice-сообщение в приватном чате может быть удалено только если оно было отправлено более 24 часов назад. - Боты могут удалять свои сообщения в приватных чатах, группах и супергруппах. - Боты могут удалять чужие сообщение в приватных чатах. - Боты с правами администратора can_post_messages могут удалять сообщения в каналах. - Если бот является администратором группы, он может удалить любое сообщение в ней. - Если бот имеет права администратора can_delete_messages в супергруппе или канале, он может удалить любое сообщение в них. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#deletemessage

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
message_id (int) – id сообщения, которое нужно удалить
timeout (int) – Таймаут запроса в секундах.

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async delete_message_reaction(chat_id: int | str, message_id: int, user_id: int | None = None, actor_chat_id: int | None = None) → bool¶

Use this method to remove a reaction from a message in a group or a supergroup chat. The bot must have the „can_delete_messages“ administrator right in the chat. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#deletemessagereaction

Параметры:

chat_id (int or str) – Unique identifier for the target chat or username of the target supergroup (in the format @username)
message_id (int) – Identifier of the target message
user_id (int, optional) – Identifier of the user whose reaction will be removed, if the reaction was added by a user
actor_chat_id (int, optional) – Identifier of the chat whose reaction will be removed, if the reaction was added by a chat

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async delete_messages(chat_id: int | str, message_ids: List[int])¶

Use this method to delete multiple messages simultaneously. If some of the specified messages can’t be found, they are skipped. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#deletemessages

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
message_ids (list of int) – Identifiers of the messages to be deleted

Результат:

Возвращает True в случае успеха.

async delete_my_commands(scope: BotCommandScope | None = None, language_code: int | None = None) → bool¶

Используйте этот метод, чтобы удалить список команд бота для заданных поля видимости и языка. После удаления, команды более широкого поля видимости будут доступны пользователям, которых коснулись изменения. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#deletemycommands

Параметры:

scope (telebot.types.BotCommandScope) – Область видимости команд. По умолчанию BotCommandScopeDefault.
language_code (str) – Двухбуквенный языковой код в формате ISO 639-1. Если не задан, изменения коснутся команд для всех пользователей в заданном поле видимости, не имеющих команд на их языке

Результат:

True в случае успеха.

Тип результата:

bool

async delete_state(user_id: int, chat_id: int | None = None, business_connection_id: str | None = None, message_thread_id: int | None = None, bot_id: int | None = None) → bool¶

Удалить текущее состояние (стейт) пользователя.

Параметры:

user_id (int) – id пользователя
chat_id (int) – id чата
bot_id (int) – Bot’s identifier, defaults to current bot id
business_connection_id (str) – Business identifier
message_thread_id (int) – Identifier of the message thread

Результат:

None

async delete_sticker_from_set(sticker: str) → bool¶

Используйте этот метод, чтобы удалить стикер из стикерпака, созданного ботом. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#deletestickerfromset

Параметры:: sticker – id файла стикера
Результат:: В случае успеха возвращается True.
Тип результата:: bool

async delete_sticker_set(name: str) → bool¶

Use this method to delete a sticker set. Returns True on success.

Параметры:: name (str) – Имя стикерпака
Результат:: Возвращает True в случае успеха.
Тип результата:: bool

async delete_story(business_connection_id: str, story_id: int) → bool¶

Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#deletestory

Параметры:

business_connection_id (str) – Unique identifier of the business connection
story_id (int) – Unique identifier of the story to delete

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async delete_webhook(drop_pending_updates: bool | None = None, timeout: int | None = None) → bool¶

Используйте этот метод, чтобы удалить вебхук, если вы решите перейти обратно на getUpdates. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#deletewebhook

Параметры:

drop_pending_updates – Передайте True, чтобы удалить все предшествующие запуску бота апдейты, по умолчанию None
timeout (int, optional) – Тайм-аут запроса, по умолчанию None

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

deleted_business_messages_handler(func=None, **kwargs)¶

Handles new incoming deleted messages state.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

async download_file(file_path: str | None) → bytes¶

Скачивает файл.

Параметры:: file_path (str) – Путь, куда файл нужно сохранить.
Результат:: bytes
Тип результата:: bytes

Используйте этот метод, чтобы изменить неосновную ссылку-приглашение, созданную ботом. Бот должен быть администратором чата и иметь соответствующие права администратора.

Документация Telegram: https://core.telegram.org/bots/api#editchatinvitelink

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
name (str) – Название ссылки-приглашения; 0-32 символа
invite_link (str) – Ссылка-приглашение для изменения
expire_date (int or datetime) – Время, когда ссылка будет аннулирована в формате Unix timestamp
member_limit (int) – Максимальное количество пользователей в чате
creates_join_request (bool) – True, если пользователи, использующие эту ссылку должны быть одобрены администраторами чата. Нельзя использовать True вместе с member_limit

Результат:

Возвращает новую ссылку-приглашение (ChatInviteLink).

Тип результата:

telebot.types.ChatInviteLink

async edit_chat_subscription_invite_link(chat_id: int | str, invite_link: str, name: str | None = None) → ChatInviteLink¶

Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.

Telegram documentation: https://core.telegram.org/bots/api#editchatsubscriptioninvitelink

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
invite_link (str) – Ссылка-приглашение для изменения
name (str) – Название ссылки-приглашения; 0-32 символа

Результат:

Returns the edited invite link as a ChatInviteLink object.

Тип результата:

telebot.types.ChatInviteLink

async edit_forum_topic(chat_id: int | str, message_thread_id: int, name: str | None = None, icon_custom_emoji_id: str | None = None) → bool¶

Используйте этот метод, чтобы изменить название и иконку топика в супергруппе. Бот должен быть администратором чата и иметь права администратора can_manage_topics, кроме случаев, когда бот является создателем топика. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#editforumtopic

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
message_thread_id (int) – id топика для изменения
name (str) – Необязательный, новое имя топика, 1-128 символов. Если не задано или пустое, сохранится текущее имя топика
icon_custom_emoji_id (str) – Необязательный, новый уникальный id кастомного эмодзи, используемого в качестве иконки топика. Используйте getForumTopicIconStickers, чтобы получить все доступные id кастомных эмодзи. Передайте пустую строку, чтобы убрать иконку. Если не задан, сохранится текущая иконка топика

Результат:

В случае успеха возвращается True.

Тип результата:

bool

async edit_general_forum_topic(chat_id: int | str, name: str) → bool¶

Документация Telegram: https://core.telegram.org/bots/api#editforumtopic

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
name (str) – Название товара, 1-32 символа

Используйте этот метод, чтобы изменить подписи к медиа в сообщениях

Документация Telegram: https://core.telegram.org/bots/api#editmessagecaption

Параметры:

caption (str) – Новая подпись к медиа
chat_id (int | str) – Обязательный, если не указан inline_message_id. Уникальный id чата или username канала
message_id (int) – Обязательный, если не указан inline_message_id.
inline_message_id (str) – Обязательный, если не указан inline_message_id. id inline сообщения.
parse_mode (str) – Новая подпись к медиа в сообщении, 0-1024 символа после форматирования
caption_entities (list of types.MessageEntity) – Массив объектов, описывающих то, как будет происходить парсинг подписи к медиа в формате JSON.
reply_markup (InlineKeyboardMarkup) – JSON-сериализованный объект inline клавиатуры.
show_caption_above_media (bool) – Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
business_connection_id (str) – Identifier of the business connection to send the message through
timeout (int) – Таймаут запроса в секундах.

Результат:

В случае успеха, если изменённое сообщение отправлено ботом, возвращается новый объект Message, иначе (inline сообщения) возвращается True.

Тип результата:

types.Message | bool

async edit_message_checklist(business_connection_id: str, chat_id: int | str, message_id: int, checklist: InputChecklist, reply_markup: InlineKeyboardMarkup | None = None) → Message¶

Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.

Telegram documentation: https://core.telegram.org/bots/api#editmessagechecklist

Параметры:

business_connection_id (str) – Unique identifier of the business connection on behalf of which the message will be sent
chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
message_id (int) – Unique identifier for the target message
checklist (telebot.types.InputChecklist) – A JSON-serialized object for the new checklist
reply_markup (telebot.types.InlineKeyboardMarkup) – Additional interface options. A JSON-serialized object for an inline keyboard.

Результат:

On success, the edited Message is returned.

Тип результата:

telebot.types.Message

Используйте этот метод, чтобы изменить live местоположение в сообщении. Местоположение может быть изменено пока не истечёт live_period или не: отключено вызовом метода stopMessageLiveLocation. В случае успеха, если измененное сообщение не является inline сообщением, возвращается новый объект Message, иначе возвращается True.

Документация Telegram: https://core.telegram.org/bots/api#editmessagelivelocation

Параметры:

latitude (float) – Широта нового местоположения
longitude (float) – Долгота нового местоположения
chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
message_id (int) – Обязательный, если не указан inline_message_id. id сообщения, которое нужно изменить
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – JSON-сериализованный объект новой inline клавиатуры.
timeout (int) – Таймаут запроса в секундах.
inline_message_id (str) – Обязательный, если не указаны chat_id и message_id. id inline сообщения
horizontal_accuracy (float) – Радиус погрешности местоположения, измеряется в метрах; 0-1500
heading (int) – Направление, в котором пользователь двигается, в градусах. Если указано, должно быть от 1 до 360.
proximity_alert_radius (int) – Максимальное расстояние для показа уведомлений о приближении других участников чата, в метрах. Если указано, должно быть от 1 до 100000.
live_period (int) – New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged
business_connection_id (str) – Identifier of a business connection, in which the message will be edited

Результат:

В случае успеха, если измененное сообщение не является inline сообщением, возвращается новый объект Message, иначе возвращается True.

Тип результата:

telebot.types.Message or bool

Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can’t be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Документация Telegram: https://core.telegram.org/bots/api#editmessagemedia

Параметры:

media (InputMedia) – JSON-сериализованный объект нового медиа контента
chat_id (int or str) – Обязательный, если не указан inline_message_id. Уникальный id чата или username канала (в формате @channelusername)
message_id (int) – Обязательный, если не указан inline_message_id. id отправленного сообщения
inline_message_id (str) – Обязательный, если не указаны chat_id и message_id. id inline сообщения
reply_markup (telebot.types.InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) – JSON-сериализованный объект inline клавиатуры.
business_connection_id (str) – Unique identifier of the business connection
timeout (int) – Таймаут запроса в секундах.

Результат:

Тип результата:

types.Message or bool

Используйте этот метод, чтобы изменить только reply markup сообщения.

Документация Telegram: https://core.telegram.org/bots/api#editmessagereplymarkup

Параметры:

chat_id (int or str) – Обязательный, если не указан inline_message_id. Уникальный id чата или username канала (в формате @channelusername)
message_id (int) – Обязательный, если не указан inline_message_id. id отправленного сообщения
inline_message_id (str) – Обязательный, если не указаны chat_id и message_id. id inline сообщения
reply_markup (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) – JSON-сериализованный объект inline клавиатуры.
business_connection_id (str) – Unique identifier of the business connection
timeout (int) – Таймаут запроса в секундах.

Результат:

Тип результата:

types.Message or bool

Используйте этот метод, чтобы изменить текстовые и игровые сообщения.

Документация Telegram: https://core.telegram.org/bots/api#editmessagetext

Параметры:

text (str) – Новый текст сообщения, 1-4096 символов после форматирования
chat_id (int or str) – Обязательный, если не указан inline_message_id. Уникальный id чата или username канала (в формате @channelusername)
message_id (int) – Обязательный, если не указан inline_message_id. id отправленного сообщения
inline_message_id (str) – Обязательный, если не указаны chat_id и message_id. id inline сообщения
parse_mode (str) – Режим форматирования в тексте сообщения.
entities (List of telebot.types.MessageEntity) – Список отформатированных частей в тексте сообщения, можно использовать вместо parse_mode
disable_web_page_preview (bool) – Deprecated - Use link_preview_options instead.
reply_markup (InlineKeyboardMarkup) – JSON-сериализованный объект inline клавиатуры.
link_preview_options (LinkPreviewOptions) – A JSON-serialized object for options used to automatically generate Telegram link previews for messages.
business_connection_id (str) – Unique identifier of the business connection
timeout (int) – Таймаут запроса в секундах.

Результат:

Тип результата:

types.Message or bool

async edit_story(business_connection_id: str, story_id: int, content: InputStoryContent, caption: str | None = None, parse_mode: str | None = None, caption_entities: List[MessageEntity] | None = None, areas: List[StoryArea] | None = None) → Story¶

Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

Telegram documentation: https://core.telegram.org/bots/api#editstory

Параметры:

business_connection_id (str) – Unique identifier of the business connection
story_id (int) – Unique identifier of the story to edit
content (telebot.types.InputStoryContent) – Content of the story
caption (str) – Caption of the story, 0-2048 characters after entities parsing
parse_mode (str) – Mode for parsing entities in the story caption. See formatting options for more details.
caption_entities (list of telebot.types.MessageEntity) – Список отформатированных частей подписи в формате JSON, можно использовать вместо parse_mode
areas (list of telebot.types.StoryArea) – A JSON-serialized list of clickable areas to be shown on the story

Результат:

On success, a Story object is returned.

Тип результата:

telebot.types.Story

async edit_user_star_subscription(user_id: int, telegram_payment_charge_id: str, is_canceled: bool) → bool¶

Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#edituserstarsubscription

Параметры:

user_id (int) – Identifier of the user whose subscription will be edited
telegram_payment_charge_id (str) – Telegram payment identifier for the subscription
is_canceled (bool) – Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot.

Результат:

В случае успеха возвращается True.

Тип результата:

bool

edited_business_message_handler(commands=None, regexp=None, func=None, content_types=None, **kwargs)¶

Handles new version of a message(business accounts) that is known to the bot and was edited. As a parameter to the decorator function, it passes telebot.types.Message object.

Параметры:

commands (list of str) – Необязательный список строк - команд для обработки.
regexp (str) – Необязательное регулярное выражение.
func (function) – Функция, используемая в качестве фильтра
content_types (list of str) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

edited_channel_post_handler(commands=None, regexp=None, func=None, content_types=None, **kwargs)¶

Обрабатывает новую версию поста в канале, который доступен боту и был изменён. В качестве параметра, передаёт в декорируемую функцию объект telebot.types.Message.

Параметры:

commands (list of str) – Необязательный список строк - команд для обработки.
regexp (str) – Необязательное регулярное выражение.
func (function) – Функция, используемая в качестве фильтра
content_types (list of str) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

edited_message_handler(commands=None, regexp=None, func=None, content_types=None, chat_types=None, **kwargs)¶

Обрабатывает новую версию сообщения, которое доступно боту и было изменено.

В качестве параметра, передаёт в декорируемую функцию объект telebot.types.Message.

Параметры:

commands (list of str) – Необязательный список строк - команд для обработки.
regexp (str) – Необязательное регулярное выражение.
func (function) – Функция, используемая в качестве фильтра
content_types (list of str) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]
chat_types (list of str) – список видов чатов
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

enable_saving_states(filename='./.state-save/states.pkl')¶

Разрешить сохранение стейтов (по умолчанию сохранение отключено)

Примечание

Рекомендуется передавать экземпляр класса StatePickleStorage в качестве state_storage при инициализации класса TeleBot вместо использования этой функции.

Параметры:: filename (str, optional) – Имя файла для сохранения, по умолчанию «./.state-save/states.pkl»

async export_chat_invite_link(chat_id: int | str) → str¶

Используйте этот метод, чтобы создать или заменить главную ссылку-приглашение в супергруппу или канал, созданную ботом. Бот должен быть администратором чата и иметь соответствующие права администратора.

Документация Telegram: https://core.telegram.org/bots/api#exportchatinvitelink

Параметры:: chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
Результат:: новая ссылка-приглашение (String) в случае успеха.
Тип результата:: str

Используйте этот метод, чтобы переслать любое сообщение.

Документация Telegram: https://core.telegram.org/bots/api#forwardmessage

Параметры:

disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука
chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
from_chat_id (int or str) – Уникальный id чата, в который было отправлено исходное сообщение (или username канала в формате @channelusername)
message_id (int) – id сообщения в чате, заданном в from_chat_id
video_start_timestamp (int) – New start timestamp for the forwarded video in the message
protect_content (bool) – Запретить пересылку и сохранение содержимого пересланного сообщения
timeout (int) – Таймаут запроса в секундах.
message_thread_id (int) – Уникальный id топика, в который нужно переслать сообщение; только для супергрупп с топиками
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
message_effect_id (str) – Unique identifier of the message effect to be added to the message; only available when forwarding to private chats

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Use this method to forward multiple messages of any kind. If some of the specified messages can’t be found or forwarded, they are skipped. Service messages and messages with protected content can’t be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.

Telegram documentation: https://core.telegram.org/bots/api#forwardmessages

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
from_chat_id (int or str) – Уникальный id чата, в который было отправлено исходное сообщение (или username канала в формате @channelusername)
message_ids (list) – Message identifiers in the chat specified in from_chat_id
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука
message_thread_id (int) – id топика, в который будет отправлена группа медиа
protect_content (bool) – Запретить пересылку и сохранение содержимого пересланного сообщения
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.MessageID

async get_available_gifts() → Gifts¶

Returns the list of gifts that can be sent by the bot to users. Requires no parameters. Returns a Gifts object.

Telegram documentation: https://core.telegram.org/bots/api#getavailablegifts

Результат:: On success, a Gifts object is returned.
Тип результата:: telebot.types.Gifts

Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.

Telegram documentation: https://core.telegram.org/bots/api#getbusinessaccountgifts

Параметры:

business_connection_id (str) – Unique identifier of the business connection
exclude_unsaved (bool) – Pass True to exclude gifts that aren’t saved to the account’s profile page
exclude_saved (bool) – Pass True to exclude gifts that are saved to the account’s profile page
exclude_unlimited (bool) – Pass True to exclude gifts that can be purchased an unlimited number of times
exclude_limited (bool) – Deprecated, use exclude_limited_upgradable and exclude_limited_non_upgradable instead.
exclude_unique (bool) – Pass True to exclude unique gifts
exclude_from_blockchain (bool) – Pass True to exclude gifts that were assigned from the TON blockchain and can’t be resold or transferred in Telegram
sort_by_price (bool) – Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.
offset (str) – Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results
limit (int) – The maximum number of gifts to be returned; 1-100. Defaults to 100
exclude_limited_upgradable (bool) – Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
exclude_limited_non_upgradable (bool) – Pass True to exclude gifts that can be purchased a limited number of times and can’t be upgraded to unique

Результат:

On success, a OwnedGifts object is returned.

Тип результата:

telebot.types.OwnedGifts

async get_business_account_star_balance(business_connection_id: str) → StarAmount¶

Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.

Telegram documentation: https://core.telegram.org/bots/api#getbusinessaccountstarbalance

Параметры:: business_connection_id (str) – Unique identifier of the business connection
Результат:: On success, a StarAmount object is returned.
Тип результата:: telebot.types.StarAmount

async get_business_connection(business_connection_id: str) → BusinessConnection¶

Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

Telegram documentation: https://core.telegram.org/bots/api#getbusinessconnection

Параметры:: business_connection_id (str) – Unique identifier of the business connection
Результат:: Returns a BusinessConnection object on success.
Тип результата:: telebot.types.BusinessConnection

async get_chat(chat_id: int | str) → ChatFullInfo¶

Используйте этот метод, чтобы получить актуальную информацию о чате (текущее имя пользователя для персональных диалогов, текущий username пользователя, группы или канала и т.д.). В случае успеха возвращает объект Chat.

Документация Telegram: https://core.telegram.org/bots/api#getchat

Параметры:: chat_id (int or str) – Уникальный id чата или username супергруппы или канала (в формате @channelusername)
Результат:: Информация о чате
Тип результата:: telebot.types.ChatFullInfo

async get_chat_administrators(chat_id: int | str, return_bots: bool | None = None) → List[ChatMember]¶

Используйте этот метод, чтобы получить список администраторов чата. В случае успеха, возвращает массив объектов ChatMember, содержащих информацию обо всех администраторах чата, кроме других ботов.

Документация Telegram: https://core.telegram.org/bots/api#getchatadministrators

Параметры:

chat_id (int or str) – Уникальный id чата или username супергруппы или канала (в формате @channelusername)
return_bots (bool) – Pass True to additionally receive all bots that are administrators of the chat. By default, bots other than the current bot are omitted.

Результат:

Список объектов ChatMember.

Тип результата:

list of telebot.types.ChatMember

Returns the gifts owned by a chat. Returns OwnedGifts on success.

Telegram documentation: https://core.telegram.org/bots/api#getchatgifts

Параметры:

chat_id (int | str) – Уникальный id чата или username канала (в формате @channelusername)
exclude_unsaved (bool) – Pass True to exclude gifts that aren’t saved to the chat’s profile page. Always True, unless the bot has the can_post_messages administrator right in the channel.
exclude_saved (bool) – Pass True to exclude gifts that are saved to the chat’s profile page. Always False, unless the bot has the can_post_messages administrator right in the channel.
exclude_unlimited (bool) – Pass True to exclude gifts that can be purchased an unlimited number of times
exclude_limited_upgradable (bool) – Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
exclude_limited_non_upgradable (bool) – Pass True to exclude gifts that can be purchased a limited number of times and can’t be upgraded to unique
exclude_from_blockchain (bool) – Pass True to exclude gifts that were assigned from the TON blockchain and can’t be resold or transferred in Telegram
exclude_unique (bool) – Pass True to exclude unique gifts
sort_by_price (bool) – Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.
offset (str) – Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results
limit (int) – The maximum number of gifts to be returned; 1-100. Defaults to 100

Результат:

On success, a OwnedGifts object is returned.

Тип результата:

telebot.types.OwnedGifts

async get_chat_member(chat_id: int | str, user_id: int) → ChatMember¶

Используйте этот метод, чтобы получить информацию об участнике чата. Возвращает объект ChatMember в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#getchatmember

Параметры:

chat_id (int or str) – Уникальный id чата или username супергруппы (в формате @supergroupusername)
user_id (int) – Уникальный id сделавшего запрос пользователя

Результат:

Возвращает объект ChatMember в случае успеха.

Тип результата:

telebot.types.ChatMember

async get_chat_member_count(chat_id: int | str) → int¶

Используйте этот метод, чтобы получить количество участников чата.

Документация Telegram: https://core.telegram.org/bots/api#getchatmembercount

Параметры:: chat_id (int or str) – Уникальный id чата или username супергруппы или канала (в формате @channelusername)
Результат:: Количество участников чата.
Тип результата:: int

get_chat_members_count(**kwargs)¶

async get_chat_menu_button(chat_id: int | str = None) → MenuButton¶

Используйте этот метод, чтобы получить текущее значение кнопки menu в приватном чате, или кнопку menu по умолчанию. Возвращает MenuButton в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#getchatmenubutton

Параметры:: chat_id (int or str) – Уникальный id приватного чата. Если не указан, будет возвращена кнопка menu по умолчанию.
Результат:: types.MenuButton
Тип результата:: telebot.types.MenuButton

async get_custom_emoji_stickers(custom_emoji_ids: List[str]) → List[Sticker]¶

Используйте этот метод, чтобы получить информацию о кастомных эмодзи по их id. Возвращает массив объектов Sticker.

Параметры:: custom_emoji_ids (list of str) – Список id кастомных эмодзи. Можно указать не более 200 id.
Результат:: Возвращает массив объектов Sticker.
Тип результата:: list of telebot.types.Sticker

async get_file(file_id: str | None) → File¶

Используйте этот метод, чтобы получить базовую информацию о файле и подготовить его к скачиванию. На текущий момент, боты могут скачивать файлы весом до 20MB. В случае успеха, возвращается объект File. Гарантируется, что ссылка на скачивание будет актуальна как минимум 1 час. Когда ссылка перестаёт быть актуальной, новая может быть снова запрошена с помощью get_file.

Документация Telegram: https://core.telegram.org/bots/api#getfile

Параметры:: file_id (str) – id файла
Результат:: telebot.types.File

async get_file_url(file_id: str | None) → str¶

Получить актуальную ссылку для скачивания файла.

Параметры:: file_id (str) – id файла для получения ссылки на скачивание.
Результат:: Ссылка для скачивания файла.
Тип результата:: str

async get_forum_topic_icon_stickers() → List[Sticker]¶

Используйте этот метод, чтобы получить кастомные эмодзи, которые могут быть использованы любыми пользователями в качестве иконок топиков. Не требует параметров. Возвращает массив объектов Sticker.

Документация Telegram: https://core.telegram.org/bots/api#getforumtopiciconstickers

Результат:: В случае успеха, возвращается список объектов StickerSet.
Тип результата:: List[telebot.types.StickerSet]

async get_game_high_scores(user_id: int, chat_id: int | str | None = None, message_id: int | None = None, inline_message_id: str | None = None) → List[GameHighScore]¶

Используйте этот метод, чтобы получить данные для таблицы рекордов. Вернёт очки указанного пользователя и несколько соседних результатов. В случае успеха, возвращает массив объектов GameHighScore.

На текущий момент этот метод вернёт очки указанного пользователя и по два соседних результата с каждой стороны. Также вернет результаты трёх лучших игроков, если результат пользователя и соседние не являются тремя лучшими. Пожалуйста учитывайте, что это поведение может быть изменено.

Документация Telegram: https://core.telegram.org/bots/api#getgamehighscores

Параметры:

user_id (int) – id пользователя
chat_id (int or str) – Обязательный, если не указан inline_message_id. Уникальный id чата или username канала (в формате @channelusername)
message_id (int) – Обязательный, если не указан inline_message_id. id отправленного сообщения
inline_message_id (str) – Обязательный, если не указаны chat_id и message_id. id inline сообщения

Результат:

В случае успеха, возвращает массив объектов GameHighScore.

Тип результата:

List[types.GameHighScore]

async get_managed_bot_access_settings(user_id: int) → BotAccessSettings¶

Use this method to get the access settings of a managed bot. Returns a BotAccessSettings object on success.

Telegram documentation: https://core.telegram.org/bots/api#getmanagedbotaccesssettings

Параметры:: user_id (int) – User identifier of the managed bot whose access settings will be returned
Результат:: Returns a BotAccessSettings object on success.
Тип результата:: telebot.types.BotAccessSettings

async get_managed_bot_token(user_id: int) → str¶

Use this method to get the token of a managed bot. Returns the token as String on success.

Telegram documentation: https://core.telegram.org/bots/api#getmanagedbottoken

Параметры:: user_id (int) – User identifier of the managed bot whose token will be returned
Результат:: Returns the token as String on success.
Тип результата:: str

async get_me() → User¶

Возвращает базовую информацию о боте в виде объекта User.

Документация Telegram: https://core.telegram.org/bots/api#getme

async get_my_commands(scope: BotCommandScope | None, language_code: str | None) → List[BotCommand]¶

Используйте этот метод, чтобы получить текущий список команд бота. Возвращает список объектов BotCommand в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#getmycommands

Параметры:

scope (telebot.types.BotCommandScope) – Область видимости команд. По умолчанию BotCommandScopeDefault.
language_code (str) – Двухбуквенный языковой код в формате ISO 639-1. Если не задан, изменения коснутся команд для всех пользователей в заданном поле видимости, не имеющих команд на их языке

Результат:

Список объектов BotCommand в случае успеха.

Тип результата:

list of telebot.types.BotCommand

async get_my_default_administrator_rights(for_channels: bool = None) → ChatAdministratorRights¶

Используйте этот метод, чтобы получить текущие права администратора для бота по умолчанию. Возвращает объект ChatAdministratorRights в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#getmydefaultadministratorrights

Параметры:: for_channels (bool) – Передайте True, чтобы получить права администратора для бота по умолчанию в каналах. Иначе, будут возвращены права администратора для бота по умолчанию в группах и супергруппах.
Результат:: Возвращает объект ChatAdministratorRights в случае успеха.
Тип результата:: telebot.types.ChatAdministratorRights

async get_my_description(language_code: str | None = None)¶

Use this method to get the current bot description for the given user language. Returns BotDescription on success.

Параметры:: language_code (str) – A two-letter ISO 639-1 language code or an empty string
Результат:: telebot.types.BotDescription

async get_my_name(language_code: str | None = None)¶

Use this method to get the current bot name for the given user language. Returns BotName on success.

Telegram documentation: https://core.telegram.org/bots/api#getmyname

Параметры:: language_code (str) – Optional. A two-letter ISO 639-1 language code or an empty string
Результат:: telebot.types.BotName

async get_my_short_description(language_code: str | None = None)¶

Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.

Параметры:: language_code (str) – A two-letter ISO 639-1 language code or an empty string
Результат:: telebot.types.BotShortDescription

async get_my_star_balance() → StarAmount¶: A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.

async get_star_transactions(offset: int | None = None, limit: int | None = None) → StarTransactions¶

Returns the bot’s Telegram Star transactions in chronological order.

Telegram documentation: https://core.telegram.org/bots/api#getstartransactions

Параметры:

offset (int) – Number of transactions to skip in the response
limit (int) – The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100.

Результат:

On success, returns a StarTransactions object.

Тип результата:

types.StarTransactions

async get_state(user_id: int, chat_id: int | None = None, business_connection_id: str | None = None, message_thread_id: int | None = None, bot_id: int | None = None) → str¶

Получает текущее состояние (стейт) пользователя. Не рекомендуется использовать этот метод. Но это удобно для дебага.

Предупреждение

Even if you are using telebot.types.State, this method will return a string. When comparing(not recommended), you should compare this string with telebot.types.State.name

Параметры:

user_id (int) – id пользователя
chat_id (int) – id чата
bot_id (int) – Bot’s identifier, defaults to current bot id
business_connection_id (str) – Business identifier
message_thread_id (int) – Identifier of the message thread

Результат:

состояние (стейт) пользователя

Тип результата:

str

async get_sticker_set(name: str) → StickerSet¶

Используйте этот метод, чтобы получить стикерпак. В случае успеха, возвращается объект StickerSet.

Документация Telegram: https://core.telegram.org/bots/api#getstickerset

Параметры:: name (str) – Имя стикерпака
Результат:: В случае успеха, возвращается объект StickerSet.
Тип результата:: telebot.types.StickerSet

Используйте этот метод, чтобы получить новые апдейты с помощью long polling-а (wiki). Возвращается массив объектов Update.

Документация Telegram: https://core.telegram.org/bots/api#getupdates

Параметры:

offset (int, optional) – id первого апдейта. Должен быть на единицу больше наибольшего id среди ранее полученных апдейтов. По умолчанию, возвращается список апдейтов, начиная с самого раннего неполученного. Апдейт считается полученным как только вызван метод getUpdates со смещением больше, чем id этого апдейта. Отрицательное смещение может быть указано для получения последних offset апдейтов. Все предыдущие апдейты будут считаться полученными.
limit (int, optional) – Максимальное число апдейтов для получения. Допускаются значения от 1 до 100. По умолчанию 100.
timeout (int, optional) – Тайм-аут запроса
allowed_updates (list, optional) – Массив строк. Список видов апдейтов, которые вы хотите получать.
request_timeout (int, optional) – Timeout in seconds for request.

Результат:

Возвращается массив объектов Update.

Тип результата:

list of telebot.types.Update

async get_user_chat_boosts(chat_id: int | str, user_id: int) → UserChatBoosts¶

Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.

Telegram documentation: https://core.telegram.org/bots/api#getuserchatboosts

Параметры:

chat_id (int | str) – Уникальный id чата или username канала
user_id (int) – Уникальный id сделавшего запрос пользователя

Результат:

On success, a UserChatBoosts object is returned.

Тип результата:

telebot.types.UserChatBoosts

Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.

Telegram documentation: https://core.telegram.org/bots/api#getusergifts

Параметры:

user_id (int) – Unique identifier of the user
exclude_unlimited (bool) – Pass True to exclude gifts that can be purchased an unlimited number of times
exclude_limited_upgradable (bool) – Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
exclude_limited_non_upgradable (bool) – Pass True to exclude gifts that can be purchased a limited number of times and can’t be upgraded to unique
exclude_from_blockchain (bool) – Pass True to exclude gifts that were assigned from the TON blockchain and can’t be resold or transferred in Telegram
exclude_unique (bool) – Pass True to exclude unique gifts
sort_by_price (bool) – Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.
offset (str) – Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results
limit (int) – The maximum number of gifts to be returned; 1-100. Defaults to 100

Результат:

On success, a OwnedGifts object is returned.

Тип результата:

telebot.types.OwnedGifts

async get_user_personal_chat_messages(user_id: int, limit: int) → List[Message]¶

Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user. On success, an array of Message objects is returned.

Telegram documentation: https://core.telegram.org/bots/api#getuserpersonalchatmessages

Параметры:

user_id (int) – Unique identifier for the target user
limit (int) – The maximum number of messages to return; 1-20

Результат:

An array of Message objects.

Тип результата:

list of telebot.types.Message

async get_user_profile_audios(user_id: int, offset: int | None = None, limit: int | None = None) → UserProfileAudios¶

Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.

Telegram documentation: https://core.telegram.org/bots/api#getuserprofileaudios

Параметры:

user_id (int) – Уникальный id сделавшего запрос пользователя
offset (int) – Sequential number of the first audio to be returned. By default, all audios are returned.
limit (int) – Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.

Результат:

If successful, returns a UserProfileAudios object.

Тип результата:

telebot.types.UserProfileAudios

async get_user_profile_photos(user_id: int, offset: int | None = None, limit: int | None = None) → UserProfilePhotos¶

Используйте этот метод, чтобы получить список аватарок пользователя. Возвращает объект telebot.types.UserProfilePhotos.

Документация Telegram: https://core.telegram.org/bots/api#getuserprofilephotos

Параметры:

user_id (int) – Уникальный id сделавшего запрос пользователя
offset (int) – Порядковый номер первого фото для получения. По умолчанию, возвращаются все фото.
limit (int) – Максимальное число фото для получения. Допускаются значения от 1 до 100. По умолчанию 100.

Результат:

UserProfilePhotos

Тип результата:

telebot.types.UserProfilePhotos

async get_webhook_info(timeout: int | None = None) → WebhookInfo¶

Используйте этот метод, чтобы получить текущий статус вебхука. Не требует параметров. В случае успеха возвращает объект WebhookInfo. Если бот использует getUpdates, вернёт объект с пустым атрибутом url.

Документация Telegram: https://core.telegram.org/bots/api#getwebhookinfo

Параметры:: timeout (int, optional) – Тайм-аут запроса
Результат:: В случае успеха, возвращает объект WebhookInfo.
Тип результата:: telebot.types.WebhookInfo

async gift_premium_subscription(user_id: int, month_count: int, star_count: int, text: str | None = None, text_parse_mode: str | None = None, text_entities: List[MessageEntity] | None = None) → bool¶

Gifts a Telegram Premium subscription to the given user. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#giftpremiumsubscription

Параметры:

user_id (int) – Unique identifier of the target user who will receive a Telegram Premium subscription
month_count (int) – Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12
star_count (int) – Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months
text (str) – Text that will be shown along with the service message about the subscription; 0-128 characters
text_parse_mode (str) – Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
text_entities (list of telebot.types.MessageEntity) – A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

guest_message_handler(func=None, **kwargs)¶

New guest message. Use :field:`telebot.types.Message.guest_query_id` from the received message and the method answer_guest_query() to send a response.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

async hide_general_forum_topic(chat_id: int | str) → bool¶

Документация Telegram: https://core.telegram.org/bots/api#deleteforumtopic

Параметры:: chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)

Запустить поллинг в бесконечном цикле с обработкой исключений, чтобы избежать непредвиденных остановок поллинга.

Примечание

Установите watchdog и psutil, чтобы использовать restart_on_change.

Параметры:

timeout (int) – Тайм-аут get_updates в секундах(по умолчанию None)
skip_pending (bool) – пропускать старые апдейты
request_timeout (int) – Тайм-аут запроса aiohttp. По умолчанию 5 минут(aiohttp.ClientTimeout).
logger_level (int) – Кастомный уровень логирования для infinity_polling. Используйте уровни из logging в качестве значений. None/NOTSET = не логировать ошибки.
allowed_updates (list of str) –
Список видов апдейтов, которые вы хотите получать. Например, укажите [“message”, “edited_channel_post”, “callback_query”], чтобы получать апдейты только этих видов. Полный список доступных видов апдейтов - util.update_types. Укажите пустой список, чтобы получать все апдейты, кроме chat_member (по умолчанию). Если не задан, будет использована последняя настройка.

Пожалуйста учитывайте, что этот параметр не влияет на апдейты, отправленные до вызова get_updates, поэтому нежелательные апдейты могут быть получены в течение короткого периода времени.
restart_on_change (bool) – Перезапуск при изменении файлов. По умолчанию False
path_to_watch (str) – Путь для мониторинга изменений. По умолчанию текущая директория.

Результат:

None

inline_handler(func=None, **kwargs)¶

Обрабатывает inline query. В качестве параметра, передаёт в декорируемую функцию объект telebot.types.InlineQuery.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

async kick_chat_member(chat_id: int | str, user_id: int, until_date: int | datetime | None = None, revoke_messages: bool | None = None) → bool¶: Эта функция устарела. Используйте ban_chat_member

async leave_chat(chat_id: int | str) → bool¶

Используйте этот метод, чтобы покинуть группу, супергруппу или канал. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#leavechat

Параметры:: chat_id (int or str) – Уникальный id чата или username супергруппы или канала (в формате @channelusername)
Результат:: bool

async log_out() → bool¶

Используйте этот метод, чтобы отключиться от облачного Bot API сервера перед локальным запуском бота. Вы ДОЛЖНЫ отключить бота перед тем, как запускать его локально, иначе нет никаких гарантий, что бот будет получать апдейты. После успешного вызова, вы можете тут же подключиться к локальному серверу, но не сможете подключиться обратно к облачному Bot API серверу в течение 10 минут. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#logout

Результат:: True в случае успеха.
Тип результата:: bool

managed_bot_handler(func=None, **kwargs)¶

Handles new incoming managed bot state.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

message_handler(commands=None, regexp=None, func=None, content_types=None, chat_types=None, **kwargs)¶

Handles new incoming message of any kind - text, photo, sticker, etc. As a parameter to the decorator function, it passes telebot.types.Message object. All message handlers are tested in the order they were added.

Пример:

Использование message_handler¶

bot = TeleBot('TOKEN')

# Handles all messages which text matches regexp.
@bot.message_handler(regexp='someregexp')
async def command_help(message):
    await bot.send_message(message.chat.id, 'Did someone call for help?')

# Handles messages in private chat
@bot.message_handler(chat_types=['private']) # You can add more chat types
async def command_help(message):
    await bot.send_message(message.chat.id, 'Private chat detected, sir!')

# Handle all sent documents of type 'text/plain'.
@bot.message_handler(func=lambda message: message.document.mime_type == 'text/plain',
    content_types=['document'])
async def command_handle_document(message):
    await bot.send_message(message.chat.id, 'Document received, sir!')

# Handle all other messages.
@bot.message_handler(func=lambda message: True, content_types=['audio', 'photo', 'voice', 'video', 'document',
    'text', 'location', 'contact', 'sticker'])
async def default_command(message):
    await bot.send_message(message.chat.id, "This is the default command handler.")

Параметры:

commands (list of str) – Необязательный список строк - команд для обработки.
regexp (str) – Необязательное регулярное выражение.
func – Необязательная lambda функция. Получает сообщение (объект Message) в качестве первого параметра. Функция должна вернуть True если хендлер должен обработать сообщение.
content_types (list of str) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]
chat_types (list of str) – список видов чатов
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

декорируемая функция

message_reaction_count_handler(func=None, **kwargs)¶

Handles new incoming message reaction count. As a parameter to the decorator function, it passes telebot.types.MessageReactionCountUpdated object.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

message_reaction_handler(func=None, **kwargs)¶

Handles new incoming message reaction. As a parameter to the decorator function, it passes telebot.types.MessageReactionUpdated object.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

my_chat_member_handler(func=None, **kwargs)¶

Обрабатывает изменения статуса бота. Для приватных чатов, этот апдейт отправляется только когда бот был заблокирован или разблокирован пользователем. В качестве параметра передаёт в декорируемую функцию объект telebot.types.ChatMemberUpdated.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

async pin_chat_message(chat_id: int | str, message_id: int, disable_notification: bool | None = False, business_connection_id: str | None = None) → bool¶

Используйте этот метод, чтобы закрепить сообщение в супергруппе. Бот должен быть администратором чата и иметь соответствующие права администратора. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#pinchatmessage

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
message_id (int) – id сообщения, которое нужно закрепить
disable_notification (bool) – Передайте True, если всем участникам группы необходимо отправить уведомление о закреплённом сообщении
business_connection_id (str) – Unique identifier of the business connection

Результат:

True в случае успеха.

Тип результата:

bool

poll_answer_handler(func=None, **kwargs)¶

Обрабатывает изменения ответа пользователя в не анонимном опросе(когда пользователь меняет выбор). Боты получают новые ответы только в опросах, которые отправили сами. В качестве параметра передаёт в декорируемую функцию объект telebot.types.PollAnswer.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

poll_handler(func, **kwargs)¶

Обрабатывает изменения в состоянии опроса. Боты получают только апдейты о завершенных опросах и опросах, которые отправили сами. В качестве параметра передаёт в декорируемую функцию объект telebot.types.Poll.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

async polling(non_stop: bool = True, skip_pending=False, interval: int = 0, timeout: int = 20, request_timeout: int | None = None, allowed_updates: List[str] | None = None, none_stop: bool | None = None, restart_on_change: bool | None = False, path_to_watch: str | None = None)¶

Запускает бота в режиме поллинга в основном цикле событий. Это позволяет боту получать апдейты (Update) автоматически и вызывать соответствующие листенеры и хендлеры.

Предупреждение: Не вызывайте эту функцию более одного раза!

Всегда получает апдейты.

Примечание

Установите watchdog и psutil, чтобы использовать restart_on_change.

Параметры:

non_stop (bool) – Не останавливать поллинг при возникновении ApiException.
skip_pending (bool) – пропускать старые апдейты
interval (int) – Задержка между получением апдейтов
timeout (int) – Тайм-аут запроса
request_timeout (int) – Тайм-аут get_updates в секундах(по умолчанию None)
allowed_updates (list of str) –
Список видов апдейтов, которые вы хотите получать. Например, укажите [“message”, “edited_channel_post”, “callback_query”], чтобы получать апдейты только этих видов. Полный список доступных видов апдейтов - util.update_types. Укажите пустой список, чтобы получать все апдейты, кроме chat_member (по умолчанию). Если не задан, будет использована последняя настройка.

Пожалуйста учитывайте, что этот параметр не влияет на апдейты, отправленные до вызова get_updates, поэтому нежелательные апдейты могут быть получены в течение короткого периода времени.
none_stop (bool) – Устарело, используйте non_stop. Старая опечатка, оставлено для обратной совместимости
restart_on_change (bool) – Перезапускать при изменениях в файлах. По умолчанию False.
path_to_watch (str) – Путь для мониторинга изменений. По умолчанию текущая директория.

Результат:

async post_story(business_connection_id: str, content: InputStoryContent, active_period: int, caption: str | None = None, parse_mode: str | None = None, caption_entities: List[MessageEntity] | None = None, areas: List[StoryArea] | None = None, post_to_chat_page: bool | None = None, protect_content: bool | None = None) → Story¶

Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

Telegram documentation: https://core.telegram.org/bots/api#poststory

Параметры:

business_connection_id (str) – Unique identifier of the business connection
content (telebot.types.InputStoryContent) – Content of the story
active_period (int) – Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400
caption (str) – Caption of the story, 0-2048 characters after entities parsing
parse_mode (str) – Mode for parsing entities in the story caption. See formatting options for more details.
caption_entities (list of telebot.types.MessageEntity) – Список отформатированных частей подписи в формате JSON, можно использовать вместо parse_mode
areas (list of telebot.types.StoryArea) – A JSON-serialized list of clickable areas to be shown on the story
post_to_chat_page (bool) – Pass True to keep the story accessible after it expires
protect_content (bool) – Pass True if the content of the story must be protected from forwarding and screenshotting

Результат:

On success, a Story object is returned.

Тип результата:

telebot.types.Story

pre_checkout_query_handler(func, **kwargs)¶

Новая pre-checkout query. Содержит полную информацию о заказе. В качестве параметра передаёт в декорируемую функцию объект telebot.types.PreCheckoutQuery.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

async process_new_updates(updates: List[Update])¶

Обрабатывает новые апдейты. Просто передайте список апдейтов(Update и его наследники).

Параметры:: updates (list of telebot.types.Update) – список апдейтов
Результат:: None

Используйте этот метод, чтобы повысить или понизить пользователя в супергруппе или канале. Бот должен быть администратором чата и иметь соответствующие права администратора. Передайте False во все boolean параметры, чтобы понизить пользователя.

Документация Telegram: https://core.telegram.org/bots/api#promotechatmember

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
user_id (int) – Уникальный id сделавшего запрос пользователя
can_change_info (bool) – Передайте True, если администратор может менять название чата, аватарку и другие настройки
can_post_messages (bool) – Передайте True, если администратор может создавать посты в канале, только для каналов
can_edit_messages (bool) – Передайте True, если администратор может изменять сообщения других пользователей, только для каналов
can_delete_messages (bool) – Передайте True, если администратор может удалять сообщения других пользователей
can_invite_users (bool) – Передайте True, если администратор может приглашать новых пользователей в чат
can_restrict_members (bool) – Передайте True, если администратор может ограничивать, банить или разбанивать участников чата
can_pin_messages (bool) – Передайте True, если администратор может закреплять сообщения, только для супергрупп
can_promote_members (bool) – Передайте True, если администратор может добавлять новых администраторов с подмножеством его собственных прав администратора или понижать администраторов, которых он повысил, напрямую или косвенно (администраторами, которых он назначил)
is_anonymous (bool) – Передайте True, если присутствие администратора в чате скрыто
can_manage_chat (bool) – Передайте True, если администратор имеет доступ к логу событий чата, статистике чата, статистике сообщений в каналах, видеть участников канала, видеть анонимных администраторов в супергруппах и игнорировать медленный режим. Подразумевается любым другим правом администратора
can_manage_video_chats (bool) – Передайте True, если администратор может управлять голосовыми чатами. На текущий момент, боты могут использовать это право администратора только для передачи другим администраторам.
can_manage_voice_chats (bool) – Устарело, используйте can_manage_video_chats.
can_manage_topics (bool) – Передайте True, если пользователю разрешено создавать, переименовывать, закрывать, и возобновлять топики, только для супергрупп
can_post_stories (bool) – Pass True if the administrator can create the channel’s stories
can_edit_stories (bool) – Pass True if the administrator can edit the channel’s stories
can_delete_stories (bool) – Pass True if the administrator can delete the channel’s stories
can_manage_direct_messages (bool) – Pass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only
can_manage_tags (bool) – Pass True if the administrator can manage tags in the chat

Результат:

True в случае успеха.

Тип результата:

bool

purchased_paid_media_handler(func=None, **kwargs)¶

Handles new incoming purchased paid media.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

async read_business_message(business_connection_id: str, chat_id: int | str, message_id: int) → bool¶

Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#readbusinessmessage

Параметры:

business_connection_id (str) – Unique identifier of the business connection on behalf of which to read the message
chat_id (int | str) – Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours.
message_id (int) – Unique identifier of the message to mark as read

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async refund_star_payment(user_id: int, telegram_payment_charge_id: str) → bool¶

Refunds a successful payment in Telegram Stars. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#refundstarpayment

Параметры:

user_id (int) – Identifier of the user whose payment will be refunded
telegram_payment_charge_id (str) – Telegram payment identifier

Результат:

В случае успеха возвращается True.

Тип результата:

bool

register_business_connection_handler(callback: Callable, func: Callable | None = None, pass_bot: bool | None = False, **kwargs)¶

Registers business connection handler.

Параметры:

callback (function) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

Registers business connection handler.

Параметры:

callback (function) – функция-хендлер
commands (list of str) – список команд
regexp (str) – Регулярное выражение
func (function) – Функция, используемая в качестве фильтра
content_types (list of str) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]
pass_bot (bool) – True, if bot instance should be passed to handler
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_callback_query_handler(callback: Callable[[Any], Awaitable], func: Callable, pass_bot: bool | None = False, **kwargs)¶

Регистрирует хендлер callback query.

Параметры:

callback (Awaitable) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

Регистрирует хендлер постов в каналах.

Параметры:

callback (Awaitable) – функция-хендлер
content_types (list of str) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]
commands (list of str) – список команд
regexp (str) – Регулярное выражение
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_chat_boost_handler(callback: Callable, func: Callable | None = None, pass_bot: bool | None = False, **kwargs)¶

Registers chat boost handler.

Параметры:

callback (function) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_chat_join_request_handler(callback: Callable[[Any], Awaitable], func: Callable | None = None, pass_bot: bool | None = False, **kwargs)¶

Регистрирует хендлер запросов на вступление в чат.

Параметры:

callback (Awaitable) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_chat_member_handler(callback: Callable[[Any], Awaitable], func: Callable | None = None, pass_bot: bool | None = False, **kwargs)¶

Регистрирует хендлер смены состояний участников чата.

Параметры:

callback (Awaitable`) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

:return:None

register_chosen_inline_handler(callback: Callable[[Any], Awaitable], func: Callable, pass_bot: bool | None = False, **kwargs)¶

Регистрирует хендлер выбора результата inline query.

Параметры:

callback (Awaitable) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_deleted_business_messages_handler(callback: Callable, func: Callable | None = None, pass_bot: bool | None = False, **kwargs)¶

Registers deleted business messages handler.

Параметры:

callback (function) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

Registers edited message handler for business accounts.

Параметры:

callback (function) – функция-хендлер
content_types (list of str) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]
commands (list of str) – список команд
regexp (str) – Регулярное выражение
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

Регистрирует хендлер изменения постов в каналах.

Параметры:

callback (Awaitable) – функция-хендлер
content_types (list of str) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]
commands (list of str) – список команд
regexp (str) – Регулярное выражение
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

декорируемая функция

Регистрирует хендлер изменения сообщений.

Параметры:

callback (Awaitable) – функция-хендлер
content_types (list of str) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]
commands (list of str) – список команд
regexp (str) – Регулярное выражение
func (function) – Функция, используемая в качестве фильтра
chat_types (bool) – True для приватных чатов
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_guest_message_handler(callback: Callable, func: Callable | None = None, pass_bot: bool | None = False, **kwargs)¶

Registers guest message handler.

Параметры:

callback (function) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_inline_handler(callback: Callable[[Any], Awaitable], func: Callable, pass_bot: bool | None = False, **kwargs)¶

Регистрирует хендлер inline query.

Параметры:

callback (Awaitable) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

декорируемая функция

register_managed_bot_handler(callback: Callable, func: Callable | None = None, pass_bot: bool | None = False, **kwargs)¶

Registers managed bot handler.

Параметры:

callback (function) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs (dict) – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

Регистрирует хендлер сообщений.

Параметры:

callback (Awaitable) – функция-хендлер
content_types (list of str) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]
commands (list of str) – список команд
regexp (str)
func (function) – Функция, используемая в качестве фильтра
chat_types (list of str) – Список видов чатов
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_message_reaction_count_handler(callback: Callable[[Any], Awaitable], func: Callable = None, pass_bot: bool | None = False, **kwargs)¶

Registers message reaction count handler.

Параметры:

callback (Awaitable) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_message_reaction_handler(callback: Callable[[Any], Awaitable], func: Callable = None, pass_bot: bool | None = False, **kwargs)¶

Registers message reaction handler.

Параметры:

callback (Awaitable) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_my_chat_member_handler(callback: Callable[[Any], Awaitable], func: Callable | None = None, pass_bot: bool | None = False, **kwargs)¶

Регистрирует хендлер изменений статуса бота.

Параметры:

callback (Awaitable) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_poll_answer_handler(callback: Callable[[Any], Awaitable], func: Callable, pass_bot: bool | None = False, **kwargs)¶

Регистрирует хендлер ответов в опросах.

Параметры:

callback (Awaitable) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_poll_handler(callback: Callable[[Any], Awaitable], func: Callable, pass_bot: bool | None = False, **kwargs)¶

Регистрирует хендлер изменений состояния опросов.

Параметры:

callback (Awaitable) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_pre_checkout_query_handler(callback: Callable[[Any], Awaitable], func: Callable, pass_bot: bool | None = False, **kwargs)¶

Регистрирует хендлер pre-checkout query.

Параметры:

callback (Awaitable) – функция-хендлер
func – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

декорируемая функция

register_purchased_paid_media_handler(callback: Callable, func: Callable, pass_bot: bool | None = False, **kwargs)¶

Registers purchased paid media handler.

Параметры:

callback (function) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_removed_chat_boost_handler(callback: Callable, func: Callable | None = None, pass_bot: bool | None = False, **kwargs)¶

Registers removed chat boost handler.

Параметры:

callback (function) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

register_shipping_query_handler(callback: Callable[[Any], Awaitable], func: Callable, pass_bot: bool | None = False, **kwargs)¶

Регистрирует хендлер shipping query.

Параметры:

callback (Awaitable) – функция-хендлер
func (function) – Функция, используемая в качестве фильтра
pass_bot (bool) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

async remove_business_account_profile_photo(business_connection_id: str, is_public: bool | None = None) → bool¶

Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#removebusinessaccountprofilephoto

Параметры:

business_connection_id (str) – Unique identifier of the business connection
is_public (bool) – Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account’s privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async remove_chat_verification(chat_id: int) → bool¶

Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#removechatverification

Параметры:: chat_id (int | str) – Уникальный id чата или username канала (в формате @channelusername)
Результат:: Возвращает True в случае успеха.
Тип результата:: bool

async remove_my_profile_photo() → bool¶

Use this method to remove the profile photo of the bot. Requires no parameters. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#removemyprofilephoto

Результат:: True в случае успеха.
Тип результата:: bool

async remove_user_verification(user_id: int) → bool¶

Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#removeuserverification

Параметры:: user_id (int) – Уникальный id сделавшего запрос пользователя
Результат:: Возвращает True в случае успеха.
Тип результата:: bool

async remove_webhook() → bool¶: Альтернатива delete_webhook, но использует set_webhook

removed_chat_boost_handler(func=None, **kwargs)¶

Handles new incoming chat boost state. it passes telebot.types.ChatBoostRemoved object.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

async reopen_forum_topic(chat_id: str | int, message_thread_id: int) → bool¶

Используйте этот метод, чтобы возобновить закрытый топик в супергруппе с топиками. Бот должен быть администратором чата и иметь права администратора can_manage_topics, кроме случаев, когда бот является создателем топика. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#reopenforumtopic

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
message_thread_id (int) – id топика для возобновления

Результат:

В случае успеха возвращается True.

Тип результата:

bool

async reopen_general_forum_topic(chat_id: int | str) → bool¶

Используйте этот метод, чтобы возобновить топик „General“ в супергруппе с топиками. Бот должен быть администратором чата и иметь права администратора can_manage_topics, кроме случаев, когда бот является создателем топика. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#reopengeneralforumtopic

Параметры:: chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)

async replace_managed_bot_token(user_id: int) → str¶

Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as String on success.

Telegram documentation: https://core.telegram.org/bots/api#replacemanagedbottoken

Параметры:: user_id (int) – User identifier of the managed bot whose token will be replaced
Результат:: Returns the new token as String on success.
Тип результата:: str

async replace_sticker_in_set(user_id: int, name: str, old_sticker: str, sticker: InputSticker) → bool¶

Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet,: then setStickerPositionInSet. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#replaceStickerInSet

Параметры:

user_id (int) – User identifier of the sticker set owner
name (str) – Имя стикерпака
old_sticker (str) – File identifier of the replaced sticker
sticker (telebot.types.InputSticker) – A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async reply_to(message: Message, text: str, **kwargs) → Message¶

Convenience function for send_message(message.chat.id, text, reply_parameters=(message.message_id…), **kwargs)

Параметры:

message (types.Message) – Экземпляр класса telebot.types.Message
text (str) – Текст сообщения.
kwargs – Дополнительные именованные аргументы, передаваемые в telebot.TeleBot.send_message()

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

async repost_story(business_connection_id: str, from_chat_id: int, from_story_id: int, active_period: int, post_to_chat_page: bool | None = None, protect_content: bool | None = None) → Story¶

Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the can_manage_stories business bot right for both business accounts. Returns Story on success.

Telegram documentation: https://core.telegram.org/bots/api#repoststory

Параметры:

business_connection_id (str) – Unique identifier of the business connection
from_chat_id (int) – Unique identifier of the chat which posted the story that should be reposted
from_story_id (int) – Unique identifier of the story that should be reposted
active_period (int) – Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400
post_to_chat_page (bool) – Pass True to keep the story accessible after it expires
protect_content (bool) – Pass True if the content of the story must be protected from forwarding and screenshotting

Результат:

On success, a Story object is returned.

Тип результата:

telebot.types.Story

async reset_data(user_id: int, chat_id: int | None = None, business_connection_id: str | None = None, message_thread_id: int | None = None, bot_id: int | None = None) → bool¶

Сбросить данные о пользователе в чате.

Параметры:

user_id (int) – id пользователя
chat_id (int) – id чата
bot_id (int) – Bot’s identifier, defaults to current bot id
business_connection_id (str) – Business identifier
message_thread_id (int) – Identifier of the message thread

Результат:

True в случае успеха

Тип результата:

bool

Используйте этот метод, чтобы ограничить пользователя в супергруппе. Бот должен быть администратором супергруппы и иметь соответствующие права администратора. Передайте True во все boolean параметры, чтобы снять с пользователя ограничения.

Документация Telegram: https://core.telegram.org/bots/api#restrictchatmember

Предупреждение

Individual parameters are deprecated and will be removed, use „permissions“ instead

Параметры:

chat_id (int or str) – Уникальный id группы или username супергруппы или канала (в формате @channelusername)
user_id (int) – Уникальный id сделавшего запрос пользователя
until_date (int or datetime, optional) – Дата, когда ограничения будут сняты с пользователя, UNIX timestamp. Если пользователь ограничен более чем на 366 дней или менее чем на 30 секунд с текущего момента, он будет ограничен навсегда (пока ограничения не будут сняты вручную)
can_send_messages (bool) – deprecated
can_send_media_messages (bool) – deprecated
can_send_polls (bool) – deprecated
can_send_other_messages (bool) – deprecated
can_add_web_page_previews (bool) – deprecated
can_change_info (bool) – deprecated
can_invite_users (bool) – deprecated
can_pin_messages (bool) – deprecated
use_independent_chat_permissions (bool, optional) – Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.
permissions (types.ChatPermissions) – Pass ChatPermissions object to set all permissions at once. Use this parameter instead of passing all boolean parameters to avoid backward compatibility problems in future.

Результат:

True в случае успеха

Тип результата:

bool

Возвращает контекстный менеджер с данными о пользователе в чате.

Параметры:

user_id (int) – id пользователя
chat_id (int, optional) – Уникальный id чата, по умолчанию user_id
bot_id (int, optional) – Bot’s identifier, defaults to current bot id
business_connection_id (str, optional) – Business identifier
message_thread_id (int, optional) – Identifier of the message thread

Результат:

Контекстный менеджер с данными о пользователе в чате.

Тип результата:

dict

async revoke_chat_invite_link(chat_id: int | str, invite_link: str) → ChatInviteLink¶

Используйте этот метод, чтобы аннулировать ссылку-приглашение, созданную ботом. Примечание: Если аннулируется главная ссылка-приглашение, автоматически генерируется новая. Бот должен быть администратором чата и иметь соответствующие права администратора.

Документация Telegram: https://core.telegram.org/bots/api#revokechatinvitelink

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
invite_link (str) – Ссылка-приглашение, которую нужно аннулировать

Результат:

Возвращает новую ссылку-приглашение (ChatInviteLink).

Тип результата:

telebot.types.ChatInviteLink

Этот класс устанавливает вебхуки и мониторит указанный URL и порт.

Параметры:

listen – IP адрес для мониторинга. По умолчанию 0.0.0.0
port – Порт, который будет использован для мониторинга вебхуков.
url_path – Путь к вебхуку. По умолчанию /token.
certificate – Путь к файлу с SSL сертификатом.
certificate_key – Путь к файлу с приватным ключом SSL сертификата.
webhook_url – URL вебхука.
max_connections – Максимально-допустимое количество одновременных HTTPS подключений к вебхуку для доставки апдейтов, 1-100. По умолчанию 40. Используйте меньшие значения, чтобы уменьшить нагрузку на ваш сервер и большие значения для увеличения пропускной способности вашего бота.
allowed_updates – Список видов апдейтов, которые вы хотите получать, в формате JSON. Например, укажите [“message”, “edited_channel_post”, “callback_query”], чтобы получать апдейты только этих видов. Полный список доступных видов апдейтов - util.update_types. Укажите пустой список, чтобы получать все апдейты, кроме chat_member (по умолчанию). Если не задан, будет использована последняя настройка.
ip_address – Фиксированный IP адрес, который будет использоваться для отправки запросов к вебхуку вместо IP адреса, полученного через DNS
drop_pending_updates – Передайте True, чтобы проигнорировать все апдейты, полученные до запуска
timeout – Integer. Тайм-аут запроса на подключение.
secret_token – Секретный токен для верификации запроса к вебхуку.
secret_token_length – Length of a secret token, defaults to 20
debug – Debug mode, defaults to False

Результат:

async save_prepared_inline_message(user_id: int, result: InlineQueryResultBase, allow_user_chats: bool | None = None, allow_bot_chats: bool | None = None, allow_group_chats: bool | None = None, allow_channel_chats: bool | None = None) → PreparedInlineMessage¶

Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.

Telegram Documentation: https://core.telegram.org/bots/api#savepreparedinlinemessage

Параметры:

user_id (int) – Unique identifier of the target user that can use the prepared message
result (telebot.types.InlineQueryResultBase) – Объект в формате JSON, описывающий сообщение, которое нужно отправить
allow_user_chats (bool, optional) – Pass True if the message can be sent to private chats with users
allow_bot_chats (bool, optional) – Pass True if the message can be sent to private chats with bots
allow_group_chats (bool, optional) – Pass True if the message can be sent to group and supergroup chats
allow_channel_chats (bool, optional) – Pass True if the message can be sent to channel chats

Результат:

telebot.types.PreparedInlineMessage

async save_prepared_keyboard_button(user_id: int, button: KeyboardButton) → PreparedKeyboardButton¶

Stores a keyboard button that can be used by a user within a Mini App. Returns a PreparedKeyboardButton object.

Telegram Documentation: https://core.telegram.org/bots/api#savepreparedkeyboardbutton

Параметры:

user_id (int) – Unique identifier of the target user that can use the button
button (telebot.types.KeyboardButton) – A JSON-serialized object describing the button to be saved. The button must be of the type request_users, request_chat, or request_managed_bot

Результат:

telebot.types.PreparedKeyboardButton

Используйте этот метод, чтобы отправить гифку (GIF или H.264/MPEG-4 AVC видео без звука). В случае успеха, возвращается отправленное сообщение (Message). На текущий момент, боты могут отправлять гифки весом до 50 MB, это ограничение может измениться в будущем.

Документация Telegram: https://core.telegram.org/bots/api#sendanimation

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
animation (str or telebot.types.InputFile) – Гиф-ка для отправки. Передайте file_id (String), чтобы отправить гифку, которая уже загружена на сервера Telegram (рекомендуется), передайте HTTP URL (String), чтобы отправить гифку из интернета или загрузите новую гифку с помощью multipart/form-data.
duration (int) – Длительность отправленной гифки в секундах
width (int) – Ширина гифки
height (int) – Высота гифки
thumbnail (str or telebot.types.InputFile) – Обложка отправленного файла; может быть проигнорирована, если генерация обложки поддерживается на стороне сервера. Обложка должна быть картинкой в формате JPEG и весить менее 200 kB. Ширина и высота обложки не должны превышать 320. Игнорируется, если файл не загружен с помощью multipart/form-data. Обложки не могут быть использованы повторно и могут быть загружены только как новый файл, так что вы можете передать “attach://<file_attach_name>” если обложка была загружена с помощью multipart/form-data под именем <file_attach_name>.
caption (str) – Подпись к гифке (может быть использована при повторной отправке гифки по file_id), 0-1024 символа после форматирования
parse_mode (str) – Режим форматирования подписи к гифке
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
timeout (int) – Таймаут запроса в секундах.
caption_entities (list of telebot.types.MessageEntity) – Список отформатированных частей подписи, можно использовать вместо parse_mode
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
message_thread_id (int) – id топика, в который будет отправлено видео
has_spoiler (bool) – Передайте True, если гифку нужно отправить как спойлер
thumb (str or telebot.types.InputFile) – Deprecated. Use thumbnail instead
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Identifier of a business connection, in which the message will be sent
message_effect_id (str) – Unique identifier of the message effect
show_caption_above_media (bool) – Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Используйте этот метод, чтобы отправить аудио, если вы хотите, чтобы клиенты (приложения) Telegram проигрывали их в музыкальном проигрывателе. Ваше аудио должно быть в формате .MP3 или .M4A. В случае успеха, возвращается отправленное сообщение (Message). На текущий момент, боты могут отправлять аудио весом до 50 MB, это ограничение может измениться в будущем.

Для отправки голосовых сообщений, используйте метод send_voice

Документация Telegram: https://core.telegram.org/bots/api#sendaudio

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
audio (str or telebot.types.InputFile) – Аудио для отправки. Передайте file_id (String), чтобы отправить аудио, которое уже загружено на сервера Telegram (рекомендуется), передайте HTTP URL (String), чтобы отправить аудио из интернета или загрузите новое с помощью multipart/form-data. Аудио должно быть в формате .MP3 или .M4A.
caption (str) – Подпись к аудио, 0-1024 символа после форматирования
duration (int) – Длительность аудио в секундах
performer (str) – Исполнитель
title (str) – Название трека
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply)
parse_mode (str) – Режим форматирования подписи к аудио. См. formatting options для получения подробностей.
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
timeout (int) – Таймаут запроса в секундах.
thumbnail (str or telebot.types.InputFile) – Обложка отправленного файла; может быть проигнорирована, если генерация обложки поддерживается на стороне сервера. Обложка должна быть картинкой в формате JPEG и весить менее 200 kB. Ширина и высота обложки не должны превышать 320. Игнорируется, если файл не загружен с помощью multipart/form-data. Обложки не могут быть использованы повторно и могут быть загружены только как новый файл, так что вы можете передать “attach://<file_attach_name>” если обложка была загружена с помощью multipart/form-data под именем <file_attach_name>.
caption_entities (list of telebot.types.MessageEntity) – Список отформатированных частей подписи в формате JSON, можно использовать вместо parse_mode
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
message_thread_id (int) – id топика, в который нужно отправить сообщение
thumb (str or telebot.types.InputFile) – Deprecated. Use thumbnail instead
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Unique identifier for the target business connection
message_effect_id (str) – Unique identifier for the message effect
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

async send_chat_action(chat_id: int | str, action: str, timeout: int | None = None, message_thread_id: int | None = None, business_connection_id: str | None = None) → bool¶

Используйте этот метод, когда вам нужно показать пользователю, что бот что-то делает. Статус устанавливается на 5 секунд или менее (когда от бота приходит сообщение, клиенты (приложения) Telegram убирают статус typing). Возвращает True в случае успеха.

Пример: ImageBot-у требуется время, чтобы обработать запрос и загрузить изображение. Вместо отправки текстового сообщения “Отправка изображения, пожалуйста подождите…”, бот может использовать sendChatAction с параметром action = upload_photo. Пользователь увидит статус бота “sending photo”.

Документация Telegram: https://core.telegram.org/bots/api#sendchataction

Параметры:

chat_id (int or str) – Уникальный id чата или username канала
action (str) – Тип действия. Выберите один, в зависимости от того, что получит пользователь: typing для текстовых сообщений, upload_photo для фото, record_video или upload_video для видео, record_voice или upload_voice для голосовых сообщений, upload_document для файлов, choose_sticker для стикеров, find_location для данных о местоположении, record_video_note или upload_video_note для видео заметок (кружочков).
timeout (int) – Таймаут запроса в секундах.
message_thread_id (int) – The thread to which the message will be sent(supergroups and private chats only)
business_connection_id (str) – Identifier of a business connection, in which the message will be sent

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async send_checklist(business_connection_id: str, chat_id: int | str, checklist: InputChecklist, disable_notification: bool | None = None, protect_content: bool | None = None, message_effect_id: str | None = None, reply_parameters: ReplyParameters | None = None, reply_markup: InlineKeyboardMarkup | None = None) → Message¶

Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.

Telegram documentation: https://core.telegram.org/bots/api#sendchecklist

Параметры:

business_connection_id (str) – Unique identifier of the business connection on behalf of which the message will be sent
chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
checklist (telebot.types.InputChecklist) – A JSON-serialized object for the checklist to send
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
message_effect_id (str) – Unique identifier of the message effect to be added to the message; for private chats only
reply_parameters (telebot.types.ReplyParameters) – Additional parameters for replies to messages
reply_markup (telebot.types.InlineKeyboardMarkup) – Additional interface options. A JSON-serialized object for an inline keyboard.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Используйте этот метод, чтобы отправить контакт. В случае успеха, возвращается отправленное сообщение (Message).

Документация Telegram: https://core.telegram.org/bots/api#sendcontact

Параметры:

chat_id (int or str) – Уникальный id чата или username канала
phone_number (str) – Телефонный номер контакта
first_name (str) – Имя контакта
last_name (str) – Фамилия контакта
vcard (str) – Дополнительные данные о контакте в формате vCard, 0-2048 байт
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
timeout (int) – Таймаут запроса в секундах.
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if one of the specified replied-to messages is not found.
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
message_thread_id (int) – Топик, в который сообщение будет отправлено
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Identifier of a business connection, in which the message will be sent
message_effect_id (str) – Unique identifier of the message effect
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Используйте этот метод, чтобы отправить анимированный эмодзи, который покажет случайное значение. В случае успеха, возвращается отправленное сообщение (Message).

Документация Telegram: https://core.telegram.org/bots/api#senddice

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
emoji (str) – Эмодзи, на котором основана анимация. На текущий момент, должно быть одним из “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, или “🎰”. Значение может быть 1-6 для “🎲”, “🎯” и “🎳”, 1-5 для “🏀” и “⚽”, и 1-64 для “🎰”. По умолчанию “🎲”
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
timeout (int) – Таймаут запроса в секундах.
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
protect_content (bool) – Защищает содержимое отправленного сообщения от пересылки
message_thread_id (int) – id топика, в который сообщение будет отправлено
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Unique identifier for the target business connection
message_effect_id (str) – Unique identifier for the message effect
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Используйте этот метод, чтобы отправить файл.

Документация Telegram: https://core.telegram.org/bots/api#senddocument

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
document (str or telebot.types.InputFile) – (документ) Файл для отправки. Передайте file_id (String), чтобы отправить файл, который уже загружен на сервера Telegram (рекомендуется), передайте HTTP URL (String), чтобы отправить файл из интернета или загрузите новый с помощью multipart/form-data
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
caption (str) – Подпись к файлу (может быть использована при повторной отправке файла по file_id), 0-1024 символа после форматирования
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
parse_mode (str) – Режим форматирования частей подписи к файлу
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
timeout (int) – Таймаут запроса в секундах.
thumbnail (str or telebot.types.InputFile) – InputFile или String : Обложка отправленного файла; может быть проигнорирована, если генерация обложки поддерживается на стороне сервера. Обложка должна быть картинкой в формате JPEG и весить менее 200 kB. Ширина и высота обложки не должны превышать 320. Игнорируется, если файл не загружен с помощью multipart/form-data. Обложки не могут быть использованы повторно и могут быть загружены только как новый файл, так что вы можете передать “attach://<file_attach_name>” если обложка была загружена с помощью multipart/form-data под именем <file_attach_name>.
caption_entities (list of telebot.types.MessageEntity) – Список отформатированных частей подписи в формате JSON, можно использовать вместо parse_mode
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
visible_file_name (str) – позволяет задать имя файла, которое будет показано в Telegram вместо настоящего
disable_content_type_detection (bool) – Отключает автоматическое обнаружение типа файла на стороне сервера для файлов, загруженных с помощью multipart/form-data
data (str) – опечатка: не используйте
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
message_thread_id (int) – id топика, в который нужно отправить сообщение
thumb (str or telebot.types.InputFile) – Deprecated. Use thumbnail instead
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Unique identifier for the target business connection
message_effect_id (str) – Unique identifier for the message effect
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Используется для отправки игры.

Документация Telegram: https://core.telegram.org/bots/api#sendgame

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
game_short_name (str) – Короткое имя игры, служит в качестве уникального id игры. Настройте свои игрычерез @BotFather.
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
reply_markup (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
timeout (int) – Тайм-аут в секундах, ожидание ответа от бота.
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if one of the specified replied-to messages is not found.
protect_content (bool) – Передайте True, если содержимое сообщение должно быть защищено от просмотра ботом.
message_thread_id (int) – id топика, в которые будет сообщение будет отправлено.
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Identifier of the business connection.
message_effect_id (str) – Identifier of the message effect.
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

types.Message

Sends a gift to the given user. The gift can’t be converted to Telegram Stars by the user. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#sendgift

Параметры:

gift_id (str) – Identifier of the gift
user_id – Required if chat_id is not specified. Unique identifier of the target user who will receive the gift.

:type user_id:int | str

Параметры:

chat_id (int | str) – Required if user_id is not specified. Unique identifier for the chat or username of the channel (in the format @channelusername) that will receive the gift.
pay_for_upgrade (bool) – Pass True to pay for the gift upgrade from the bot’s balance, thereby making the upgrade free for the receiver
text (str) – Text that will be shown along with the gift; 0-255 characters
text_parse_mode (str) – Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
text_entities (list of types.MessageEntity) – A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

Отправляет инвойс.

Документация Telegram: https://core.telegram.org/bots/api#sendinvoice

Параметры:

chat_id (int or str) – Уникальный id приватного чата
title (str) – Название товара, 1-32 символа
description (str) – Описание товара, 1-255 символов
invoice_payload (str) – Дополнительные данные, 1-128 байт. Не будет показано пользователю, используйте во внутренних процессах.
provider_token (str) – Payments provider token, obtained via @Botfather; Pass None to omit the parameter to use «XTR» currency
currency (str) – Трехбуквенный код валюты в формате ISO 4217, см. https://core.telegram.org/bots/payments#supported-currencies
prices (List[types.LabeledPrice]) – Детали цены, список компонент (например цена продукта, налог, скидка, стоимость доставки, налог на доставку, бонус и т.д.)
start_parameter (str) – Уникальный deep-linking параметр, который может быть использован для генерации этого инвойса при использовании в качестве параметра /start
photo_url (str) – URL фото продукта. Может быть фото товаров или рекламным изображением сервиса. Людям больше нравится, когда они видят, за что платят.
photo_size (int) – Вес изображения в байтах
photo_width (int) – Ширина изображения
photo_height (int) – Высота изображения
need_name (bool) – Передайте True, если для совершения заказа требуется полное имя пользователя
need_phone_number (bool) – Передайте True, если для совершения заказа требуется номер телефона пользователя
need_email (bool) – Передайте True, если для совершения заказа требуется email пользователя
need_shipping_address (bool) – Передайте True, если для совершения заказа требуется адрес доставки
is_flexible (bool) – Передайте True, если окончательная цена зависит от способа доставки
send_phone_number_to_provider (bool) – Передайте True, если номер телефона пользователя нужно отправить платежной системе
send_email_to_provider (bool) – Передайте True, если email пользователя нужно отправить платежной системе
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
reply_markup (str) – JSON-сериализованный объект inline клавиатуры. Если пустой, будет показана одна кнопка „Pay total price“. Если не пустой, первая кнопка должна быть кнопкой для оплаты
provider_data (str) – Данные о инвойсе в формате JSON, которые будут переданы платежной системе. Подробное описание обязательных полей должно быть предоставлено провайдером платежной системы.
timeout (int) – Тайм-аут запроса, по умолчанию None
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
max_tip_amount (int) – Максимальный размер чаевых в наименьших единицах выбранной валюты
suggested_tip_amounts (list of int) – Массив предлагаемых вариантов чаевых в наименьших единицах выбранной валюты в формате JSON. Можно задать не более 4 вариантов. Варианты чаевых должны быть больше нуля, перечисленные в порядке строгого возрастания и не превышать max_tip_amount.
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
message_thread_id (int) – id топика, в который будет отправлен инвойс
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
message_effect_id (str) – The identifier of a message effect to be applied to the message
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

types.Message

Use this method to send live photos. On success, the sent Message is returned.

Telegram documentation: https://core.telegram.org/bots/api#sendlivephoto

Параметры:

message_thread_id (int) – id топика, в который нужно отправить сообщение
business_connection_id (str) – Unique identifier of the business connection on behalf of which the message will be sent
chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
live_photo (str or telebot.types.InputFile) – Live photo video to send. The video must be no longer than 10 seconds and must not exceed 10 MB in size. Pass a file_id as String to send a video that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
photo (str or telebot.types.InputFile) – The static photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
caption (str) – Подпись к видео (может быть использована при повторной отправке файла по file_id), 0-1024 символа после форматирования
parse_mode (str) – Mode for parsing entities in the video caption. See formatting options for more details.
caption_entities (list of telebot.types.MessageEntity) – Список отформатированных частей подписи в формате JSON, можно использовать вместо parse_mode
show_caption_above_media (bool) – Pass True, if the caption must be shown above the message media
has_spoiler (bool) – Pass True if the video needs to be covered with a spoiler animation
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.
message_effect_id (str) – Unique identifier of the message effect to be added to the message; for private chats only
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined
reply_parameters (telebot.types.ReplyParameters) – Additional parameters for replies to messages
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Используйте этот метод, чтобы отправить точку на карте. В случае успеха, возвращается отправленное сообщение (Message).

Документация Telegram: https://core.telegram.org/bots/api#sendlocation

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
latitude (float) – Широта
longitude (float) – Долгота
live_period (int) – Period in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
timeout (int) – Таймаут запроса в секундах.
horizontal_accuracy (float) – Радиус погрешности местоположения, измеряется в метрах; 0-1500
heading (int) – Для live местоположений, направление, в котором пользователь двигается, в градусах. Должно быть между 1 и 360, если указано.
proximity_alert_radius (int) – Для live местоположений, максимальное расстояние для уведомлений о приближении другого участника чата, в метрах. Должно быть между 1 и 100000, если указано.
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
message_thread_id (int) – id топика, в который нужно отправить сообщение
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Identifier of a business connection, in which the message will be sent
message_effect_id (str) – Unique identifier of the message effect
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Используйте этот метод, чтобы отправить группу фото, видео, файлов или аудио как альбом. Файлы и аудио могут быть сгруппированы в альбом только с сообщениями того же типа. В случае успеха, возвращается массив отправленных сообщений (Message).

Документация Telegram: https://core.telegram.org/bots/api#sendmediagroup

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
media (list of types.InputMedia) – JSON-сериализованный массив, описывающий сообщения для отправки, должен включать от 2 до 10 элементов
disable_notification (bool) – Отправить сообщение, при получении которого пользователя пользователи получат уведомление без звука.
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
timeout (int) – Таймаут запроса в секундах.
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
message_thread_id (int) – id топика, в который будет отправлена группа медиа
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Identifier of a business connection, in which the message will be sent
message_effect_id (str) – Unique identifier of the message effect
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

Результат:

В случае успеха, возвращается массив отправленных сообщений (Message).

Тип результата:

List[types.Message]

Используйте этот метод, чтобы отправлять текстовые сообщения.

Предупреждение: Не отправляйте больше 4096 символов в одном сообщении, иначе вы рискуете получить ошибку HTTP 414. Если вам нужно отправить больше 4096 символов, используйте функцию split_string или smart_split из util.py.

Документация Telegram: https://core.telegram.org/bots/api#sendmessage

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
text (str) – Текст сообщения для отправки
parse_mode (str) – Режим форматирования в тексте сообщения.
entities (Array of telebot.types.MessageEntity) – Список отформатированных частей в тексте сообщения, можно использовать вместо parse_mode
disable_web_page_preview (bool) – Deprecated - Use link_preview_options instead.
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
protect_content (bool) – Если True, содержимое сообщения будет скрыто от всех пользователей, кроме заданного
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
timeout (int) – Таймаут запроса в секундах.
message_thread_id (int) – Уникальный id топика, в который нужно переслать сообщение; только для супергрупп с топиками
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
link_preview_options (telebot.types.LinkPreviewOptions) – Options for previewing links.
business_connection_id (str) – Unique identifier for the target business connection
message_effect_id (str) – Unique identifier for the message effect
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

async send_message_draft(chat_id: int, draft_id: int, text: str, message_thread_id: int | None = None, parse_mode: str | None = None, entities: List[MessageEntity] | None = None)¶

Use this method to stream a partial message to a user while the message is being generated; available for all bots. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#sendmessagedraft

Параметры:

chat_id (int) – Уникальный id приватного чата
message_thread_id (int) – Unique identifier for the target message thread
draft_id (int) – Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated
text (str) – Text of the message to be sent, 0-4096 characters after entities parsing. Pass an empty text to show a “Thinking…” placeholder.
parse_mode (str) – Mode for parsing entities in the message text. See formatting options for more details.
entities (list of :class:`telebot.types.MessageEntity) – A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

Use this method to send paid media to channel chats. On success, the sent Message is returned.

Telegram documentation: https://core.telegram.org/bots/api#sendpaidmedia

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
star_count (int) – The number of Telegram Stars that must be paid to buy access to the media
media (list of telebot.types.InputPaidMedia) – A JSON-serialized array describing the media to be sent; up to 10 items
caption (str) – Media caption, 0-1024 characters after entities parsing
parse_mode (str) – Mode for parsing entities in the media caption
caption_entities (list of telebot.types.MessageEntity) – Список отформатированных частей подписи, можно использовать вместо parse_mode
show_caption_above_media (bool) – Pass True, if the caption must be shown above the message media
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
reply_parameters (telebot.types.ReplyParameters) – Description of the message to reply to
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user
business_connection_id (str) – Identifier of a business connection, in which the message will be sent
payload (str) – Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Используйте этот метод, чтобы отправить фото. В случае успеха, возвращается отправленное сообщение (Message).

Документация Telegram: https://core.telegram.org/bots/api#sendphoto

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
photo (str or telebot.types.InputFile) – Фото для отправки. Передайте file_id (String), чтобы отправить фото, которое уже загружено на сервера Telegram (рекомендуется), передайте HTTP URL (String), чтобы отправить фото из интернета или загрузите новое с помощью multipart/form-data. Фото должно весить не более 10 MB. Ширина и высота фото не должны суммарно превышать 10000. Отношение ширины и высоты должно быть не более 20.
caption (str) – Подпись к фото (может быть использована при повторной отправке файла по file_id), 0-1024 символа после форматирования
parse_mode (str) – Режим форматирования подписи к фото.
caption_entities (list of telebot.types.MessageEntity) – Список отформатированных частей подписи в формате JSON, можно использовать вместо parse_mode
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
timeout (int) – Таймаут запроса в секундах.
message_thread_id (int) – id топика, в который нужно отправить сообщение
has_spoiler (bool) – Передайте True, если фото должно быть отправлено как спойлер
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Unique identifier for the target business connection
message_effect_id (str) – Unique identifier for the message effect
show_caption_above_media (bool) – Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Используйте этот метод, чтобы отправить опрос. В случае успеха, возвращается отправленное сообщение (Message).

Документация Telegram: https://core.telegram.org/bots/api#sendpoll

Параметры:

chat_id (int | str) – Уникальный id чата или username канала
question (str) – Тема опроса, 1-300 символов
options (list of InputPollOption | list of str) – A JSON-serialized list of 2-10 answer options
is_anonymous (bool) – True, если опрос должен быть анонимным, по умолчанию True
type (str) – Вид опроса, “quiz” или “regular”, по умолчанию “regular”
allows_multiple_answers (bool) – True, if the poll allows multiple answers, defaults to False
correct_option_id (int) – Deprecated, use correct_option_ids instead. defaults to None
explanation (str) – Текст, который будет показан при выборе неправильно варианта ответа или нажатии на иконку лампочки в опросах вида “quiz”, 0-200 символов и не более 2 строк после форматирования
explanation_parse_mode (str) – Режим форматирования explanation. См. formatting options для получения подробностей.
open_period (int) – Amount of time in seconds the poll will be active after creation, 5-2628000. Can’t be used together with close_date.
close_date (int | datetime) – Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can’t be used together with open_period.
is_closed (bool) – Передайте True, если опрос должен быть завершен немедленно. Может быть полезно для предпросмотра опроса.
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the poll allows multiple options to be voted simultaneously.
reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
timeout (int) – Тайм-аут в секундах, ожидание ответа от пользователя.
explanation_entities (list of MessageEntity) – JSON-сериализованный список отформатированных частей explanation, можно использовать вместо parse_mode
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
message_thread_id (int) – id топика, в который будет отправлен опрос
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Identifier of the business connection to send the message through
question_parse_mode (str) – Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed
question_entities (list of MessageEntity) – A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode
message_effect_id (str) – Identifier of the message effect to apply to the sent message
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
allows_revoting (bool) – Pass True, if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls
shuffle_options (bool) – Pass True, if the poll options must be shown in random order
allow_adding_options (bool) – Pass True, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes
hide_results_until_closes (bool) – Pass True, if poll results must be shown only after the poll closes
members_only (bool) – Pass True, if voting is limited to users who have been members of the chat where the poll is being sent for more than 24 hours; for channel chats only
country_codes – A JSON-serialized list of 0-12 two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which users can vote in the poll;

for channel chats only. If omitted or empty, then users from any country can participate in the poll. :type country_codes: list of str

Параметры:

correct_option_ids (list of int) – A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode
description (str) – Description of the poll to be sent, 0-1024 characters after entities parsing
description_parse_mode (str) – Mode for parsing entities in the poll description. See formatting options for more details.
description_entities (list of MessageEntity) – A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of description_parse_mode
media (types.InputPollMedia) – Media added to the poll description
explanation_media (types.InputPollMedia) – Media added to the quiz explanation

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

types.Message

Используйте этот метод, чтобы отправить статичный .WEBP, анимированный .TGS, или видео .WEBM стикер. В случае успеха возвращает отправленное сообщение (Message).

Документация Telegram: https://core.telegram.org/bots/api#sendsticker

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
sticker (str or telebot.types.InputFile) – Стикер для отправки. Передайте file_id (String), чтобы отправить файл, который уже загружен на сервера Telegram (рекомендуется), передайте HTTP URL (String), чтобы отправить .webp файл из интернета или загрузите новый с помощью multipart/form-data.
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
disable_notification (bool) – отключить уведомление
timeout (int) – Таймаут запроса в секундах.
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
data (str) – опечатка: не используйте
message_thread_id (int) – id топика, в который нужно отправить сообщение
emoji (str) – Emoji associated with the sticker; only for just uploaded stickers
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Unique identifier for the target business connection
message_effect_id (str) – Unique identifier for the message effect
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Используйте этот метод, чтобы отправить информацию о месте. В случае успеха возвращается отправленное сообщение (Message).

Документация Telegram: https://core.telegram.org/bots/api#sendvenue

Параметры:

chat_id (int or str) – Уникальный id чата или username канала
latitude (float) – Широта
longitude (float) – Долгота
title (str) – Название места
address (str) – Адрес места
foursquare_id (str) – id места на Foursquare
foursquare_type (str) – Тип места на Foursquare, если известен. (Например, “arts_entertainment/default”, “arts_entertainment/aquarium” или “food/icecream”.)
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
timeout (int) – Таймаут запроса в секундах.
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if one of the specified replied-to messages is not found.
google_place_id (str) – id места на Google Places
google_place_type (str) – Тип места на Google Places.
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
message_thread_id (int) – Топик, в который сообщение будет отправлено
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Identifier of a business connection, in which the message will be sent
message_effect_id (str) – Unique identifier of the message effect
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Используйте этот метод, чтобы отправить видео, клиенты (приложения) Telegram поддерживают mp4 видео (другие форматы могут быть отправлены как Document).

Документация Telegram: https://core.telegram.org/bots/api#sendvideo

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
video (str or telebot.types.InputFile) – Видео для отправки. Передайте file_id (String), чтобы отправить видео, которое уже загружено на сервера Telegram или загрузите новое с помощью multipart/form-data.
duration (int) – Длительность отправленного видео в секундах
width (int) – Ширина видео
height (int) – Высота видео
thumbnail (str or telebot.types.InputFile) – Обложка отправленного файла; может быть проигнорирована, если генерация обложки поддерживается на стороне сервера. Обложка должна быть картинкой в формате JPEG и весить менее 200 kB. Ширина и высота обложки не должны превышать 320. Игнорируется, если файл не загружен с помощью multipart/form-data. Обложки не могут быть использованы повторно и могут быть загружены только как новый файл, так что вы можете передать “attach://<file_attach_name>” если обложка была загружена с помощью multipart/form-data под именем <file_attach_name>.
cover (str or telebot.types.InputFile) – Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
start_timestamp (int) – Start timestamp for the video in the message
caption (str) – Подпись к видео (может быть использована при повторной отправке файла по file_id), 0-1024 символа после форматирования
parse_mode (str) – Режим форматирования подписи к видео
caption_entities (list of telebot.types.MessageEntity) – Список отформатированных частей подписи, можно использовать вместо parse_mode
supports_streaming (bool) – Передайте True, если загруженное видео подходит для стриминга
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
timeout (int) – Таймаут запроса в секундах.
data (str) – опечатка: не используйте
message_thread_id (int) – id топика, в который будет отправлено видео
has_spoiler (bool) – Передайте True, если видео должно быть отправлено как спойлер
thumb (str or telebot.types.InputFile) – Deprecated. Use thumbnail instead
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Identifier of a business connection, in which the message will be sent
message_effect_id (str) – Unique identifier of the message effect
show_caption_above_media (bool) – Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of a topic in a forum supergroup or channel, in which the message will be sent
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Начиная с версии v.4.0, клиенты(приложения) Telegram поддерживают скругленные квадратные MPEG4 видео длительностью до минуты. Используйте этот метод, чтобы отправить видео заметку (кружочек). В случае успеха возвращается отправленное сообщение (Message).

Документация Telegram: https://core.telegram.org/bots/api#sendvideonote

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
data (str or telebot.types.InputFile) – Видео заметка для отправки. Передайте file_id (String), чтобы отправить видео заметку, которая уже загружена на сервера Telegram или загрузите новую с помощью multipart/form-data. На текущий момент, отправка видео заметок по URL не поддерживается
duration (int) – Длительность отправленного видео в секундах
length (int) – Ширина и высота видео (диаметр видео сообщения)
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
timeout (int) – Таймаут запроса в секундах.
thumbnail (str or telebot.types.InputFile) – Обложка отправленного файла; может быть проигнорирована, если генерация обложки поддерживается на стороне сервера. Обложка должна быть картинкой в формате JPEG и весить менее 200 kB. Ширина и высота обложки не должны превышать 320. Игнорируется, если файл не загружен с помощью multipart/form-data. Обложки не могут быть использованы повторно и могут быть загружены только как новый файл, так что вы можете передать “attach://<file_attach_name>” если обложка была загружена с помощью multipart/form-data под именем <file_attach_name>.
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
message_thread_id (int) – id топика, в который будет отправлена видео заметка
thumb (str or telebot.types.InputFile) – Deprecated. Use thumbnail instead
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Identifier of a business connection, in which the message will be sent
message_effect_id (str) – Unique identifier of the message effect
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

Тип результата:

telebot.types.Message

Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

Документация Telegram: https://core.telegram.org/bots/api#sendvoice

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
voice (str or telebot.types.InputFile) – Аудио для отправки. Передайте file_id (String), чтобы отправить аудио, которое уже загружено на сервера Telegram (рекомендуется), передайте HTTP URL (String), чтобы отправить аудио из интернета или загрузите новое с помощью multipart/form-data.
caption (str) – Подпись к голосовому сообщению, 0-1024 символа после форматирования
duration (int) – Длительность голосового сообщения в секундах
reply_to_message_id (int) – Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.
parse_mode (str) – Режим форматирования подписи к голосовому сообщению. См. formatting options для получения подробностей.
disable_notification (bool) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.
timeout (int) – Таймаут запроса в секундах.
caption_entities (list of telebot.types.MessageEntity) – Список отформатированных частей подписи в формате JSON, можно использовать вместо parse_mode
allow_sending_without_reply (bool) – Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
protect_content (bool) – Запретить пересылку и сохранение содержимого сообщения
message_thread_id (int) – id топика, в который нужно отправить сообщение
reply_parameters (telebot.types.ReplyParameters) – Reply parameters.
business_connection_id (str) – Unique identifier for the target business connection
message_effect_id (str) – Unique identifier for the message effect
allow_paid_broadcast (bool) – Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
direct_messages_topic_id (int) – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
suggested_post_parameters (telebot.types.SuggestedPostParameters) – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Результат:

В случае успеха возвращает отправленное сообщение (Message).

async set_business_account_bio(business_connection_id: str, bio: str | None = None) → bool¶

Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#setbusinessaccountbio

Параметры:

business_connection_id (str) – Unique identifier of the business connection
bio (str) – The new value of the bio for the business account; 0-140 characters

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async set_business_account_gift_settings(business_connection_id: str, show_gift_button: bool, accepted_gift_types: AcceptedGiftTypes) → bool¶

Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#setbusinessaccountgiftsettings

Параметры:

business_connection_id (str) – Unique identifier of the business connection
show_gift_button (bool) – Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field
accepted_gift_types (telebot.types.AcceptedGiftTypes) – Types of gifts accepted by the business account

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async set_business_account_name(business_connection_id: str, first_name: str, last_name: str | None = None) → bool¶

Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#setbusinessaccountname

Параметры:

business_connection_id (str) – Unique identifier of the business connection
first_name (str) – The new value of the first name for the business account; 1-64 characters
last_name (str) – The new value of the last name for the business account; 0-64 characters

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async set_business_account_profile_photo(business_connection_id: str, photo: InputProfilePhoto, is_public: bool | None = None) → bool¶

Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#setbusinessaccountprofilephoto

Параметры:

business_connection_id (str) – Unique identifier of the business connection
photo (telebot.types.InputProfilePhoto) – The new profile photo to set
is_public (bool) – Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account’s privacy settings. An account can have only one public photo.

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async set_business_account_username(business_connection_id: str, username: str | None = None) → bool¶

Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#setbusinessaccountusername

Параметры:

business_connection_id (str) – Unique identifier of the business connection
username (str) – The new value of the username for the business account; 0-32 characters

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async set_chat_administrator_custom_title(chat_id: int | str, user_id: int, custom_title: str) → bool¶

Используйте этот метод, чтобы задать кастомное звание администратора супергруппы, повышенного ботом. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#setchatadministratorcustomtitle

Параметры:

chat_id (int or str) – Уникальный id чата или username супергруппы (в формате @supergroupusername)
user_id (int) – Уникальный id сделавшего запрос пользователя
custom_title (str) – Новое кастомное звание администратора; 0-16 символов, эмодзи не разрешены

Результат:

True в случае успеха.

Тип результата:

bool

async set_chat_description(chat_id: int | str, description: str | None = None) → bool¶

Используйте этот метод, чтобы изменить описание супергруппы или канала. Бот должен быть администратором чата и иметь соответствующие права администратора.

Документация Telegram: https://core.telegram.org/bots/api#setchatdescription

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
description (str) – Str: Новое описание чата, 0-255 символов

Результат:

True в случае успеха.

Тип результата:

bool

async set_chat_member_tag(chat_id: int | str, user_id: int, tag: str | None = None) → bool¶

Use this method to set a new tag for a member in a chat. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#setchatmembertag

Параметры:

chat_id (int or str) – Уникальный id чата или username супергруппы (в формате @supergroupusername)
user_id (int) – Уникальный id сделавшего запрос пользователя
tag (str) – New tag for the member; pass an empty string to remove the tag

Результат:

True в случае успеха.

Тип результата:

bool

async set_chat_menu_button(chat_id: int | str = None, menu_button: MenuButton = None) → bool¶

Используйте этот метод, чтобы изменить кнопку меню в приватном чате или кнопку меню по умолчанию. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#setchatmenubutton

Параметры:

chat_id (int or str) – Уникальный id приватного чата. Если не указан, будет изменена кнопка меню по умолчанию.
menu_button (telebot.types.MenuButton) – JSON-сериализованный объект новой кнопки меню. По умолчанию MenuButtonDefault

Результат:

True в случае успеха.

Тип результата:

bool

async set_chat_permissions(chat_id: int | str, permissions: ChatPermissions, use_independent_chat_permissions: bool | None = None) → bool¶

Используйте этот метод, чтобы задать права по умолчанию для всех участников чата. Бот должен быть администратором группы или супергруппы и иметь права администратора can_restrict_members.

Документация Telegram: https://core.telegram.org/bots/api#setchatpermissions

Параметры:

chat_id (int or str) – Уникальный id чата или username супергруппы (в формате @supergroupusername)
permissions (telebot.types..ChatPermissions) – Новые права по умолчанию
use_independent_chat_permissions (bool) – Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.

Результат:

True в случае успеха

Тип результата:

bool

async set_chat_photo(chat_id: int | str, photo: Any) → bool¶

Используйте этот метод, чтобы задать новую аватарку чата. В приватных чатах аватарки менять нельзя. Бот должен быть администратором чата и иметь соответствующие права администратора. Возвращает True в случае успеха. Примечание: В обычных группах (не супергруппы), этот метод будет работать только если настройка ‘All Members Are Admins’ отключена.

Документация Telegram: https://core.telegram.org/bots/api#setchatphoto

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
photo (typing.Union[file_like, str]) – InputFile: Новая аватарка чата, загруженная с помощью multipart/form-data

Результат:

True в случае успеха.

Тип результата:

bool

async set_chat_sticker_set(chat_id: int | str, sticker_set_name: str) → StickerSet¶

Используйте этот метод, чтобы задать стикерпак супергруппы. Бот должен быть администратором чата и иметь соответствующие права администратора. Используйте атрибут can_set_sticker_set, возвращаемые методом getChat, чтобы проверить, что бот может использовать этот метод. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#setchatstickerset

Параметры:

chat_id (int or str) – Уникальный id чата или username супергруппы (в формате @supergroupusername)
sticker_set_name (str) – Имя стикерпака для установки в качестве стикерпака группы

Результат:

Объект StickerSet

Тип результата:

telebot.types.StickerSet

async set_chat_title(chat_id: int | str, title: str) → bool¶

Используйте этот метод, чтобы изменить название чата. В приватных чатах изменить название нельзя. Бот должен быть администратором чата и иметь соответствующие права админа. Возвращает True в случае успеха. Примечание: В обычных группах (не супергруппы), этот метод будет работать только если настройка ‘All Members Are Admins’ отключена.

Документация Telegram: https://core.telegram.org/bots/api#setchattitle

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
title (str) – Новое название чата, 1-255 символов

Результат:

True в случае успеха.

Тип результата:

bool

async set_custom_emoji_sticker_set_thumbnail(name: str, custom_emoji_id: str | None = None) → bool¶

Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.

Параметры:

name (str) – Имя стикерпака
custom_emoji_id (str) – Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail.

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

Задаёт количество очков пользователя в игре.

Документация Telegram: https://core.telegram.org/bots/api#setgamescore

Параметры:

user_id (int or str) – id пользователя
score (int) – Количество очков, должно быть неотрицательным
force (bool) – Передайте True, если количество очков могут быть уменьшено. Может быть полезно при исправлении ошибок или бане читеров
chat_id (int or str) – Обязательный, если не указан inline_message_id. Уникальный id чата или username канала (в формате @channelusername)
message_id (int) – Обязательный, если не указан inline_message_id. id отправленного сообщения
inline_message_id (str) – Обязательный, если не указаны chat_id и message_id. id inline сообщения
disable_edit_message (bool) – Передайте True, если сообщение с игрой должно быть автоматически отредактировано, чтобы отобразить новый результат

Результат:

В случае успеха, если сообщение было отправлено ботом, возвращает измененное сообщение (Message), иначе возвращает True.

Тип результата:

types.Message or bool

async set_managed_bot_access_settings(user_id: int, is_access_restricted: bool, added_user_ids: List[int] | None = None) → bool¶

Use this method to change the access settings of a managed bot. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#setmanagedbotaccesssettings

Параметры:

user_id (int) – User identifier of the managed bot whose access settings will be changed
is_access_restricted (bool) – Pass True, if only selected users can access the bot. The bot’s owner can always access it.
added_user_ids (list of int) – A JSON-serialized list of up to 10 identifiers of users who will have access to the bot in addition to its owner. Ignored if is_access_restricted is false.

Результат:

True в случае успеха.

Тип результата:

bool

async set_message_reaction(chat_id: int | str, message_id: int, reaction: List[ReactionType] | None = None, is_big: bool | None = None) → bool¶

Use this method to change the chosen reactions on a message. Service messages can’t be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#setmessagereaction

Параметры:

chat_id (int or str) – Уникальный id чата или username супергруппы или канала (в формате @channelusername)
message_id (int) – Identifier of the message to set reaction to
reaction (list of telebot.types.ReactionType) – New list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.
is_big (bool) – Pass True to set the reaction with a big animation

Результат:

bool

async set_my_commands(commands: List[BotCommand], scope: BotCommandScope | None = None, language_code: str | None = None) → bool¶

Используйте этот метод, чтобы изменить список команд бота.

Документация Telegram: https://core.telegram.org/bots/api#setmycommands

Параметры:

commands (list of telebot.types.BotCommand) – Список объектов BotCommand. Можно задать не более 100 команд.
scope (telebot.types.BotCommandScope) – Область видимости команд. По умолчанию BotCommandScopeDefault.
language_code (str) – Двухбуквенный языковой код в формате ISO 639-1. Если не задан, изменения коснутся команд для всех пользователей в заданном поле видимости, не имеющих команд на их языке

Результат:

True в случае успеха.

Тип результата:

bool

async set_my_default_administrator_rights(rights: ChatAdministratorRights = None, for_channels: bool = None) → bool¶

Используйте этот метод, чтобы изменить права администратора по умолчанию, запрашиваемые при добавлении бота в группу или канал в качестве администратора. Эти права будут предложены пользователям, но пользователи могут изменить список перед добавлением бота. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#setmydefaultadministratorrights

Параметры:

rights (telebot.types.ChatAdministratorRights) – JSON-сериалиованный объект, описывающий новые права администратора по умолчанию. Если не указан, права администратора по умолчанию будут сброшены.
for_channels (bool) – Передайте True, чтобы изменить права администратора по умолчанию в каналах. Иначе, будут изменены права администратора по умолчанию для групп и супергрупп.

Результат:

True в случае успеха.

Тип результата:

bool

async set_my_description(description: str | None = None, language_code: str | None = None)¶

Use this method to change the bot’s description, which is shown in the chat with the bot if the chat is empty. Returns True on success.

Параметры:

description (str) – New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.
language_code (str) – A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.

Результат:

True в случае успеха.

async set_my_name(name: str | None = None, language_code: str | None = None)¶

Use this method to change the bot’s name. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#setmyname

Параметры:

name (str) – Optional. New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language.
language_code (str) – Optional. A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name.

Результат:

True в случае успеха.

async set_my_profile_photo(photo: InputProfilePhoto) → bool¶

Use this method to change the profile photo of the bot. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#setmyprofilephoto

Параметры:: photo (telebot.types.InputProfilePhoto) – InputProfilePhoto: The new profile photo to set
Результат:: True в случае успеха.
Тип результата:: bool

async set_my_short_description(short_description: str | None = None, language_code: str | None = None)¶

Use this method to change the bot’s short description, which is shown on the bot’s profile page and is sent together with the link when users share the bot. Returns True on success.

Параметры:

short_description (str) – New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.
language_code (str) – A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description.

Результат:

True в случае успеха.

Задаёт новое состояние (стейт) пользователя.

Примечание

Вы должны указать и user id и chat id, чтобы задать состояние (стейт) пользователя в чате. Иначе, если вы укажете только user_id, chat_id будет равен user_id, что означает смену состояния (стейта) пользователя в его приватном чате с ботом.

Изменено в версии 4.23.0: Added additional parameters to support topics, business connections, and message threads.

См. также

For more details, visit the custom_states.py example.

Параметры:

user_id (int) – id пользователя
state (int or str or telebot.types.State) – new state. can be string, or telebot.types.State
chat_id (int) – id чата
bot_id (int) – Bot’s identifier, defaults to current bot id
business_connection_id (str) – Business identifier
message_thread_id (int) – Identifier of the message thread

Результат:

True в случае успеха

Тип результата:

bool

async set_sticker_emoji_list(name: str, emoji_list: List[str]) → bool¶

Use this method to set the emoji list of a sticker set. Returns True on success.

Параметры:

name (str) – Имя стикерпака
emoji_list (list of str) – List of emojis

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async set_sticker_keywords(sticker: str, keywords: List[str] = None) → bool¶

Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

Параметры:

sticker (str) – File identifier of the sticker.
keywords (list of str) – A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters

Результат:

В случае успеха возвращается True.

Тип результата:

bool

async set_sticker_mask_position(sticker: str, mask_position: MaskPosition = None) → bool¶

Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.

Параметры:

sticker (str) – File identifier of the sticker.
mask_position (telebot.types.MaskPosition) – A JSON-serialized object for position where the mask should be placed on faces.

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async set_sticker_position_in_set(sticker: str, position: int) → bool¶

Используйте этот метод, чтобы передвинуть стикер в стикерпаке, созданном ботом, на заданную позицию. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#setstickerpositioninset

Параметры:

sticker (str) – id файла стикера
position (int) – Новая позиция стикера в стикерпаке, начиная с нуля

Результат:

В случае успеха возвращается True.

Тип результата:

bool

set_sticker_set_thumb(**kwargs)¶

async set_sticker_set_thumbnail(name: str, user_id: int, thumbnail: Any | str = None, format: str | None = None) → bool¶

Используйте этот метод, чтобы задать обложку стикерпака. Анимированные обложки могут быть заданы только для анимированных стикерпаков. Возвращает True в случае успеха.

Telegram documentation: https://core.telegram.org/bots/api#setstickersetthumbnail

Параметры:

name (str) – Имя стикерпака
user_id (int) – id пользователя
thumbnail (filelike object) – A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can’t be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.
format (str) – Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a WEBM video

Результат:

В случае успеха возвращается True.

Тип результата:

bool

async set_sticker_set_title(name: str, title: str) → bool¶

Use this method to set the title of a created sticker set. Returns True on success.

Параметры:

name (str) – Имя стикерпака
title (str) – New sticker set title

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

set_update_listener(func: Awaitable)¶

Задаёт функцию-листенер, которая будет вызвана при получении нового апдейта.

Параметры:: func (Awaitable) – Функция-листенер.

Пример асинхронного листенера апдейтов.¶

async def update_listener(new_messages):
    for message in new_messages:
        print(message.text) # Prints message text

bot.set_update_listener(update_listener)

Результат:: None

async set_user_emoji_status(user_id: int, emoji_status_custom_emoji_id: str | None = None, emoji_status_expiration_date: int | None = None) → bool¶

Use this method to change the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess.

Telegram documentation: https://core.telegram.org/bots/api#setuseremojistatus

Параметры:

user_id (int) – Уникальный id сделавшего запрос пользователя
emoji_status_custom_emoji_id (str, optional) – Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status.
emoji_status_expiration_date (int, optional) – Expiration date of the emoji status, if any

Результат:

bool

Используйте этот метод, чтобы задать URL и получать входящие апдейты с помощью вебхука. Как только у бота появляется апдейт, он будет отправлен с помощью HTTPS POST запроса на заданный URL, содержащего JSON-сериализованный Update. В случае неудачного запроса, отправка апдейта будет отменена после разумного числа попыток. Возвращает True в случае успеха.

Если вы хотите удостовериться, что вебхук был задан вами, вы можете задать секретный токен в параметре secret_token. Если указан, запрос с апдейтом будет содержать хедер “X-Telegram-Bot-Api-Secret-Token” с секретным токеном в качестве значения.

Документация Telegram: https://core.telegram.org/bots/api#setwebhook

Параметры:

url (str, optional) – HTTPS URL для отправки апдейтов. Используйте пустую строку, чтобы удалить вебхук, по умолчанию None
certificate (str, optional) – Загрузите публичный ключ вашего SSL сертификата, чтобы корневой сертификат мог быть проверен, по умолчанию None
max_connections (int, optional) – Максимально-допустимое количество одновременных HTTPS соединений для доставки апдейтов, 1-100. По умолчанию 40. Используйте меньшие значения для уменьшения нагрузки на ваш сервер и большие значения, чтобы увеличить пропускную способность вашего бота, по умолчанию None
allowed_updates (list, optional) – Список видов апдейтов, которые вы хотите получать, в формате JSON. Например, укажите [“message”, “edited_channel_post”, “callback_query”], чтобы получать апдейты только этих видов. Полный список доступных видов апдейтов - util.update_types. Укажите пустой список, чтобы получать все апдейты, кроме chat_member (по умолчанию). Если не задан, будет использована последняя настройка. Пожалуйста учтите, чтобы этот параметр не влияет на апдейты, отправленные до вызова setWebhooks, поэтому нежелательные апдейты могут быть получены в течение короткого периода времени. По умолчанию None
ip_address (str, optional) – Фиксированный IP адрес, который будет использоваться для отправки запросов к вебхукувместо IP адреса, полученного с через DNS, по умолчанию None
drop_pending_updates (bool, optional) – Передайте True, чтобы удалить все предшествующие запуску бота апдейты, по умолчанию None
timeout (int, optional) – Тайм-аут запроса, по умолчанию None
secret_token (str, optional) – Секретный токен для отправки в хедере “X-Telegram-Bot-Api-Secret-Token” в каждом запросе с апдейтом, 1-256 символов. Разрешены только символы A-Z, a-z, 0-9, _ и -. Хедер полезен для, того чтобы удостовериться, что запрос приходитс вебхука, установленного вами. По умолчанию None

Результат:

True в случае успеха.

Тип результата:

bool если запрос был успешным.

setup_middleware(middleware: BaseMiddleware)¶

Настраивает middleware

Примечание

Взгляните на секцию telebot.asyncio_handler_backends.BaseMiddleware для получения подробностей.

Параметры:: middleware (telebot.asyncio_handler_backends.BaseMiddleware) – Класс-Middleware.
Результат:: None

shipping_query_handler(func, **kwargs)¶

Обрабатывает shipping query. Только для инвойсов с гибкой ценой. В качестве параметра передаёт в декорируемую функцию объект telebot.types.ShippingQuery.

Параметры:

func (function) – Функция, используемая в качестве фильтра
kwargs – Необязательные именованные аргументы(кастомные фильтры)

Результат:

None

async skip_updates()¶: Пропускает существующие апдейты. На сервере останется только последний апдейт.

Используйте этот метод, чтобы остановить обновление live местоположения до истечения live_period. В случае успеха, если сообщение не является inline сообщением,возвращается измененное сообщение (Message), иначе возвращается True.

Документация Telegram: https://core.telegram.org/bots/api#stopmessagelivelocation

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
message_id (int) – Обязательный, если не указан inline_message_id. id сообщения live местоположением, которое нужно остановить
inline_message_id (str) – Обязательный, если не указаны chat_id и message_id. id inline сообщения с live местоположением, которое нужно остановить
reply_markup (telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply) – JSON-сериализованный объект новой inline клавиатуры.
timeout (int) – Таймаут запроса в секундах.
business_connection_id (str) – Identifier of a business connection, in which the message will be edited

Результат:

В случае успеха, если сообщение не является inline сообщением, возвращается измененное сообщение (Message), иначе возвращается True.

Тип результата:

telebot.types.Message or bool

async stop_poll(chat_id: int | str, message_id: int, reply_markup: InlineKeyboardMarkup | None = None, business_connection_id: str | None = None) → Poll¶

Используйте этот метод, чтобы завершить опрос, отправленный ботом. В случае успеха возвращается завершенный опрос (Poll).

Документация Telegram: https://core.telegram.org/bots/api#stoppoll

Параметры:

chat_id (int | str) – Уникальный id чата или username канала
message_id (int) – id сообщения с опросом
reply_markup (InlineKeyboardMarkup) – JSON-сериализованный объект новой inline клавиатуры.
business_connection_id (str) – Identifier of the business connection to send the message through

Результат:

В случае успеха возвращается завершенный опрос (Poll).

Тип результата:

types.Poll

async transfer_business_account_stars(business_connection_id: str, star_count: int) → bool¶

Transfers Telegram Stars from the business account balance to the bot’s balance. Requires the can_transfer_stars business bot right. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#transferbusinessaccountstars

Параметры:

business_connection_id (str) – Unique identifier of the business connection
star_count (int) – Number of Telegram Stars to transfer; 1-10000

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async transfer_gift(business_connection_id: str, owned_gift_id: str, new_owner_chat_id: int, star_count: int | None = None) → bool¶

Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#transfergift

Параметры:

business_connection_id (str) – Unique identifier of the business connection
owned_gift_id (str) – Unique identifier of the regular gift that should be transferred
new_owner_chat_id (int) – Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.
star_count (int) – The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required.

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async unban_chat_member(chat_id: int | str, user_id: int, only_if_banned: bool | None = False) → bool¶

Используйте этот метод, чтобы разбанить ранее кикнутого пользователя в супергруппе или канале. Пользовать не вернется в группу или канал автоматически, но сможет присоединиться с помощью ссылки и т.д. Бот должен быть администратором. По умолчанию, этот метод гарантирует, что после вызова, пользователь не является участником чата, но может присоединиться. Поэтому если пользовать является участником чата, он будет кикнут, но не забанен. Если вы хотите изменить это поведение, используйте параметр only_if_banned.

Документация Telegram: https://core.telegram.org/bots/api#unbanchatmember

Параметры:

chat_id (int or str) – Уникальный id группы или username супергруппы или канала (в формате @username)
user_id (int) – Уникальный id сделавшего запрос пользователя
only_if_banned (bool) – Ничего не делать, если пользователь не забанен

Результат:

True в случае успеха

Тип результата:

bool

async unban_chat_sender_chat(chat_id: int | str, sender_chat_id: int | str) → bool¶

Используйте этот метод, чтобы разбанить ране забаненный канал в супергруппе или канала. Бот должен быть администратором и иметь соответствующие права администратора. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#unbanchatsenderchat

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
sender_chat_id (int or str) – Уникальный id чата.

Результат:

True в случае успеха.

Тип результата:

bool

async unhide_general_forum_topic(chat_id: int | str) → bool¶

Используйте этот метод, чтобы сделать топик „General“ видимым в супергруппе с топиками. Бот должен быть администратором чата и иметь права администратора can_manage_topics. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#unhidegeneralforumtopic

Параметры:: chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)

async unpin_all_chat_messages(chat_id: int | str) → bool¶

Используйте этот метод, что открепить все закрепленные сообщения в супергруппе. Бот должен быть администратором чата и иметь соответствующие права администратора. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#unpinallchatmessages

Параметры:: chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
Результат:: True в случае успеха.
Тип результата:: bool

async unpin_all_forum_topic_messages(chat_id: str | int, message_thread_id: int) → bool¶

Используйте этот метод, что открепить все закрепленные сообщения в топике. Бот должен быть администратором чата и иметь права администратора can_pin_messages в супергруппе. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#unpinallforumtopicmessages

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
message_thread_id (int) – id топика

Результат:

В случае успеха возвращается True.

Тип результата:

bool

async unpin_all_general_forum_topic_messages(chat_id: int | str) → bool¶

Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#unpinAllGeneralForumTopicMessages

Параметры:: chat_id (int | str) – Unique identifier for the target chat or username of chat
Результат:: В случае успеха возвращается True.
Тип результата:: bool

async unpin_chat_message(chat_id: int | str, message_id: int | None = None, business_connection_id: str | None = None) → bool¶

Используйте этот метод, что открепить закрепленное сообщение в супергруппе. Бот должен быть администратором чата и иметь соответствующие права администратора. Возвращает True в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#unpinchatmessage

Параметры:

chat_id (int or str) – Уникальный id чата или username канала (в формате @channelusername)
message_id (int) – Int: id сообщения, которое нужно открепить
business_connection_id (str) – Unique identifier of the business connection

Результат:

True в случае успеха.

Тип результата:

bool

async upgrade_gift(business_connection_id: str, owned_gift_id: str, keep_original_details: bool | None = None, star_count: int | None = None) → bool¶

Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#upgradegift

Параметры:

business_connection_id (str) – Unique identifier of the business connection
owned_gift_id (str) – Unique identifier of the regular gift that should be upgraded to a unique one
keep_original_details (bool) – Pass True to keep the original gift text, sender and receiver in the upgraded gift
star_count (int) – The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed.

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async upload_sticker_file(user_id: int, png_sticker: Any | str = None, sticker: InputFile | None = None, sticker_format: str | None = None) → File¶

Используйте этот метод, чтобы загрузить .png стикер, чтобы позже использовать в методах createNewStickerSet и addStickerToSet (может быть использован несколько раз). Возвращает загруженный файл (File) в случае успеха.

Документация Telegram: https://core.telegram.org/bots/api#uploadstickerfile

Параметры:

user_id (int) – id пользователя, создавшего стикерпак
png_sticker (filelike object) – DEPRECATED: PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px.
sticker (telebot.types.InputFile) – A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files »
sticker_format (str) – One of «static», «animated», «video».

Результат:

В случае успеха возвращается отправленный файл.

Тип результата:

telebot.types.File

property user¶

async verify_chat(chat_id: int | str, custom_description: str | None = None) → bool¶

Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#verifychat

Параметры:

chat_id (int | str) – Уникальный id чата или username канала (в формате @channelusername)
custom_description (str) – Custom description for the verification; 0-70 characters. Must be empty if the organization isn’t allowed to provide a custom verification description.

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

async verify_user(user_id: int, custom_description: str | None = None) → bool¶

Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.

Telegram documentation: https://core.telegram.org/bots/api#verifyuser

Параметры:

user_id (int) – Уникальный id сделавшего запрос пользователя
custom_description (str) – Custom description for the verification; 0-70 characters. Must be empty if the organization isn’t allowed to provide a custom verification description.

Результат:

Возвращает True в случае успеха.

Тип результата:

bool

class telebot.async_telebot.ExceptionHandler¶

Базовые классы: object

Класс для обработки исключений во время поллинга

async handle(exception)¶

class telebot.async_telebot.Handler(callback, *args, **kwargs)¶

Базовые классы: object

Класс для (next step|reply) хендлеров

Файл asyncio_filters¶

class telebot.asyncio_filters.AdvancedCustomFilter¶

Базовые классы: ABC

Базовый класс Advanced Custom Filter. Создайте класс наследник с методом check(). Принимает два параметра, возвращает bool: True - фильтр пройден, False - фильтр не пройден. message: класс Message text: значение фильтра, полученное в хендлере

Классы наследники должны иметь статический атрибут (property) .key

Пример создания advanced custom filter.¶

class TextStartsFilter(AdvancedCustomFilter):
    # Filter to check whether message starts with some text.
    key = 'text_startswith'

    def check(self, message, text):
        return message.text.startswith(text)

async check(message, text)¶: Выполнить проверку.

key: str = None¶

class telebot.asyncio_filters.ChatFilter¶

Базовые классы: AdvancedCustomFilter

Проверяет, является ли chat_id заданным.

Пример использования этого фильтра:¶

@bot.message_handler(chat_id=[99999])
# your function

key: str = 'chat_id'¶

class telebot.asyncio_filters.ForwardFilter¶

Базовые классы: SimpleCustomFilter

Проверяет, является ли сообщение пересланным из канала или группы.

Пример использования этого фильтра:¶

@bot.message_handler(is_forwarded=True)
# your function

key: str = 'is_forwarded'¶

class telebot.asyncio_filters.IsAdminFilter(bot)¶

Базовые классы: SimpleCustomFilter

Проверяет, является ли пользователь администратором / владельцем чата.

Пример использования этого фильтра:¶

@bot.message_handler(chat_types=['supergroup'], is_chat_admin=True)
# your function

key: str = 'is_chat_admin'¶

class telebot.asyncio_filters.IsDigitFilter¶

Базовые классы: SimpleCustomFilter

Фильтр для проверки, состоит ли строка только из цифр.

Пример использования этого фильтра:¶

@bot.message_handler(is_digit=True)
# your function

key: str = 'is_digit'¶

class telebot.asyncio_filters.IsReplyFilter¶

Базовые классы: SimpleCustomFilter

Проверяет, является ли сообщение ответом (reply).

Пример использования этого фильтра:¶

@bot.message_handler(is_reply=True)
# your function

key: str = 'is_reply'¶

class telebot.asyncio_filters.LanguageFilter¶

Базовые классы: AdvancedCustomFilter

Проверяет language_code пользователя.

Пример использования этого фильтра:¶

@bot.message_handler(language_code=['ru'])
# your function

key: str = 'language_code'¶

class telebot.asyncio_filters.SimpleCustomFilter¶

Базовые классы: ABC

Базовый класс Simple Custom Filter. Создайте класс наследник с методом check(). Принимает только сообщение, возвращает bool, который сравнивается с заданным в хендлере.

Классы наследники должны иметь статический атрибут (property) .key

Пример создания simple custom filter.¶

class ForwardFilter(SimpleCustomFilter):
    # Check whether message was forwarded from channel or group.
    key = 'is_forwarded'

    def check(self, message):
        return message.forward_date is not None

async check(message) → bool¶: Выполнить проверку.

key: str = None¶

class telebot.asyncio_filters.StateFilter(bot)¶

Базовые классы: AdvancedCustomFilter

Фильтр для проверки состояния (стейта).

Пример использования этого фильтра:¶

@bot.message_handler(state=1)
# your function

key: str = 'state'¶

class telebot.asyncio_filters.TextContainsFilter¶

Базовые классы: AdvancedCustomFilter

Фильтр для проверки текста сообщения. key: text

Пример использования этого фильтра:¶

# Will respond if any message.text contains word 'account'
@bot.message_handler(text_contains=['account'])
# your function

key: str = 'text_contains'¶

Базовые классы: object

Advanced текстовый фильтр для проверки (types.Message, types.CallbackQuery, types.InlineQuery, types.Poll)

пример использования в examples/asynchronous_telebot/custom_filters/advanced_text_filter.py

Параметры:

equals (str) – строка, True если текст объекта идентичен заданной строке
contains (list[str] or tuple[str]) – list[str] или tuple[str], True если хотя бы один из элементов есть в тексте
starts_with (str) – string, True если текст объекта начинается с заданной строки
ends_with (str) – string, True если текст объекта начинается с заданной строки
ignore_case (bool) – bool (по умолчанию False), независимый от регистра

Исключение:

ValueError – если было задано некорректное значение параметра

Результат:

None

class telebot.asyncio_filters.TextMatchFilter¶

Базовые классы: AdvancedCustomFilter

Фильтр для проверки текста сообщения.

Пример использования этого фильтра:¶

@bot.message_handler(text=['account'])
# your function

key: str = 'text'¶

class telebot.asyncio_filters.TextStartsFilter¶

Базовые классы: AdvancedCustomFilter

Фильтр для проверки, начинается ли сообщение с заданного текста.

Пример использования этого фильтра:¶

# Will work if message.text starts with 'sir'.
@bot.message_handler(text_startswith='sir')
# your function

key: str = 'text_startswith'¶

Файл asyncio_handler_backends¶

Файл со всеми классами middleware и states.

class telebot.asyncio_handler_backends.BaseMiddleware¶

Базовые классы: object

Базовый класс для middleware. Ваши middleware должны быть унаследованы от этого класса.

Задайте update_sensitive=True если хотите получать разные апдейты в разных функциях. Например, если вы хотите обрабатывать pre_process для апдейтов вида message, вам нужно будет создать функцию pre_process_message и т.д. Аналогично для post_process.

Пример класса middleware¶

class MyMiddleware(BaseMiddleware):
    def __init__(self):
        self.update_sensitive = True
        self.update_types = ['message', 'edited_message']

    async def pre_process_message(self, message, data):
        # only message update here
        pass

    async def post_process_message(self, message, data, exception):
        pass # only message update here for post_process

    async def pre_process_edited_message(self, message, data):
        # only edited_message update here
        pass

    async def post_process_edited_message(self, message, data, exception):
        pass # only edited_message update here for post_process

async post_process(message, data, exception)¶

async pre_process(message, data)¶

update_sensitive: bool = False¶

class telebot.asyncio_handler_backends.CancelUpdate¶

Базовые классы: object

Класс для отмены апдейтов. Просто верните экземпляр этого класса в middleware, чтобы пропустить апдейт. Апдейт пропустит хендлер и исполнение post_process в middleware.

class telebot.asyncio_handler_backends.ContinueHandling¶

Базовые классы: object

Класс для продолжения обработки апдейта в хендлерах. Просто верните экземпляр этого класса в хендлерах, чтобы продолжить обработку.

Пример использования ContinueHandling¶

@bot.message_handler(commands=['start'])
async def start(message):
    await bot.send_message(message.chat.id, 'Hello World!')
    return ContinueHandling()

@bot.message_handler(commands=['start'])
async def start2(message):
    await bot.send_message(message.chat.id, 'Hello World2!')

class telebot.asyncio_handler_backends.SkipHandler¶

Базовые классы: object

Класс для пропуска хендлеров. Просто верните экземпляр этого класса в middleware, чтобы пропустить хендлер. Апдейт попадёт в post_process, но пропустит исполнение хендлера.

AsyncTeleBot¶

Методы класса AsyncTeleBot¶

Файл asyncio_filters¶

Файл asyncio_handler_backends¶

Расширения¶