Как получить сообщение пользователя telebot

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

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

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

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

token ( str ) – Токен бота, нужно получить от @BotFather

parse_mode ( str , optional) – Глобальный parse_mode, по умолчанию None

threaded ( bool , optional) – Использовать несколько потоков, по умолчанию True

skip_pending ( bool , optional) – Игнорировать апдейты, полученные до запуска, по умолчанию False

num_threads ( int , optional) – Максимальное количество одновременно запущенных потоков, по умолчанию 2

next_step_backend ( telebot.handler_backends.HandlerBackend , optional) – Класс для сохранения next step хендлеров, по умолчанию None

reply_backend ( telebot.handler_backends.HandlerBackend , optional) – Класс для сохранения reply хендлеров, по умолчанию None

exception_handler ( telebot.ExceptionHandler , optional) – Класс для обработки исключений, по умолчанию None

last_update_id ( int , optional) – id последнего полученного апдейта, по умолчанию 0

suppress_middleware_excepions ( bool , optional) – Игнорировать исключения, вызванные Middleware, по умолчанию False

state_storage ( telebot.storage.StateStorageBase , optional) – Хранилище состояний (стейтов), по умолчанию StateMemoryStorage()

use_class_middlewares ( bool , optional) – Использовать Middlewares, по умолчанию False

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) – Глобальное значение allow_sending_without_reply, по умолчанию None

colorful_logs ( bool , optional) – Использовать разноцветные логи

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

custom_filter – Класс с методом check(message)

custom_filter – Класс кастомного фильтра с ключом.

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

user_id ( int ) – id пользователя

chat_id ( int ) – id чата

kwargs – Данные для добавления

add_sticker_to_set ( user_id : int , name : str , emojis : Union [ List [ str ] , str ] , png_sticker : Optional [ Union [ str , Any ] ] = None , tgs_sticker : Optional [ Union [ str , Any ] ] = None , webm_sticker : Optional [ Union [ str , Any ] ] = None , mask_position : Optional [ MaskPosition ] = None , sticker : Optional [ List [ InputSticker ] ] = None ) → bool #

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

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 ( list of telebot.types.InputSticker ) – A JSON-serialized list of 1-50 initial stickers to be added to the sticker set

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

answer_callback_query ( callback_query_id : int , text : Optional [ str ] = None , show_alert : Optional [ bool ] = None , url : Optional [ str ] = None , cache_time : Optional [ int ] = None ) → bool #

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

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 query пользовательским клиентом в секундах. Приложения Telegram поддерживают хранение ответов начиная с версии 3.14, по умолчанию 0.

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

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

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

inline_query_id ( str ) – Уникальный id запроса для ответа

results ( list of types.InlineQueryResult ) – Массив результатов для ответа на inline query

cache_time ( int ) – Максимальная длительность хранения результатов inline query на сервере в секундах.

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.

answer_pre_checkout_query ( pre_checkout_query_id : int , ok : bool , error_message : Optional [ str ] = None ) → bool #

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

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

pre_checkout_query_id ( int ) – Уникальный id запроса для ответа

ok ( bool ) – Задайте True если всё правильно (выбранные товары доступны и т.д.) и бот готов обработать заказ. Задайте False если есть какие-то проблемы.

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

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

answer_shipping_query ( shipping_query_id : str , ok : bool , shipping_options : Optional [ List [ ShippingOption ] ] = None , error_message : Optional [ str ] = None ) → bool #

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

shipping_query_id ( str ) – Уникальный id запроса для ответа

ok ( bool ) – Задайте True если доставка по выбранному адресу возможна и False, если есть какие-то проблемы (например, доставка по выбранному адресу не осуществляется)

shipping_options ( list of ShippingOption ) – Обязательный в случае, когда ok — True. Массив вариантов доставки в формате JSON.

error_message ( str ) – Обязательный в случае, когда ok — False. Сообщение об ошибке, которое может прочитать человек, объясняющее причину, по которой невозможно завершить заказ (например «Извините, доставка по запрошенному адресу недоступна»). Telegram покажет это сообщение пользователю.

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

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

web_app_query_id ( str ) – Уникальный id запроса для ответа

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

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

approve_chat_join_request ( chat_id : Union [ str , int ] , user_id : Union [ int , str ] ) → bool #

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

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

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

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

ban_chat_member ( chat_id : Union [ int , str ] , user_id : int , until_date : Optional [ Union [ int , datetime ] ] = None , revoke_messages : Optional [ bool ] = None ) → bool #

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

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 в случае успеха.

ban_chat_sender_chat ( chat_id : Union [ int , str ] , sender_chat_id : Union [ int , str ] ) → bool #

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

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

sender_chat_id ( int or str ) – Уникальный id канала для блокировки

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

callback_query_handler ( func , ** kwargs ) #

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

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

kwargs – Необязательные именованные аргументы(кастомные фильтры)

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 – Необязательные именованные аргументы(кастомные фильтры)

chat_join_request_handler ( func = None , ** kwargs ) #

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

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

kwargs – Необязательные именованные аргументы(кастомные фильтры)

chat_member_handler ( func = None , ** kwargs ) #

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

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

kwargs – Необязательные именованные аргументы(кастомные фильтры)

chosen_inline_handler ( func , ** kwargs ) #

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

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

kwargs – Необязательные именованные аргументы(кастомные фильтры)

clear_reply_handlers ( message : Message ) → None #

Очищает список функций, зарегистрированных с помощью register_for_reply() и register_for_reply_by_message_id().

message ( telebot.types.Message ) – Сообщение, у которого нужно очистить список reply хендлеров

clear_reply_handlers_by_message_id ( message_id : int ) → None #

Очищает список функций, зарегистрированных с помощью register_for_reply() и register_for_reply_by_message_id().

message_id ( int ) – id сообщения, у которого нужно очистить список reply хендлеров

clear_step_handler ( message : Message ) → None #

Очищает список функций, зарегистрированных с помощью register_next_step_handler().

message ( telebot.types.Message ) – Сообщение, после которого нужно обработать новое сообщение в том же чате.

clear_step_handler_by_chat_id ( chat_id : Union [ int , str ] ) → None #

Очищает список функций, зарегистрированных с помощью register_next_step_handler().

chat_id ( int or str ) – Чат, в котором мы хотим очистить список next step хендлеров

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

close_forum_topic ( chat_id : Union [ str , int ] , message_thread_id : int ) → bool #

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

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

message_thread_id ( int ) – id топика для закрытия

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

close_general_forum_topic ( chat_id : Union [ int , str ] ) → bool #

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

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

copy_message ( chat_id : Union [ int , str ] , from_chat_id : Union [ int , str ] , message_id : int , caption : Optional [ str ] = None , parse_mode : Optional [ str ] = None , caption_entities : Optional [ List [ MessageEntity ] ] = None , disable_notification : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , reply_to_message_id : Optional [ int ] = None , allow_sending_without_reply : Optional [ bool ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , timeout : Optional [ int ] = None , message_thread_id : Optional [ int ] = None ) → MessageID #

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

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

from_chat_id ( int or str ) – Уникальный id чата, в который было отправлено исходное сообщение (или username канала в формате @channelusername)

message_id ( int ) – id сообщения в чате, заданном в from_chat_id

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 ) – Если сообщение является ответом — id сообщения, на которое дан ответ

allow_sending_without_reply ( bool ) – Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

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 топика, в который нужно отправить сообщение

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

create_chat_invite_link ( chat_id : Union [ int , str ] , name : Optional [ str ] = None , expire_date : Optional [ Union [ int , datetime ] ] = None , member_limit : Optional [ int ] = None , creates_join_request : Optional [ bool ] = None ) → ChatInviteLink #

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

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).

create_forum_topic ( chat_id : int , name : str , icon_color : Optional [ int ] = None , icon_custom_emoji_id : Optional [ str ] = None ) → ForumTopic #

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

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).

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

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

title ( str ) – Название товара, 1-32 символа

description ( str ) – Описание товара, 1-255 символов

payload ( str ) – Дополнительные данные, 1-128 байт. Не будет показано пользователю, используйте во внутренних процессах.

provider_token ( str ) – Токен платежной системы, полученный через @BotFather

currency ( str ) – Трехбуквенный код валюты в формате ISO 4217, см. https://core.telegram.org/bots/payments#supported-currencies

prices ( list of types.LabeledPrice ) – Детали цены, список компонент (например цена продукта, налог, скидка, стоимость доставки, налог на доставку, бонус и т.д.)

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) в случае успеха.

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

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

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 ) – Format of stickers in the set, must be one of “static”, “animated”, “video”

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

decline_chat_join_request ( chat_id : Union [ str , int ] , user_id : Union [ int , str ] ) → bool #

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

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

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

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

delete_chat_photo ( chat_id : Union [ int , str ] ) → bool #

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

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

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

delete_chat_sticker_set ( chat_id : Union [ int , str ] ) → bool #

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

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

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

delete_forum_topic ( chat_id : Union [ str , int ] , message_thread_id : int ) → bool #

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

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

message_thread_id ( int ) – id топика, который нужно удалить

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

delete_message ( chat_id : Union [ int , str ] , message_id : int , timeout : Optional [ int ] = None ) → bool #

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

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

message_id ( int ) – id сообщения, которое нужно удалить

timeout ( int ) – Таймаут запроса в секундах.

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

delete_my_commands ( scope : Optional [ BotCommandScope ] = None , language_code : Optional [ str ] = None ) → bool #

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

scope ( telebot.types.BotCommandScope ) – Область видимости команд. По умолчанию BotCommandScopeDefault.

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

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

delete_state ( user_id : int , chat_id : Optional [ int ] = None ) → None #

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

user_id ( int ) – id пользователя

chat_id ( int ) – id чата

delete_sticker_from_set ( sticker : str ) → bool #

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

sticker – id файла стикера

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

delete_sticker_set ( name : str ) → bool #

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

name ( str ) – Имя стикерпака

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

delete_webhook ( drop_pending_updates : Optional [ bool ] = None , timeout : Optional [ int ] = None ) → bool #

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

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

timeout ( int , optional) – Тайм-аут запроса, по умолчанию None

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

Отключить сохранение next step хендлеров (по умолчанию сохранение отключено)

Эта функция оставлена для обратной совместимости, для отключения возможности сохранения хендлеров в файл. В тех же целях MemoryHandlerBackend переопределен как новый next_step_backend вместо FileHandlerBackend.

Отключить сохранение next step хендлеров (по умолчанию сохранение отключено)

Эта функция оставлена для обратной совместимости, для отключения возможности сохранения хендлеров в файл. В тех же целях MemoryHandlerBackend переопределен как новый reply_backend вместо FileHandlerBackend.

download_file ( file_path : str ) → bytes #

file_path (str) – Путь, куда файл нужно сохранить.

edit_chat_invite_link ( chat_id : Union [ int , str ] , invite_link : Optional [ str ] = None , name : Optional [ str ] = None , expire_date : Optional [ Union [ int , datetime ] ] = None , member_limit : Optional [ int ] = None , creates_join_request : Optional [ bool ] = None ) → ChatInviteLink #

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

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).

edit_forum_topic ( chat_id : Union [ int , str ] , message_thread_id : int , name : Optional [ str ] = None , icon_custom_emoji_id : Optional [ str ] = None ) → bool #

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

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.

edit_general_forum_topic ( chat_id : Union [ int , str ] , name : str ) → bool #

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

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

name ( str ) – Название товара, 1-32 символа

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

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 клавиатуры.

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

edit_message_live_location ( latitude : float , longitude : float , chat_id : Optional [ Union [ int , str ] ] = None , message_id : Optional [ int ] = None , inline_message_id : Optional [ str ] = None , reply_markup : Optional [ InlineKeyboardMarkup ] = None , timeout : Optional [ int ] = None , horizontal_accuracy : Optional [ float ] = None , heading : Optional [ int ] = None , proximity_alert_radius : Optional [ int ] = None ) → Message # Используйте этот метод, чтобы изменить live местоположение в сообщении. Местоположение может быть изменено пока не истечёт live_period или не

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

latitude ( float ) – Широта нового местоположения

longitude ( float ) – Долгота нового местоположения

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

message_id ( int ) – Обязательный, если не указан inline_message_id. id сообщения, которое нужно изменить

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.

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

edit_message_media ( media : Any , chat_id : Optional [ Union [ int , str ] ] = None , message_id : Optional [ int ] = None , inline_message_id : Optional [ str ] = None , reply_markup : Optional [ InlineKeyboardMarkup ] = None ) → Union [ Message , bool ] #

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

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 клавиатуры.

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

edit_message_reply_markup ( chat_id : Optional [ Union [ int , str ] ] = None , message_id : Optional [ int ] = None , inline_message_id : Optional [ str ] = None , reply_markup : Optional [ InlineKeyboardMarkup ] = None ) → Union [ Message , bool ] #

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

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 клавиатуры.

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

edit_message_text ( text : str , chat_id : Optional [ Union [ int , str ] ] = None , message_id : Optional [ int ] = None , inline_message_id : Optional [ str ] = None , parse_mode : Optional [ str ] = None , entities : Optional [ List [ MessageEntity ] ] = None , disable_web_page_preview : Optional [ bool ] = None , reply_markup : Optional [ InlineKeyboardMarkup ] = None ) → Union [ Message , bool ] #

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

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 ) – Отключает превью ссылок в сообщении

reply_markup ( InlineKeyboardMarkup ) – JSON-сериализованный объект inline клавиатуры.

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

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 – Необязательные именованные аргументы(кастомные фильтры)

enable_save_next_step_handlers ( delay : Optional [ int ] = 120 , filename : Optional [ str ] = ‘./.handler-saves/step.save’ ) #

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

Эта функция, целью которой было включить возможность сохранения файлов для обработчиков, явно назначает FileHandlerBackend (вместо Saver) просто для сохранения обратной совместимости. Та же реализация теперь доступна с FileHandlerBackend.

delay ( int , optional) – Задержка между изменениями в хендлерах и сохранении, по умолчанию 120

filename ( str , optional) – Имя файла для сохранения, по умолчанию «./.handler-saves/step.save»

enable_save_reply_handlers ( delay = 120 , filename = ‘./.handler-saves/reply.save’ ) #

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

Эта функция, целью которой было включить возможность сохранения файлов для обработчиков, явно назначает FileHandlerBackend (вместо Saver) просто для сохранения обратной совместимости. Та же реализация теперь доступна с FileHandlerBackend.

delay ( int , optional) – Задержка между изменениями в хендлерах и сохранении, по умолчанию 120

filename ( str , optional) – Имя файла для сохранения, по умолчанию «./.handler-saves/reply.save»

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

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

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

export_chat_invite_link ( chat_id : Union [ int , str ] ) → str #

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

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

новая ссылка-приглашение (String) в случае успеха.

forward_message ( chat_id : Union [ int , str ] , from_chat_id : Union [ int , str ] , message_id : int , disable_notification : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , timeout : Optional [ int ] = None , message_thread_id : Optional [ int ] = None ) → Message #

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

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

protect_content ( bool ) – Запретить пересылку и сохранение содержимого пересланного сообщения

timeout ( int ) – Таймаут запроса в секундах.

message_thread_id ( int ) – id топика, в который нужно отправить сообщение

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

get_chat ( chat_id : Union [ int , str ] ) → Chat #

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

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

Информация о чате

get_chat_administrators ( chat_id : Union [ int , str ] ) → List [ ChatMember ] #

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

chat_id – Уникальный id чата или username супергруппы или канала (в формате @channelusername)

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

get_chat_member ( chat_id : Union [ int , str ] , user_id : int ) → ChatMember #

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

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

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

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

get_chat_member_count ( chat_id : Union [ int , str ] ) → int #

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

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

Количество участников чата.

get_chat_members_count ( ** kwargs ) # get_chat_menu_button ( chat_id : Optional [ Union [ int , str ] ] = None ) → MenuButton #

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

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

get_custom_emoji_stickers ( custom_emoji_ids : List [ str ] ) → List [ Sticker ] #

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

custom_emoji_ids ( list of str ) – Список id кастомных эмодзи. Можно указать не более 200 id.

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

get_file ( file_id : Optional [ str ] ) → File #

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

file_id ( str ) – id файла

get_file_url ( file_id : Optional [ str ] ) → str #

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

file_id ( str ) – id файла для получения ссылки на скачивание.

Ссылка для скачивания файла.

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

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

get_game_high_scores ( user_id : int , chat_id : Optional [ Union [ int , str ] ] = None , message_id : Optional [ int ] = None , inline_message_id : Optional [ str ] = None ) → List [ GameHighScore ] #

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

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

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.

Простой метод для тестирования токена бота. Не требует параметров. Возвращает базовую информацию о боте в виде объекта User.

get_my_commands ( scope : Optional [ BotCommandScope ] = None , language_code : Optional [ str ] = None ) → List [ BotCommand ] #

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

scope ( telebot.types.BotCommandScope ) – Область видимости команд. По умолчанию BotCommandScopeDefault.

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

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

get_my_default_administrator_rights ( for_channels : Optional [ bool ] = None ) → ChatAdministratorRights #

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

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

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

get_my_description ( language_code : Optional [ str ] = 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

get_my_name ( language_code : Optional [ str ] = None ) #

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

language_code ( str ) – Optional. A two-letter ISO 639-1 language code or an empty string

get_my_short_description ( language_code : Optional [ str ] = 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

get_state ( user_id : int , chat_id : Optional [ int ] = None ) → Optional [ Union [ int , str , State ] ] #

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

user_id ( int ) – id пользователя

chat_id ( int ) – id чата

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

int or str or telebot.types.State

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

name ( str ) – Имя стикерпака

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

get_updates ( offset : Optional [ int ] = None , limit : Optional [ int ] = None , timeout : Optional [ int ] = 20 , allowed_updates : Optional [ List [ str ] ] = None , long_polling_timeout : int = 20 ) → List [ Update ] #

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

offset ( int , optional) – id первого апдейта. Должен быть на единицу больше наибольшего id среди ранее полученных апдейтов. По умолчанию, возвращается список апдейтов, начиная с самого раннего неполученного. Апдейт считается полученным как только вызван метод getUpdates со смещением больше, чем id этого апдейта. Отрицательное смещение может быть указано для получения последних offset апдейтов. Все предыдущие апдейты будут считаться полученными.

limit ( int , optional) – Максимальное число апдейтов для получения. Допускаются значения от 1 до 100. По умолчанию 100.

timeout ( int , optional) – Тайм-аут запроса

allowed_updates ( list , optional) – Массив строк. Список видов апдейтов, которые вы хотите получать.

long_polling_timeout ( int , optional) – Тайм-аут поллинга в секундах.

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

get_user_profile_photos ( user_id : int , offset : Optional [ int ] = None , limit : Optional [ int ] = None ) → UserProfilePhotos #

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

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

offset ( int ) – Порядковый номер первого фото для получения. По умолчанию, возвращаются все фото.

limit ( int ) – Максимальное число фото для получения. Допускаются значения от 1 до 100. По умолчанию 100.

get_webhook_info ( timeout : Optional [ int ] = None ) → WebhookInfo #

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

timeout ( int , optional) – Тайм-аут запроса

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

hide_general_forum_topic ( chat_id : Union [ int , str ] ) → bool #

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

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

infinity_polling ( timeout : Optional [ int ] = 20 , skip_pending : Optional [ bool ] = False , long_polling_timeout : Optional [ int ] = 20 , logger_level : Optional [ int ] = 40 , allowed_updates : Optional [ List [ str ] ] = None , restart_on_change : Optional [ bool ] = False , path_to_watch : Optional [ str ] = None , * args , ** kwargs ) #

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

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

timeout ( int ) – Тайм-аут запроса.

long_polling_timeout ( int ) – Тайм-аут поллинга в секундах (см. документацию API)

skip_pending ( bool ) – пропускать старые апдейты

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 ) – Путь для мониторинга изменений. По умолчанию текущая директория.

inline_handler ( func , ** kwargs ) #

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

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

kwargs – Необязательные именованные аргументы(кастомные фильтры)

kick_chat_member ( ** kwargs ) # leave_chat ( chat_id : Union [ int , str ] ) → bool #

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

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

load_next_step_handlers ( filename = ‘./.handler-saves/step.save’ , del_file_after_loading = True ) #

Загрузить next step хендлеры из файла

Эта функция оставлена для обратной совместимости, для загрузки хендлеров из файла с помощью FileHandlerBackend и рекомендуется к использованию только если next_step_backend был определён как FileHandlerBackend до вызова этой функции

filename ( str , optional) – Имя файла, в котором были сохранены хендлеры, по умолчанию «./.handler-saves/step.save»

del_file_after_loading ( bool , optional) – Если передано True, файл будет удалён после загрузки, по умолчанию True

Загрузить reply хендлеры из файла

Эта функция оставлена для обратной совместимости, для загрузки хендлеров из файла с помощью FileHandlerBackend и рекомендуется к использованию только если reply_backend был определён как FileHandlerBackend до вызова этой функции

filename ( str , optional) – Имя файла, в котором были сохранены хендлеры, по умолчанию «./.handler-saves/reply.save»

del_file_after_loading ( bool , optional) – Если передано True, файл будет удалён после загрузки, по умолчанию True

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

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

message_handler ( commands : Optional [ List [ str ] ] = None , regexp : Optional [ str ] = None , func : Optional [ Callable ] = None , content_types : Optional [ List [ str ] ] = None , chat_types : Optional [ List [ str ] ] = None , ** kwargs ) #

Обрабатывает входящие сообщения всех видов — text, photo, sticker, и т.д. В качестве параметра передаёт в декорируемую функцию объект telebot.types.Message . Все хендлеры сообщений проверяются в том порядке, в котором были добавлены.

commands ( list of str ) – Необязательный список строк — команд для обработки.

regexp ( str ) – Необязательное регулярное выражение.

func ( lambda ) – Необязательная lambda функция. Получает сообщение (объект Message) в качестве первого параметра. Функция должна вернуть True если хендлер должен обработать сообщение.

content_types ( list of str ) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]

chat_types ( list of str ) – список видов чатов

kwargs – Необязательные именованные аргументы(кастомные фильтры)

middleware_handler ( update_types : Optional [ List [ str ] ] = None ) #

Функция-декоратор для middleware хендлера.

Этот декоратор может быть использован, чтобы декорировать функции, которые будут использоваться в качестве middleware перед обработкой апдейтов, будьте аккуратны и проверяйте вид апдейта внутри функции если возможны апдейты разных видов

update_types ( list of str ) – Необязательный список видов апдейтов, которые будут обработаны этим middleware хендлером.

my_chat_member_handler ( func = None , ** kwargs ) #

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

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

kwargs – Необязательные именованные аргументы(кастомные фильтры)

pin_chat_message ( chat_id : Union [ int , str ] , message_id : int , disable_notification : Optional [ bool ] = False ) → bool #

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

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

message_id ( int ) – id сообщения, которое нужно закрепить

disable_notification ( bool ) – Передайте True, если всем участникам группы необходимо отправить уведомление о закреплённом сообщении

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

poll_answer_handler ( func = None , ** kwargs ) #

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

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

kwargs – Необязательные именованные аргументы(кастомные фильтры)

poll_handler ( func , ** kwargs ) #

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

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

kwargs – Необязательные именованные аргументы(кастомные фильтры)

polling ( non_stop : Optional [ bool ] = False , skip_pending : Optional [ bool ] = False , interval : Optional [ int ] = 0 , timeout : Optional [ int ] = 20 , long_polling_timeout : Optional [ int ] = 20 , logger_level : Optional [ int ] = 40 , allowed_updates : Optional [ List [ str ] ] = None , none_stop : Optional [ bool ] = None , restart_on_change : Optional [ bool ] = False , path_to_watch : Optional [ str ] = None ) #

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

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

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

Не рекомендуется, начиная с версии 4.1.1: Используйте infinity_polling() .

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

interval ( int ) – Задержка между получением апдейтов

non_stop ( bool ) – Не останавливать поллинг при возникновении ApiException.

timeout ( int ) – Тайм-аут запроса

skip_pending ( bool ) – пропускать старые апдейты

long_polling_timeout ( int ) – Тайм-аут поллинга в секундах (см. документацию API)

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, поэтому нежелательные апдейты могут быть получены в течение короткого периода времени.

none_stop ( bool ) – Устарело, используйте non_stop. Старая опечатка, оставлено для обратной совместимости

restart_on_change ( bool ) – Перезапуск при изменении файлов. По умолчанию False

path_to_watch ( str ) – Путь для мониторинга изменений. По умолчанию None

pre_checkout_query_handler ( func , ** kwargs ) #

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

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

kwargs – Необязательные именованные аргументы(кастомные фильтры)

process_new_updates ( updates : List [ Update ] ) #

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

updates ( list of telebot.types.Update ) – Список объектов telebot.types.Update .

promote_chat_member ( chat_id : Union [ int , str ] , user_id : int , can_change_info : Optional [ bool ] = None , can_post_messages : Optional [ bool ] = None , can_edit_messages : Optional [ bool ] = None , can_delete_messages : Optional [ bool ] = None , can_invite_users : Optional [ bool ] = None , can_restrict_members : Optional [ bool ] = None , can_pin_messages : Optional [ bool ] = None , can_promote_members : Optional [ bool ] = None , is_anonymous : Optional [ bool ] = None , can_manage_chat : Optional [ bool ] = None , can_manage_video_chats : Optional [ bool ] = None , can_manage_voice_chats : Optional [ bool ] = None , can_manage_topics : Optional [ bool ] = None ) → bool #

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

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, если пользователю разрешено создавать, переименовывать, закрывать, и возобновлять топики, только для супергрупп

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

register_callback_query_handler ( callback : Callable , func : Callable , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

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

pass_bot ( bool ) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)

kwargs – Необязательные именованные аргументы(кастомные фильтры)

register_channel_post_handler ( callback : Callable , content_types : Optional [ List [ str ] ] = None , commands : Optional [ List [ str ] ] = None , regexp : Optional [ str ] = None , func : Optional [ Callable ] = None , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

content_types ( list of str ) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]

commands ( list of str ) – список команд

regexp ( str ) – Регулярное выражение

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

pass_bot ( bool ) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)

kwargs – Необязательные именованные аргументы(кастомные фильтры)

register_chat_join_request_handler ( callback : Callable , func : Optional [ Callable ] = None , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

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

pass_bot ( bool ) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)

kwargs – Необязательные именованные аргументы(кастомные фильтры)

register_chat_member_handler ( callback : Callable , func : Optional [ Callable ] = None , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

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

pass_bot ( bool ) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)

kwargs – Необязательные именованные аргументы(кастомные фильтры)

register_chosen_inline_handler ( callback : Callable , func : Callable , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

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

pass_bot ( bool ) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)

kwargs – Необязательные именованные аргументы(кастомные фильтры)

register_edited_channel_post_handler ( callback : Callable , content_types : Optional [ List [ str ] ] = None , commands : Optional [ List [ str ] ] = None , regexp : Optional [ str ] = None , func : Optional [ Callable ] = None , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

content_types ( list of str ) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]

commands ( list of str ) – список команд

regexp ( str ) – Регулярное выражение

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

pass_bot ( bool ) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)

kwargs – Необязательные именованные аргументы(кастомные фильтры)

register_edited_message_handler ( callback : Callable , content_types : Optional [ List [ str ] ] = None , commands : Optional [ List [ str ] ] = None , regexp : Optional [ str ] = None , func : Optional [ Callable ] = None , chat_types : Optional [ List [ str ] ] = None , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

content_types ( list of str ) – Обрабатываемые виды контента. Обязан быть списком. По умолчанию [„text“]

commands ( list of str ) – список команд

regexp ( str ) – Регулярное выражение

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

chat_types ( bool ) – True для приватных чатов

pass_bot ( bool ) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)

kwargs – Необязательные именованные аргументы(кастомные фильтры)

register_for_reply ( message : Message , callback : Callable , * args , ** kwargs ) → None #

Регистрирует функцию для вызова при получении ответа на выбранное сообщение.

Предупреждение: При использовании lambda функции в качестве callback , сохранение reply хендлеров не будет работать.

message ( telebot.types.Message ) – Сообщение, ответ на которое нужно ждать.

callback ( Callable[[telebot.types.Message], None] ) – Функция, которую нужно вызвать при получении ответа на сообщение. Должна принимать параметр message , который будет содержать ответ на сообщение.

args – Необязательные аргументы для вызываемой функции.

kwargs – Необязательные именованные аргументы для вызываемой функции.

register_for_reply_by_message_id ( message_id : int , callback : Callable , * args , ** kwargs ) → None #

Регистрирует функцию для вызова при получении ответа на выбранное сообщение.

Предупреждение: При использовании lambda функции в качестве callback , сохранение reply хендлеров не будет работать.

message_id ( int ) – id сообщения, ответ на которое нужно ждать.

callback ( Callable[[telebot.types.Message], None] ) – Функция, которую нужно вызвать при получении ответа на сообщение. Должна принимать параметр message , который будет содержать ответ на сообщение.

args – Необязательные аргументы для вызываемой функции.

kwargs – Необязательные именованные аргументы для вызываемой функции.

register_inline_handler ( callback : Callable , func : Callable , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

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

pass_bot ( bool ) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)

kwargs – Необязательные именованные аргументы(кастомные фильтры)

register_message_handler ( callback : Callable , content_types : Optional [ List [ str ] ] = None , commands : Optional [ List [ str ] ] = None , regexp : Optional [ str ] = None , func : Optional [ Callable ] = None , chat_types : Optional [ List [ str ] ] = None , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

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 – Необязательные именованные аргументы(кастомные фильтры)

register_middleware_handler ( callback , update_types = None ) #

Эта функция зарегистрирует вашу функцию-middleware. Middleware функции исполняются до хендлеров. Будьте осторожны и проверяйте вид апдейта внутри функции, если указано более одного update_type

bot.register_middleware_handler(print_channel_post_text, update_types=[„channel_post“, „edited_channel_post“])

callback ( function ) – Функция, которая будет использована в качестве middleware.

update_types ( list of str ) – Необязательный список видов апдейтов, которые будут обработаны этим middleware хендлером.

register_my_chat_member_handler ( callback : Callable , func : Optional [ Callable ] = None , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

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

pass_bot ( bool ) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)

kwargs – Необязательные именованные аргументы(кастомные фильтры)

register_next_step_handler ( message : Message , callback : Callable , * args , ** kwargs ) → None #

Регистрирует функцию для вызова при получении нового сообщения после указанного.

Предупреждение: При использовании lambda функции в качестве callback , сохранение next step хендлеров не будет работать.

message ( telebot.types.Message ) – Сообщение, после которого нужно обработать следующее в том же чате.

callback ( Callable[[telebot.types.Message], None] ) – Функция для вызова при получении нового сообщения.

args – Аргументы для передачи в функцию

kwargs – Аргументы для передачи в функцию

register_next_step_handler_by_chat_id ( chat_id : int , callback : Callable , * args , ** kwargs ) → None #

Регистрирует функцию для вызова при получении нового сообщения в заданном чате.

Предупреждение: При использовании lambda функции в качестве callback , сохранение next step хендлеров не будет работать.

chat_id ( int ) – Чат (id чата), в котором нужно обработать новое сообщение.

callback ( Callable[[telebot.types.Message], None] ) – Функция для вызова при получении нового сообщения.

args – Аргументы для передачи в функцию

kwargs – Аргументы для передачи в функцию

register_poll_answer_handler ( callback : Callable , func : Callable , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

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

pass_bot ( bool ) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)

kwargs – Необязательные именованные аргументы(кастомные фильтры)

register_poll_handler ( callback : Callable , func : Callable , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

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

pass_bot ( bool ) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)

kwargs – Необязательные именованные аргументы(кастомные фильтры)

register_pre_checkout_query_handler ( callback : Callable , func : Callable , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

func – Функция, используемая в качестве фильтра

pass_bot ( bool ) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)

kwargs – Необязательные именованные аргументы(кастомные фильтры)

register_shipping_query_handler ( callback : Callable , func : Callable , pass_bot : Optional [ bool ] = False , ** kwargs ) #

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

callback ( function ) – функция-хендлер

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

pass_bot ( bool ) – True, если вам нужно передать экземпляр класса TeleBot в хендлер(удобно для разбиения кода на файлы)

kwargs – Необязательные именованные аргументы(кастомные фильтры)

Удаляет вебхук, используя set_webhook().

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

reopen_forum_topic ( chat_id : Union [ str , int ] , message_thread_id : int ) → bool #

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

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

message_thread_id ( int ) – id топика для возобновления

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

reopen_general_forum_topic ( chat_id : Union [ int , str ] ) → bool #

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

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

Удобная функция для замены send_message(message.chat.id, text, reply_to_message_id=message.message_id, **kwargs)

message ( types.Message ) – Экземпляр класса telebot.types.Message

text ( str ) – Текст сообщения.

kwargs – Дополнительные именованные аргументы, передаваемые в telebot.TeleBot.send_message()

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

reset_data ( user_id : int , chat_id : Optional [ int ] = None ) #

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

user_id ( int ) – id пользователя

chat_id ( int ) – id чата

restrict_chat_member ( chat_id : Union [ int , str ] , user_id : int , until_date : Optional [ Union [ int , datetime ] ] = None , can_send_messages : Optional [ bool ] = None , can_send_media_messages : Optional [ bool ] = None , can_send_polls : Optional [ bool ] = None , can_send_other_messages : Optional [ bool ] = None , can_add_web_page_previews : Optional [ bool ] = None , can_change_info : Optional [ bool ] = None , can_invite_users : Optional [ bool ] = None , can_pin_messages : Optional [ bool ] = None , permissions : Optional [ ChatPermissions ] = None , use_independent_chat_permissions : Optional [ bool ] = None ) → bool #

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

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 ) – Дата, когда ограничения будут сняты с пользователя, UNIX timestamp. Если пользователь ограничен более чем на 366 дней или менее чем на 30 секунд с текущего момента, он будет ограничен навсегда (пока ограничения не будут сняты вручную)

can_send_messages ( bool ) – Передайте True, если пользователь может отправлять текстовые сообщения, контакты, местоположения и места

can_send_media_messages ( bool ) – Передайте True, если пользователь может отправлять аудио, документы, фото, видео, видео заметки (кружочки) и голосовые сообщения, подразумевает can_send_messages

can_send_polls ( bool ) – Передайте True, если пользователю разрешено отправлять опросы, подразумевает can_send_messages

can_send_other_messages ( bool ) – Передайте True, если пользователь может отправлять гифки, игры, стикеры и использовать inline ботов, подразумевает can_send_media_messages

can_add_web_page_previews ( bool ) – Передайте True, если пользователь может добавлять превью ссылок к своим сообщениям, подразумевает can_send_media_messages

can_change_info ( bool ) – Передайте True, если пользователю разрешено изменять название чата, аватарку и другие настройки. Игнорируется в публичных супергруппах

can_invite_users ( bool ) – Передайте True, если пользователю разрешено приглашать пользователей в чат

can_pin_messages ( bool ) – Передайте True, если пользователю разрешено закреплять сообщения. Игнорируется в публичных супергруппах

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.

permissions ( telebot.types.ChatPermissions ) – Pass ChatPermissions object to set all permissions at once. Use this param instead of passing all boolean parameters.

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

retrieve_data ( user_id : int , chat_id : Optional [ int ] = None ) → Optional [ Any ] #

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

user_id (int) – id пользователя

chat_id (int, optional) – Уникальный id чата, по умолчанию user_id

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

revoke_chat_invite_link ( chat_id : Union [ int , str ] , invite_link : str ) → ChatInviteLink #

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

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

invite_link ( str ) – Ссылка-приглашение, которую нужно аннулировать

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

run_webhooks ( listen : Optional [ str ] = ‘127.0.0.1’ , port : Optional [ int ] = 443 , url_path : Optional [ str ] = None , certificate : Optional [ str ] = None , certificate_key : Optional [ str ] = None , webhook_url : Optional [ str ] = None , max_connections : Optional [ int ] = None , allowed_updates : Optional [ List ] = None , ip_address : Optional [ str ] = None , drop_pending_updates : Optional [ bool ] = None , timeout : Optional [ int ] = None , secret_token : Optional [ str ] = None , secret_token_length : Optional [ int ] = 20 ) #

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

Требует fastapi, uvicorn и последнюю версию starlette.

listen ( str , optional) – IP адрес для мониторинга, по умолчанию «127.0.0.1»

port ( int , optional) – Порт, который будет использован для мониторинга вебхуков. По умолчанию 443

url_path ( str , optional) – Путь к вебхуку(по умолчанию /token). По умолчанию None

certificate ( str , optional) – Путь к файлу с SSL сертификатом, по умолчанию None

certificate_key ( str , optional) – Путь к файлу с приватным ключом SSL сертификата, по умолчанию None

webhook_url ( str , optional) – URL вебхука, по умолчанию 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 (по умолчанию). Если не задан, будет использована последняя настройка. По умолчанию None

ip_address ( str , optional) – Фиксированный IP адрес, который будет использоваться для отправки запросов к вебхуку вместо IP адреса, полученного через DNS, по умолчанию None

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

timeout ( int , optional) – Тайм-аут запроса, по умолчанию None

secret_token ( str , optional) – Секретный токен для верификации запроса к вебхуку, по умолчанию None

secret_token_length ( int , optional) – Длина секретного токена, по умолчанию 20

ImportError – Если необходимые библиотеки не были установлены.

send_animation ( chat_id : Union [ int , str ] , animation : Union [ Any , str ] , duration : Optional [ int ] = None , width : Optional [ int ] = None , height : Optional [ int ] = None , thumbnail : Optional [ Union [ str , Any ] ] = None , caption : Optional [ str ] = None , parse_mode : Optional [ str ] = None , caption_entities : Optional [ List [ MessageEntity ] ] = None , disable_notification : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , reply_to_message_id : Optional [ int ] = None , allow_sending_without_reply : Optional [ bool ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , timeout : Optional [ int ] = None , message_thread_id : Optional [ int ] = None , has_spoiler : Optional [ bool ] = None , thumb : Optional [ Union [ str , Any ] ] = None ) → Message #

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

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 ) – Если сообщение является ответом — id сообщения, на которое дан ответ

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 ) – Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

message_thread_id ( int ) – id топика, в который будет отправлено видео

has_spoiler ( bool ) – Передайте True, если гифку нужно отправить как спойлер

thumb ( str or telebot.types.InputFile ) – Deprecated. Use thumbnail instead

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

send_audio ( chat_id : Union [ int , str ] , audio : Union [ Any , str ] , caption : Optional [ str ] = None , duration : Optional [ int ] = None , performer : Optional [ str ] = None , title : Optional [ str ] = None , reply_to_message_id : Optional [ int ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , parse_mode : Optional [ str ] = None , disable_notification : Optional [ bool ] = None , timeout : Optional [ int ] = None , thumbnail : Optional [ Union [ str , Any ] ] = None , caption_entities : Optional [ List [ MessageEntity ] ] = None , allow_sending_without_reply : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , message_thread_id : Optional [ int ] = None , thumb : Optional [ Union [ str , Any ] ] = None ) → Message #

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

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

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 ) – Если сообщение является ответом — id сообщения, на которое дан ответ

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 ) – Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

protect_content ( bool ) – Запретить пересылку и сохранение содержимого сообщения

message_thread_id ( int ) – id топика, в который нужно отправить сообщение

thumb ( str or telebot.types.InputFile ) – Deprecated. Use thumbnail instead

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

send_chat_action ( chat_id : Union [ int , str ] , action : str , timeout : Optional [ int ] = None , message_thread_id : Optional [ int ] = None ) → bool #

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

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

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 ) – id топика, на сообщение из которого нужно ответить(только для супергрупп)

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

send_contact ( chat_id : Union [ int , str ] , phone_number : str , first_name : str , last_name : Optional [ str ] = None , vcard : Optional [ str ] = None , disable_notification : Optional [ bool ] = None , reply_to_message_id : Optional [ int ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , timeout : Optional [ int ] = None , allow_sending_without_reply : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , message_thread_id : Optional [ int ] = None ) → Message #

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

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 ) – Если сообщение является ответом — id сообщения, на которое дан ответ

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 ) – Передайте True, если сообщение должно быть отправлено даже если одно из сообщений, на которые нужно ответить, не найдено.

protect_content ( bool ) – Запретить пересылку и сохранение содержимого сообщения

message_thread_id ( int ) – id топика, на сообщение из которого нужно ответить

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

send_dice ( chat_id : Union [ int , str ] , emoji : Optional [ str ] = None , disable_notification : Optional [ bool ] = None , reply_to_message_id : Optional [ int ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , timeout : Optional [ int ] = None , allow_sending_without_reply : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , message_thread_id : Optional [ int ] = None ) → Message #

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

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

emoji ( str ) – Эмодзи, на котором основана анимация. На текущий момент, должно быть одним из “��”, “��”, “��”, “⚽”, “��”, или “��”. Значение может быть 1-6 для “��”, “��” и “��”, 1-5 для “��” и “⚽”, и 1-64 для “��”. По умолчанию “��”

disable_notification ( bool ) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.

reply_to_message_id ( int ) – Если сообщение является ответом — id сообщения, на которое дан ответ

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 ) – Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

protect_content ( bool ) – Защищает содержимое отправленного сообщения от пересылки

message_thread_id ( int ) – id топика, в который нужно отправить сообщение

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

send_document ( chat_id : Union [ int , str ] , document : Union [ Any , str ] , reply_to_message_id : Optional [ int ] = None , caption : Optional [ str ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , parse_mode : Optional [ str ] = None , disable_notification : Optional [ bool ] = None , timeout : Optional [ int ] = None , thumbnail : Optional [ Union [ str , Any ] ] = None , caption_entities : Optional [ List [ MessageEntity ] ] = None , allow_sending_without_reply : Optional [ bool ] = None , visible_file_name : Optional [ str ] = None , disable_content_type_detection : Optional [ bool ] = None , data : Optional [ Union [ str , Any ] ] = None , protect_content : Optional [ bool ] = None , message_thread_id : Optional [ int ] = None , thumb : Optional [ Union [ str , Any ] ] = None ) → Message #

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

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 ) – Если сообщение является ответом — id сообщения, на которое дан ответ

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 ) – Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

visible_file_name ( str ) – позволяет задать имя файла, которое будет показано в Telegram вместо настоящего

disable_content_type_detection ( bool ) – Отключает автоматическое обнаружение типа файла на стороне сервера для файлов, загруженных с помощью multipart/form-data

data ( str ) – опечатка: не используйте

protect_content ( bool ) – Запретить пересылку и сохранение содержимого сообщения

message_thread_id ( int ) – Топик, в которой сообщение будет отправлено

thumb ( str or telebot.types.InputFile ) – Deprecated. Use thumbnail instead

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

send_game ( chat_id : Union [ int , str ] , game_short_name : str , disable_notification : Optional [ bool ] = None , reply_to_message_id : Optional [ int ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , timeout : Optional [ int ] = None , allow_sending_without_reply : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , message_thread_id : Optional [ int ] = None ) → Message #

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

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

game_short_name ( str ) – Короткое имя игры, служит в качестве уникального id игры. Настройте свои игрычерез @BotFather.

disable_notification ( bool ) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.

reply_to_message_id ( int ) – Если сообщение является ответом — id сообщения, на которое дан ответ

reply_markup ( InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply ) – Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.

timeout ( int ) – Тайм-аут в секундах, ожидание ответа от бота.

allow_sending_without_reply ( bool ) – Передайте True, если сообщение должно быть отправлено даже если одно из сообщений, на которые нужно ответить, не найдено.

protect_content ( bool ) – Передайте True, если содержимое сообщение должно быть защищено от просмотра ботом.

message_thread_id ( int ) – id топика, в который будет отправлено сообщение с игрой.

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

send_invoice ( chat_id : Union [ int , str ] , title : str , description : str , invoice_payload : str , provider_token : str , currency : str , prices : List [ LabeledPrice ] , start_parameter : Optional [ str ] = None , photo_url : Optional [ str ] = None , photo_size : Optional [ int ] = None , photo_width : Optional [ int ] = None , photo_height : Optional [ int ] = None , need_name : Optional [ bool ] = None , need_phone_number : Optional [ bool ] = None , need_email : Optional [ bool ] = None , need_shipping_address : Optional [ bool ] = None , send_phone_number_to_provider : Optional [ bool ] = None , send_email_to_provider : Optional [ bool ] = None , is_flexible : Optional [ bool ] = None , disable_notification : Optional [ bool ] = None , reply_to_message_id : Optional [ int ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , provider_data : Optional [ str ] = None , timeout : Optional [ int ] = None , allow_sending_without_reply : Optional [ bool ] = None , max_tip_amount : Optional [ int ] = None , suggested_tip_amounts : Optional [ List [ int ] ] = None , protect_content : Optional [ bool ] = None , message_thread_id : Optional [ int ] = None ) → Message #

chat_id ( int or str ) – Уникальный id приватного чата

title ( str ) – Название товара, 1-32 символа

description ( str ) – Описание товара, 1-255 символов

invoice_payload ( str ) – Дополнительные данные, 1-128 байт. Не будет показано пользователю, используйте во внутренних процессах.

provider_token ( str ) – Токен платежной системы, полученный через @BotFather

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 ) – Если сообщение является ответом — id сообщения, на которое дан ответ

reply_markup ( str ) – JSON-сериализованный объект inline клавиатуры. Если пустой, будет показана одна кнопка „Pay total price“. Если не пустой, первая кнопка должна быть кнопкой для оплаты

provider_data ( str ) – Данные о инвойсе в формате JSON, которые будут переданы платежной системе. Подробное описание обязательных полей должно быть предоставлено провайдером платежной системы.

timeout ( int ) – Тайм-аут запроса, по умолчанию None

allow_sending_without_reply ( bool ) – Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

max_tip_amount ( int ) – Максимальный размер чаевых в наименьших единицах выбранной валюты

suggested_tip_amounts ( list of int ) – Массив предлагаемых вариантов чаевых в наименьших единицах выбранной валюты в формате JSON. Можно задать не более 4 вариантов. Варианты чаевых должны быть больше нуля, перечисленные в порядке строгого возрастания и не превышать max_tip_amount.

protect_content ( bool ) – Запретить пересылку и сохранение содержимого сообщения

message_thread_id ( int ) – id топика, в который будет отправлен инвойс

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

send_location ( chat_id : Union [ int , str ] , latitude : float , longitude : float , live_period : Optional [ int ] = None , reply_to_message_id : Optional [ int ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , disable_notification : Optional [ bool ] = None , timeout : Optional [ int ] = None , horizontal_accuracy : Optional [ float ] = None , heading : Optional [ int ] = None , proximity_alert_radius : Optional [ int ] = None , allow_sending_without_reply : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , message_thread_id : Optional [ int ] = None ) → Message #

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

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

latitude ( float ) – Широта

longitude ( float ) – Долгота

live_period ( int ) – Время в секундах, в течение которого местоположение будет обновляться (см. Live Locations), должно быть между 60 и 86400.

reply_to_message_id ( int ) – Если сообщение является ответом — id сообщения, на которое дан ответ

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 ) – Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

protect_content ( bool ) – Запретить пересылку и сохранение содержимого сообщения

message_thread_id ( int ) – id топика, в который нужно отправить сообщение

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

send_media_group ( chat_id : Union [ int , str ] , media : List [ Union [ InputMediaAudio , InputMediaDocument , InputMediaPhoto , InputMediaVideo ] ] , disable_notification : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , reply_to_message_id : Optional [ int ] = None , timeout : Optional [ int ] = None , allow_sending_without_reply : Optional [ bool ] = None , message_thread_id : Optional [ int ] = None ) → List [ Message ] #

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

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 ) – Если сообщение является ответом — id сообщения, на которое дан ответ

timeout ( int ) – Таймаут запроса в секундах.

allow_sending_without_reply ( bool ) – Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

message_thread_id ( int ) – id топика, в который будет отправлена группа медиа

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

send_message ( chat_id : Union [ int , str ] , text : str , parse_mode : Optional [ str ] = None , entities : Optional [ List [ MessageEntity ] ] = None , disable_web_page_preview : Optional [ bool ] = None , disable_notification : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , reply_to_message_id : Optional [ int ] = None , allow_sending_without_reply : Optional [ bool ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , timeout : Optional [ int ] = None , message_thread_id : Optional [ int ] = None ) → Message #

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

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

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 ) – Отключает превью ссылок в сообщении

disable_notification ( bool ) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.

protect_content ( bool ) – Если True, содержимое сообщения будет скрыто от всех пользователей, кроме заданного

reply_to_message_id ( int ) – Если сообщение является ответом — id сообщения, на которое дан ответ

allow_sending_without_reply ( bool ) – Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

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 топика, в который нужно отправить сообщение

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

send_photo ( chat_id : Union [ int , str ] , photo : Union [ Any , str ] , caption : Optional [ str ] = None , parse_mode : Optional [ str ] = None , caption_entities : Optional [ List [ MessageEntity ] ] = None , disable_notification : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , reply_to_message_id : Optional [ int ] = None , allow_sending_without_reply : Optional [ bool ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , timeout : Optional [ int ] = None , message_thread_id : Optional [ int ] = None , has_spoiler : Optional [ bool ] = None ) → Message #

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

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 ) – Если сообщение является ответом — id сообщения, на которое дан ответ

allow_sending_without_reply ( bool ) – Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

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, если фото должно быть отправлено как спойлер

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

send_poll ( chat_id : Union [ int , str ] , question : str , options : List [ str ] , is_anonymous : Optional [ bool ] = None , type : Optional [ str ] = None , allows_multiple_answers : Optional [ bool ] = None , correct_option_id : Optional [ int ] = None , explanation : Optional [ str ] = None , explanation_parse_mode : Optional [ str ] = None , open_period : Optional [ int ] = None , close_date : Optional [ Union [ int , datetime ] ] = None , is_closed : Optional [ bool ] = None , disable_notification : Optional [ bool ] = False , reply_to_message_id : Optional [ int ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , allow_sending_without_reply : Optional [ bool ] = None , timeout : Optional [ int ] = None , explanation_entities : Optional [ List [ MessageEntity ] ] = None , protect_content : Optional [ bool ] = None , message_thread_id : Optional [ int ] = None ) → Message #

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

chat_id ( int | str ) – Уникальный id чата или username канала

question ( str ) – Тема опроса, 1-300 символов

options ( list of str ) – JSON-сериализованный список вариантов ответа, 2-10 строк по 1-100 символов

is_anonymous ( bool ) – True, если опрос должен быть анонимным, по умолчанию True

type ( str ) – Вид опроса, “quiz” или “regular”, по умолчанию “regular”

allows_multiple_answers ( bool ) – True, если опрос позволяет выбрать несколько вариантов ответа, игнорируется в опросах вида “quiz”, по умолчанию False

correct_option_id ( int ) – Индекс правильного варианта ответа, начиная с 0. Доступно только для опросов вида “quiz”, по умолчанию None

explanation ( str ) – Текст, который будет показан при выборе неправильно варианта ответа или нажатии на иконку лампочки в опросах вида “quiz”, 0-200 символов и не более 2 строк после форматирования

explanation_parse_mode ( str ) – Режим форматирования explanation. См. formatting options для получения подробностей.

open_period ( int ) – Время в секундах, в течение которого опрос будет активен, 5-600. Нельзя использовать вместо с close_date.

close_date ( int | datetime ) – Время (UNIX timestamp), когда опрос будет автоматически завершен.

is_closed ( bool ) – Передайте True, если опрос должен быть завершен немедленно. Может быть полезно для предпросмотра опроса.

disable_notification ( bool ) – Отправить сообщение, при получении которого пользователи получат уведомление без звука.

reply_to_message_id ( int ) – Если сообщение является ответом — id сообщения, на которое дан ответ

allow_sending_without_reply ( bool ) – Передайте True, если опрос позволяет выбрать несколько вариантов одновременно.

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 топика, в который будет отправлен опрос

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

send_sticker ( chat_id : Union [ int , str ] , sticker : Union [ Any , str ] , reply_to_message_id : Optional [ int ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , disable_notification : Optional [ bool ] = None , timeout : Optional [ int ] = None , allow_sending_without_reply : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , data : Optional [ Union [ str , Any ] ] = None , message_thread_id : Optional [ int ] = None , emoji : Optional [ str ] = None ) → Message #

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

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 ) – Если сообщение является ответом — id сообщения, на которое дан ответ

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 ) – Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

protect_content ( bool ) – Запретить пересылку и сохранение содержимого сообщения

data ( str ) – опечатка: не используйте

message_thread_id ( int ) – Топик, в которой сообщение будет отправлено

emoji ( str ) – Emoji associated with the sticker; only for just uploaded stickers

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

send_venue ( chat_id : Union [ int , str ] , latitude : Optional [ float ] , longitude : Optional [ float ] , title : str , address : str , foursquare_id : Optional [ str ] = None , foursquare_type : Optional [ str ] = None , disable_notification : Optional [ bool ] = None , reply_to_message_id : Optional [ int ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , timeout : Optional [ int ] = None , allow_sending_without_reply : Optional [ bool ] = None , google_place_id : Optional [ str ] = None , google_place_type : Optional [ str ] = None , protect_content : Optional [ bool ] = None , message_thread_id : Optional [ int ] = None ) → Message #

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

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 ) – Если сообщение является ответом — id сообщения, на которое дан ответ

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 ) – Передайте True, если сообщение должно быть отправлено даже если одно из сообщений, на которые нужно ответить, не найдено.

google_place_id ( str ) – id места на Google Places

google_place_type ( str ) – Тип места на Google Places.

protect_content ( bool ) – Запретить пересылку и сохранение содержимого сообщения

message_thread_id ( int ) – id топика, на сообщение из которого нужно ответить

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

send_video ( chat_id : Union [ int , str ] , video : Union [ Any , str ] , duration : Optional [ int ] = None , width : Optional [ int ] = None , height : Optional [ int ] = None , thumbnail : Optional [ Union [ str , Any ] ] = None , caption : Optional [ str ] = None , parse_mode : Optional [ str ] = None , caption_entities : Optional [ List [ MessageEntity ] ] = None , supports_streaming : Optional [ bool ] = None , disable_notification : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , reply_to_message_id : Optional [ int ] = None , allow_sending_without_reply : Optional [ bool ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , timeout : Optional [ int ] = None , data : Optional [ Union [ str , Any ] ] = None , message_thread_id : Optional [ int ] = None , has_spoiler : Optional [ bool ] = None , thumb : Optional [ Union [ str , Any ] ] = None ) → Message #

Используйте этот метод, чтобы отправить видео, клиенты (приложения) Telegram поддерживают mp4 видео (другие форматы могут быть отправлены как Document).

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>.

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 ) – Если сообщение является ответом — id сообщения, на которое дан ответ

allow_sending_without_reply ( bool ) – Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

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

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

send_video_note ( chat_id : Union [ int , str ] , data : Union [ Any , str ] , duration : Optional [ int ] = None , length : Optional [ int ] = None , reply_to_message_id : Optional [ int ] = None , reply_markup : Optional [ Union [ InlineKeyboardMarkup , ReplyKeyboardMarkup , ReplyKeyboardRemove , ForceReply ] ] = None , disable_notification : Optional [ bool ] = None , timeout : Optional [ int ] = None , thumbnail : Optional [ Union [ str , Any ] ] = None , allow_sending_without_reply : Optional [ bool ] = None , protect_content : Optional [ bool ] = None , message_thread_id : Optional [ int ] = None , thumb : Optional [ Union [ str , Any ] ] = None ) → Message #

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

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

param chat_id :

Уникальный id чата или username канала (в формате @channelusername)

type chat_id :

int or str

param data :

Видео заметка для отправки. Передайте file_id (String), чтобы отправить видео заметку, которая уже загружена на сервера Telegram или загрузите новую с помощью multipart/form-data. На текущий момент, отправка видео заметок по URL не поддерживается

type data :

str or telebot.types.InputFile

param duration :

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

type duration :

int

param length :

Ширина и высота видео (диаметр видео сообщения)

type length :

int

param reply_to_message_id :

Если сообщение является ответом — id сообщения, на которое дан ответ

type reply_to_message_id :

int

param reply_markup :

Дополнительные элементы интерфейса. Inline клавиатура, текстовая клавиатура, запрос на удаление текстовой клавиатуры или запрос на ответ от пользователя.

type reply_markup :

telebot.types.InlineKeyboardMarkup or telebot.types.ReplyKeyboardMarkup or telebot.types.ReplyKeyboardRemove or telebot.types.ForceReply

param disable_notification :

Отправить сообщение, при получении которого пользователи получат уведомление без звука.

type disable_notification :

bool

param timeout :

Таймаут запроса в секундах.

type timeout :

int

param thumbnail :

Обложка отправленного файла; может быть проигнорирована, если генерация обложки поддерживается на стороне сервера. Обложка должна быть картинкой в формате JPEG и весить менее 200 kB. Ширина и высота обложки не должны превышать 320. Игнорируется, если файл не загружен с помощью multipart/form-data. Обложки не могут быть использованы повторно и могут быть загружены только как новый файл, так что вы можете передать “attach://<file_attach_name>” если обложка была загружена с помощью multipart/form-data под именем <file_attach_name>.

type thumbnail :

str or telebot.types.InputFile

param allow_sending_without_reply :

Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

type allow_sending_without_reply :

bool

param protect_content :

Запретить пересылку и сохранение содержимого сообщения

type protect_content :

bool

param message_thread_id :

id топика, в который будет отправлена видео заметка

type message_thread_id :

int

param thumb :

Deprecated. Use thumbnail instead

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

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 ) – Если сообщение является ответом — id сообщения, на которое дан ответ

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 ) – Передайте True, если сообщение нужно отправить даже в случае отсутствия сообщения, на которое дан ответ

protect_content ( bool ) – Запретить пересылку и сохранение содержимого сообщения

message_thread_id ( int ) – id топика, в который нужно отправить сообщение

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

set_chat_administrator_custom_title ( chat_id : Union [ int , str ] , user_id : int , custom_title : str ) → bool #

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

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

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

custom_title ( str ) – Новое кастомное звание администратора; 0-16 символов, эмодзи не разрешены

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

set_chat_description ( chat_id : Union [ int , str ] , description : Optional [ str ] = None ) → bool #

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

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

description ( str ) – Str: Новое описание чата, 0-255 символов

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

set_chat_menu_button ( chat_id : Optional [ Union [ int , str ] ] = None , menu_button : Optional [ MenuButton ] = None ) → bool #

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

chat_id ( int or str ) – Уникальный id приватного чата. Если не указан, будет изменена кнопка меню по умолчанию.

menu_button ( telebot.types.MenuButton ) – JSON-сериализованный объект новой кнопки меню. По умолчанию MenuButtonDefault

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

set_chat_permissions ( chat_id : Union [ int , str ] , permissions : ChatPermissions , use_independent_chat_permissions : Optional [ bool ] = None ) → bool #

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

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 в случае успеха

set_chat_photo ( chat_id : Union [ int , str ] , photo : Any ) → bool #

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

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

photo ( typing.Union[file_like, str] ) – InputFile: Новая аватарка чата, загруженная с помощью multipart/form-data

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

set_chat_sticker_set ( chat_id : Union [ int , str ] , sticker_set_name : str ) → StickerSet #

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

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

sticker_set_name ( str ) – Имя стикерпака для установки в качестве стикерпака группы

set_chat_title ( chat_id : Union [ int , str ] , title : str ) → bool #

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

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

title ( str ) – Новое название чата, 1-255 символов

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

set_custom_emoji_sticker_set_thumbnail ( name : str , custom_emoji_id : Optional [ str ] = 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 в случае успеха.

set_game_score ( user_id : Union [ int , str ] , score : int , force : Optional [ bool ] = None , chat_id : Optional [ Union [ int , str ] ] = None , message_id : Optional [ int ] = None , inline_message_id : Optional [ str ] = None , disable_edit_message : Optional [ bool ] = None ) → Union [ Message , bool ] #

Задаёт количество очков пользователя в игре.

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.

set_my_commands ( commands : List [ BotCommand ] , scope : Optional [ BotCommandScope ] = None , language_code : Optional [ str ] = None ) → bool #

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

commands ( list of telebot.types.BotCommand ) – Список объектов BotCommand. Можно задать не более 100 команд.

scope ( telebot.types.BotCommandScope ) – Область видимости команд. По умолчанию BotCommandScopeDefault.

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

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

set_my_default_administrator_rights ( rights : Optional [ ChatAdministratorRights ] = None , for_channels : Optional [ bool ] = None ) → bool #

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

rights ( telebot.types.ChatAdministratorRights ) – JSON-сериалиованный объект, описывающий новые права администратора по умолчанию. Если не указан, права администратора по умолчанию будут сброшены.

for_channels ( bool ) – Передайте True, чтобы изменить права администратора по умолчанию в каналах. Иначе, будут изменены права администратора по умолчанию для групп и супергрупп.

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

set_my_description ( description : Optional [ str ] = None , language_code : Optional [ str ] = 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 в случае успеха.

set_my_name ( name : Optional [ str ] = None , language_code : Optional [ str ] = None ) #

Use this method to change the bot’s name. Returns True on success.

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 в случае успеха.

set_my_short_description ( short_description : Optional [ str ] = None , language_code : Optional [ str ] = 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 в случае успеха.

set_state ( user_id : int , state : Union [ int , str , State ] , chat_id : Optional [ int ] = None ) → None #

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

Вы должны указать и user id и chat id, чтобы задать состояние (стейт) пользователя в чате. Иначе, если вы укажете только user_id, chat_id будет равен user_id, что означает смену состояния (стейта) пользователя в его приватном чате с ботом.

user_id ( int ) – id пользователя

state ( int or str or telebot.types.State ) – новое состояние (стейт). может быть строкой, числом или telebot.types.State

chat_id ( int ) – id чата

set_sticker_emoji_list ( sticker : str , emoji_list : List [ str ] ) → bool #

Use this method to set the emoji list of a custom emoji sticker set. Returns True on success.

sticker ( str ) – Sticker identifier

emoji_list ( list of str ) – List of emoji

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

set_sticker_keywords ( sticker : str , keywords : Optional [ 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.

set_sticker_mask_position ( sticker : str , mask_position : Optional [ 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 в случае успеха.

set_sticker_position_in_set ( sticker : str , position : int ) → bool #

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

sticker ( str ) – id файла стикера

position ( int ) – Новая позиция стикера в стикерпаке, начиная с нуля

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

set_sticker_set_thumb ( ** kwargs ) # set_sticker_set_thumbnail ( name : str , user_id : int , thumbnail : Optional [ Union [ str , Any ] ] = None ) #

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

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.

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

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 в случае успеха.

set_update_listener ( listener : Callable ) #

Задаёт функцию-листенер, которая будет вызвана при получении нового апдейта.

listener (Callable) – Функция-листенер.

set_webhook ( url : Optional [ str ] = None , certificate : Optional [ Union [ str , Any ] ] = None , max_connections : Optional [ int ] = None , allowed_updates : Optional [ List [ str ] ] = None , ip_address : Optional [ str ] = None , drop_pending_updates : Optional [ bool ] = None , timeout : Optional [ int ] = None , secret_token : Optional [ str ] = None ) → bool #

Используйте этот метод, чтобы задать URL и получать входящие апдейты с помощью вебхука. Как только у бота появляется апдейт, он будет отправлен с помощью HTTPS POST запроса на заданный URL, содержащего JSON-сериализованный Update. В случае неудачного запроса, отправка апдейта будет отменена после разумного числа попыток. Возвращает True в случае успеха.

Если вы хотите удостовериться, что вебхук был задан вами, вы можете задать секретный токен в параметре secret_token. Если указан, запрос с апдейтом будет содержать хедер “X-Telegram-Bot-Api-Secret-Token” с секретным токеном в качестве значения.

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 если запрос был успешным.

shipping_query_handler ( func , ** kwargs ) #

Обрабатывает shipping query. Только для инвойсов с гибкой ценой. В качестве параметра передаёт в декорируемую функцию объект telebot.types.ShippingQuery .

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

kwargs – Необязательные именованные аргументы(кастомные фильтры)

Останавливает работу бота и закрывает рабочий пул.

stop_message_live_location ( chat_id : Optional [ Union [ int , str ] ] = None , message_id : Optional [ int ] = None , inline_message_id : Optional [ str ] = None , reply_markup : Optional [ InlineKeyboardMarkup ] = None , timeout : Optional [ int ] = None ) → Message #

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

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 местоположением, которое нужно остановить

timeout ( int ) – Таймаут запроса в секундах.

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

stop_poll ( chat_id : Union [ int , str ] , message_id : int , reply_markup : Optional [ InlineKeyboardMarkup ] = None ) → Poll #

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

chat_id ( int | str ) – Уникальный id чата или username канала

message_id ( int ) – id сообщения с опросом

reply_markup ( InlineKeyboardMarkup ) – JSON-сериализованный объект новой inline клавиатуры.

В случае успеха возвращается завершенный опрос (Poll).

Не принимает никаких аргументов.

unban_chat_member ( chat_id : Union [ int , str ] , user_id : int , only_if_banned : Optional [ bool ] = False ) → bool #

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

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

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

only_if_banned ( bool ) – Ничего не делать, если пользователь не забанен

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

unban_chat_sender_chat ( chat_id : Union [ int , str ] , sender_chat_id : Union [ int , str ] ) → bool #

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

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

sender_chat_id ( int or str ) – Уникальный id чата.

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

unhide_general_forum_topic ( chat_id : Union [ int , str ] ) → bool #

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

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

unpin_all_chat_messages ( chat_id : Union [ int , str ] ) → bool #

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

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

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

unpin_all_forum_topic_messages ( chat_id : Union [ str , int ] , message_thread_id : int ) → bool #

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

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

message_thread_id ( int ) – id топика

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

unpin_chat_message ( chat_id : Union [ int , str ] , message_id : Optional [ int ] = None ) → bool #

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

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

message_id ( int ) – Int: id сообщения, которое нужно открепить

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

upload_sticker_file ( user_id : int , png_sticker : Optional [ Union [ str , Any ] ] = None , sticker : Optional [ InputFile ] = None , sticker_format : Optional [ str ] = None ) → File #

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

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».

В случае успеха возвращается отправленный файл.

Объект User, описывающий бота. Эквивалент bot.get_me(), но результат кэшируется, поэтому нужен всего один запрос к API.

Информация о боте

Файл custom_filters#

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

Базовый класс Advanced Custom Filter. Создайте класс наследник с методом check(). Принимает два параметра, возвращает bool: True — фильтр пройден, False — фильтр не пройден. message: класс Message text: значение фильтра, полученное в хендлере

Классы наследники должны иметь статический атрибут (property) .key

key : str = None # class telebot.custom_filters. ChatFilter #

Проверяет, является ли chat_id заданным.

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

Проверяет, является ли пользователь администратором / владельцем чата.

Фильтр для проверки, состоит ли строка только из цифр.

Проверяет, является ли сообщение ответом (reply).

Проверяет language_code пользователя.

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

Базовый класс Simple Custom Filter. Создайте класс наследник с методом check(). Принимает только сообщение, возвращает bool, который сравнивается с заданным в хендлере.

Классы наследники должны иметь статический атрибут (property) .key

key : str = None # class telebot.custom_filters. StateFilter ( bot ) #

Фильтр для проверки состояния (стейта).

Фильтр для проверки текста сообщения. key: text

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

Advanced текстовый фильтр для проверки (types.Message, types.CallbackQuery, types.InlineQuery, types.Poll)

пример использования в examples/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 – если было задано некорректное значение параметра

class telebot.custom_filters. TextMatchFilter #

Фильтр для проверки текста сообщения.

Фильтр для проверки, начинается ли сообщение с заданного текста.

Файл handler_backends#

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

Базовый класс для middleware. Ваши middleware должны быть унаследованы от этого класса.

Задайте update_sensitive=True если хотите получать разные апдейты в разных функциях. Например, если вы хотите обрабатывать pre_process для апдейтов вида message, вам нужно будет создать функцию pre_process_message и т.д. Аналогично для post_process.

Если вы хотите использовать middleware, вам нужно задать use_class_middlewares=True в экземпляре класса TeleBot.

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

Класс для отмены апдейтов. Просто верните экземпляр этого класса в middleware, чтобы пропустить апдейт. Апдейт пропустит хендлер и исполнение post_process в middleware.

class telebot.handler_backends. ContinueHandling #

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

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

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

Класс для пропуска хендлеров. Просто верните экземпляр этого класса в middleware, чтобы пропустить хендлер. Апдейт попадёт в post_process, но пропустит исполнение хендлера.