Как остановить телеграм бота на python

Как остановить бота в Telegram за 3 секунды?

Знакома ли вам ситуация, когда вы запустили бота в Telegram, решили свою задачу и ушли, а через некоторое время он начинает надоедать вам сообщениями?

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

Почему это происходит?

Чат-бот — это такое же приложение в вашем телефоне, как и любое другое. Мы писали об этом в нашей предыдущей статье.

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

Но иногда разработчики чересчур увлекаются такими уведомлениями, и это начинает раздражать. Как справиться с этим, смотрите ниже в разделе «Настройка уведомлений».

Вторым распространённым случаем являются рекламные сообщения. Не секрет, что для поддержания работоспособности бота и его развития владельцам приходится нести расходы на инфраструктуру, зарплаты, аренду и проч. Если бот не позволяет зарабатывать напрямую, то многие из них прибегают к модели adware, когда приложение остаётся бесплатным, а пользователям время от времени показывается реклама. В большинстве приложений это разумный компромисс, но иногда разработчики перегибают палку, и реклама начинает литься, как из рога изобилия. Помочь с этим могут советы из раздела «Управление рекламой».

Наконец, третьим, и наиболее опасным, случаем является взлом и рассылка уведомлений пользователям бота. Это может произойти как из-за утечки токена авторизации бота, при которой злоумышленник может перехватить контроль над каналом связи с пользователями (дефейс), так и из-за более глубокого взлома. Что нужно делать, если вы с этим столкнулись, описано в главе «Взломанный бот».

Что делать?

Настройка уведомлений

Обычно достаточно предпринять следующие шаги:

1. Перейдите в бота

2. Найдите раздел с настройкой уведомлений (обычно он находится в разделе Account/Профиль или Settings/Настройки)

3. Выберите те уведомления, которые вы хотите получать, и их частоту

Если такого раздела нет, то сделайте следующее:

1. Найдите бота в списке чатов

2. Смахните его влево, чтобы открылись кнопки как на рисунке ниже

3. Нажмите Mute, чтобы перевести уведомления в тихий режим

4. Перейдите на страницу бота в Bots Club и оставьте комментарий разработчикам о большом количестве сообщений

5. Если разработчик долго не отвечает, попробуйте найти его контакт в описании бота в Telegram и написать ему лично

Будьте вежливы и конструктивны — зачастую владельцы ботов будут рады помочь вам и завоевать ваше доверие.

Управление рекламой

Реклама может быть назойливой, это правда. Тем не менее, постарайтесь сохранить хладнокровие и выполнить эти шаги:

1. Переведите бота в тихий режим, как было описано выше

2. Оставьте отзыв с низкой оценкой на странице бота в Bots Club. Динамика рейтинга приложения — очень значимый фактор для разработчиков, и его резкое снижение привлечёт их внимание

3. Если проблема была решена, не забудьте поблагодарить и поставить хорошую оценку

Взломанный бот

Если вам показалось, что бот выглядит не так, как всегда, и был взломан, то вот что нужно сделать:

1. Прекратите использование бота и переведите его в тихий режим

2. Проверьте релиз ноты и комментарии других пользователей на странице бота в Bots Club — возможно, разработчики просто выкатили большое обновление

3. Если подозрения остаются, оставьте отзыв разработчикам — тем самым, вы предупредите других пользователей и дадите своевременный сигнал

Самое главное — помните, что, если бот подвергся дефейсу, он не сможет получить от вас больше информации, чем вы сами ему предоставите. Поэтому при малейших подозрениях просто прекратите использование бота и уведомьте разработчиков!

К чёрту подробности, какая планета?

Если вы всё же решили навсегда прекратить отношения с ботом, остановить его и убрать из своего списка чатов, то вот что нужно делать:

1. Попросите поддержку бота удалить ваш аккаунт. Если его владельцы работают в России или ЕС, они обязаны это сделать по закону.

2. Найдите бота в списке чатов, смахните влево и выберите Delete

3. Выберите Delete and Stop

Через 5 секунд бот будет окончательно остановлен, и история переписки с ним будет удалена из ваших чатов.

Тем не менее, важно понимать, что:

1. История переписки могла остаться на серверах разработчика бота;

2. Если вы не удалили аккаунт через поддержку, то при повторном заходе в бота он вас «узнает» и, зачастую, продолжит с той точки, на которой вы остановились.

Python-сообщество

Пытаюсь создать бота Telegram на python. Этот бот по команде пользователя запускает многопоточность с разными циклами выполнения задачи. Мне необходимо сделать так, чтобы пользователь при вводе команды (в данном случае это /start) с определенным значением, например /start stop (значение stop), останавливал все потоки, а потом снова мог их успешно запустить командой.

#2 Сен. 7, 2020 21:17:18

Как остановить выполнение всех потоков при помощи команды боту Telegram?

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

Как остановить телеграм бота на python

Почему это происходит?

Что делать?

Настройка уведомлений

Обычно достаточно предпринять следующие шаги:

1. Перейдите в бота

2. Найдите раздел с настройкой уведомлений (обычно он находится в разделе Account/Профиль или Settings/Настройки)

3. Выберите те уведомления, которые вы хотите получать, и их частоту

Если такого раздела нет, то сделайте следующее:

1. Найдите бота в списке чатов

2. Смахните его влево, чтобы открылись кнопки как на рисунке ниже

3. Нажмите Mute, чтобы перевести уведомления в тихий режим

4. Перейдите на страницу бота в Bots Club и оставьте комментарий разработчикам о большом количестве сообщений

Будьте вежливы и конструктивны — зачастую владельцы ботов будут рады помочь вам и завоевать ваше доверие.

Управление рекламой

1. Переведите бота в тихий режим, как было описано выше

3. Если проблема была решена, не забудьте поблагодарить и поставить хорошую оценку

Взломанный бот

Если вам показалось, что бот выглядит не так, как всегда, и был взломан, то вот что нужно сделать:

1. Прекратите использование бота и переведите его в тихий режим

Самое главное — помните, что, если бот подвергся дефейсу, он не сможет получить от вас больше информации, чем вы сами ему предоставите. Поэтому при малейших подозрениях просто прекратите использование бота и уведомьте разработчиков!

К чёрту подробности, какая планета?

2. Найдите бота в списке чатов, смахните влево и выберите Delete

3. Выберите Delete and Stop

Через 5 секунд бот будет окончательно остановлен, и история переписки с ним будет удалена из ваших чатов.

Тем не менее, важно понимать, что:

1. История переписки могла остаться на серверах разработчика бота;

Question: How to shutdown properly? #801

I really fear to bring up a question that was answered 1000 times now but since i searched the issues and didn’t find anything related, examples didn’t include anything relevant and i didn’t get a satisfying answer in the telegram group, i have to ask:

How to shutdown the bot without executing another script with
os.execl(os.dirname(__file__) + ‘/shutdown.py’, ‘—‘) ?

Is this really the only way to shutdown? Seems weird (in my case) to create an empty script that is just there to server the purpose to shutdown. I don’t want to dump anything on exit. I would really just like to shutdown cleanly and easily. I can’t imagine that this is such a huge problem.

EDIT: Well, not even the provided example works. I didn’t test it before because it’s not an option for me

telegram.Bot¶

New in version 13.2: Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their bot is equal.

Most bot methods have the argument api_kwargs which allows to pass arbitrary keywords to the Telegram API. This can be used to access new features of the API before they were incorporated into PTB. However, this is not guaranteed to work, i.e. it will fail for passing files.

token ( str ) – Bot’s unique authentication.

base_url ( str , optional) – Telegram Bot API service URL.

base_file_url ( str , optional) – Telegram Bot API file URL.

private_key ( bytes , optional) – Private key for decryption of telegram passport data.

private_key_password ( bytes , optional) – Password for above private key.

defaults ( telegram.ext.Defaults , optional) –

An object containing default values to be used if not set explicitly in the bot methods.

Deprecated since version 13.6: Passing telegram.ext.Defaults to telegram.Bot is deprecated. If you want to use telegram.ext.Defaults , please use telegram.ext.ExtBot instead.

add_sticker_to_set ( user_id , name , emojis , png_sticker = None , mask_position = None , timeout = 20 , tgs_sticker = None , api_kwargs = None , webm_sticker = None ) ¶

Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker , tgs_sticker or webm_sticker . Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers.

As of API 4.7 png_sticker is an optional argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly.

The png_sticker and tgs_sticker argument can be either a file_id, an URL or a file from disk open(filename, ‘rb’)

user_id ( int ) – User identifier of created sticker set owner.

name ( str ) – Sticker set name.

png_sticker ( str | filelike object | bytes | pathlib.Path , optional) –

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

Changed in version 13.2: Accept bytes as input.

tgs_sticker ( str | filelike object | bytes | pathlib.Path , optional) –

TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements.

Changed in version 13.2: Accept bytes as input.

webm_sticker ( str | filelike object | bytes | pathlib.Path , optional) –

WEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements.

New in version 13.11.

emojis ( str ) – One or more emoji corresponding to the sticker.

mask_position ( telegram.MaskPosition , optional) – Position where the mask should be placed on faces.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

answerCallbackQuery ( callback_query_id , text = None , show_alert = False , url = None , cache_time = None , timeout = None , api_kwargs = None ) ¶

answerInlineQuery ( inline_query_id , results , cache_time = 300 , is_personal = None , next_offset = None , switch_pm_text = None , switch_pm_parameter = None , timeout = None , current_offset = None , api_kwargs = None ) ¶

answerPreCheckoutQuery ( pre_checkout_query_id , ok , error_message = None , timeout = None , api_kwargs = None ) ¶

answerShippingQuery ( shipping_query_id , ok , shipping_options = None , error_message = None , timeout = None , api_kwargs = None ) ¶

answerWebAppQuery ( web_app_query_id , result , timeout = None , api_kwargs = None ) ¶

answer_callback_query ( callback_query_id , text = None , show_alert = False , url = None , cache_time = None , timeout = None , api_kwargs = None ) ¶

Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.

callback_query_id ( str ) – Unique identifier for the query to be answered.

text ( str , optional) – Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters.

show_alert ( bool , optional) – If True , an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to False .

url ( str , optional) –

URL that will be opened by the user’s client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game — note that this will only work if the query comes from a callback game button. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.

cache_time ( int , optional) – The maximum amount of time in seconds that the result of the callback query may be cached client-side. Defaults to 0.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

bool On success, True is returned.

answer_inline_query ( inline_query_id , results , cache_time = 300 , is_personal = None , next_offset = None , switch_pm_text = None , switch_pm_parameter = None , timeout = None , current_offset = None , api_kwargs = None ) ¶

Use this method to send answers to an inline query. No more than 50 results per query are allowed.

In most use cases current_offset should not be passed manually. Instead of calling this method directly, use the shortcut telegram.InlineQuery.answer() with auto_pagination=True , which will take care of passing the correct value.

inline_query_id ( str ) – Unique identifier for the answered query.

results (List[ telegram.InlineQueryResult ] | Callable) – A list of results for the inline query. In case current_offset is passed, results may also be a callable that accepts the current page index starting from 0. It must return either a list of telegram.InlineQueryResult instances or None if there are no more results.

cache_time ( int , optional) – The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300 .

is_personal ( bool , optional) – Pass True , if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.

next_offset ( str , optional) – Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don’t support pagination. Offset length can’t exceed 64 bytes.

switch_pm_text ( str , optional) – If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter .

switch_pm_parameter ( str , optional) – Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and — are allowed.

current_offset ( str , optional) – The telegram.InlineQuery.offset of the inline query to answer. If passed, PTB will automatically take care of the pagination for you, i.e. pass the correct next_offset and truncate the results list/get the results from the callable you passed.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a ‘Connect your YouTube account’ button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot’s inline capabilities.

On success, True is returned.

answer_pre_checkout_query ( pre_checkout_query_id , ok , error_message = None , timeout = None , api_kwargs = None ) ¶

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an telegram.Update with the field Update.pre_checkout_query . Use this method to respond to such pre-checkout queries.

The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

pre_checkout_query_id ( str ) – Unique identifier for the query to be answered.

ok ( bool ) – Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.

error_message ( str , optional) – Required if ok is False . Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. “Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!”). Telegram will display this message to the user.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

answer_shipping_query ( shipping_query_id , ok , shipping_options = None , error_message = None , timeout = None , api_kwargs = None ) ¶

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an telegram.Update with a Update.shipping_query field to the bot. Use this method to reply to shipping queries.

shipping_query_id ( str ) – Unique identifier for the query to be answered.

ok ( bool ) – Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible).

shipping_options (List[ telegram.ShippingOption ]) – Required if ok is True . A JSON-serialized array of available shipping options.

error_message ( str , optional) – Required if ok is False . Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”). Telegram will display this message to the user.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

answer_web_app_query ( web_app_query_id , result , timeout = None , api_kwargs = None ) ¶

Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated.

New in version 13.12.

web_app_query_id ( str ) – Unique identifier for the query to be answered.

result ( telegram.InlineQueryResult ) – An object describing the message to be sent.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, a sent telegram.SentWebAppMessage is returned.

approveChatJoinRequest ( chat_id , user_id , timeout = None , api_kwargs = None ) ¶

approve_chat_join_request ( chat_id , user_id , timeout = None , api_kwargs = None ) ¶

Use this method to approve a chat join request.

The bot must be an administrator in the chat for this to work and must have the telegram.ChatPermissions.can_invite_users administrator right.

New in version 13.8.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

user_id ( int ) – Unique identifier of the target user.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

banChatMember ( chat_id , user_id , timeout = None , until_date = None , api_kwargs = None , revoke_messages = None ) ¶

banChatSenderChat ( chat_id , sender_chat_id , timeout = None , api_kwargs = None ) ¶

ban_chat_member ( chat_id , user_id , timeout = None , until_date = None , api_kwargs = None , revoke_messages = None ) ¶

Use this method to ban a user from a group, supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.

New in version 13.7.

chat_id ( int | str ) – Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername ).

user_id ( int ) – Unique identifier of the target user.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

until_date ( int | datetime.datetime , optional) – Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only. For timezone naive datetime.datetime objects, the default timezone of the bot will be used.

revoke_messages ( bool , optional) –

Pass True to delete all messages from the chat for the user that is being removed. If False , the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.

New in version 13.4.

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

ban_chat_sender_chat ( chat_id , sender_chat_id , timeout = None , api_kwargs = None ) ¶

Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won’t be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights.

New in version 13.9.

chat_id ( int | str ) – Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername ).

sender_chat_id ( int ) – Unique identifier of the target sender chat.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

User instance for the bot as returned by get_me() .

close ( timeout = None ) ¶

Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn’t launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

closeForumTopic ( chat_id , message_thread_id , timeout = None , api_kwargs = None ) ¶

close_forum_topic ( chat_id , message_thread_id , timeout = None , api_kwargs = None ) ¶

Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic.

New in version 13.15.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername ).

message_thread_id ( int ) –

Unique identifier for the target message thread of the forum topic.

New in version 13.15.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

Bot’s commands as available in the default scope.

Deprecated since version 13.7: This property has been deprecated since there can be different commands available for different scopes.

copyMessage ( chat_id , from_chat_id , message_id , caption = None , parse_mode = None , caption_entities = None , disable_notification = None , reply_to_message_id = None , allow_sending_without_reply = None , reply_markup = None , timeout = None , api_kwargs = None , protect_content = None , message_thread_id = None ) ¶

copy_message ( chat_id , from_chat_id , message_id , caption = None , parse_mode = None , caption_entities = None , disable_notification = None , reply_to_message_id = None , allow_sending_without_reply = None , reply_markup = None , timeout = None , api_kwargs = None , protect_content = None , message_thread_id = None ) ¶

Use this method to copy messages of any kind. Service messages and invoice messages can’t be copied. The method is analogous to the method forward_message() , but the copied message doesn’t have a link to the original message.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

from_chat_id ( int | str ) – Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername ).

message_id ( int ) – Message identifier in the chat specified in from_chat_id.

caption ( str , optional) – New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept.

parse_mode ( str , optional) – Mode for parsing entities in the new caption. See the constants in telegram.ParseMode for the available modes.

caption_entities ( telegram.utils.types.SLT[MessageEntity] ) – List of special entities that appear in the new caption, which can be specified instead of parse_mode

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

reply_markup ( telegram.ReplyMarkup , optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

createChatInviteLink ( chat_id , expire_date = None , member_limit = None , timeout = None , api_kwargs = None , name = None , creates_join_request = None ) ¶

createForumTopic ( chat_id , name , icon_color = None , icon_custom_emoji_id = None , timeout = None , api_kwargs = None ) ¶

createInvoiceLink ( title , description , payload , provider_token , currency , prices , max_tip_amount = None , suggested_tip_amounts = None , provider_data = None , photo_url = None , photo_size = None , photo_width = None , photo_height = None , need_name = None , need_phone_number = None , need_email = None , need_shipping_address = None , send_phone_number_to_provider = None , send_email_to_provider = None , is_flexible = None , timeout = None , api_kwargs = None ) ¶

createNewStickerSet ( user_id , name , title , emojis , png_sticker = None , contains_masks = None , mask_position = None , timeout = 20 , tgs_sticker = None , api_kwargs = None , webm_sticker = None , sticker_type = None ) ¶

create_chat_invite_link ( chat_id , expire_date = None , member_limit = None , timeout = None , api_kwargs = None , name = None , creates_join_request = None ) ¶

Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The link can be revoked using the method revoke_chat_invite_link() .

New in version 13.4.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

expire_date ( int | datetime.datetime , optional) – Date when the link will expire. Integer input will be interpreted as Unix timestamp. For timezone naive datetime.datetime objects, the default timezone of the bot will be used.

member_limit ( int , optional) – Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

name ( str , optional) –

Invite link name; 0-32 characters.

New in version 13.8.

creates_join_request ( bool , optional) –

True , if users joining the chat via the link need to be approved by chat administrators. If True , member_limit can’t be specified.

New in version 13.8.

create_forum_topic ( chat_id , name , icon_color = None , icon_custom_emoji_id = None , timeout = None , api_kwargs = None ) ¶

Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights.

New in version 13.15.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername ).

name ( str ) – New topic name, 1-128 characters.

icon_color ( int , optional) – Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F)

icon_custom_emoji_id ( str , optional) – New unique identifier of the custom emoji shown as the topic icon. Use get_forum_topic_icon_stickers() to get all allowed custom emoji identifiers.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

create_invoice_link ( title , description , payload , provider_token , currency , prices , max_tip_amount = None , suggested_tip_amounts = None , provider_data = None , photo_url = None , photo_size = None , photo_width = None , photo_height = None , need_name = None , need_phone_number = None , need_email = None , need_shipping_address = None , send_phone_number_to_provider = None , send_email_to_provider = None , is_flexible = None , timeout = None , api_kwargs = None ) ¶

Use this method to create a link for an invoice.

New in version 13.13.

title ( str ) – Product name. 1-32 characters.

description ( str ) – Product description. 1-255 characters.

payload ( str ) – Bot-defined invoice payload. 1-128 bytes. This will not be displayed to the user, use for your internal processes.

provider_token ( str ) –

Payments provider token, obtained via @BotFather.

currency ( str ) – Three-letter ISO 4217 currency code, see more on currencies.

prices (List[ telegram.LabeledPrice ) – Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).

max_tip_amount ( int , optional) – The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145 . See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0 .

suggested_tip_amounts (List[ int ], optional) – An array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount .

provider_data ( str | object , optional) – Data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. When an object is passed, it will be encoded as JSON.

photo_url ( str , optional) – URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.

photo_size ( int , optional) – Photo size in bytes.

photo_width ( int , optional) – Photo width.

photo_height ( int , optional) – Photo height.

need_name ( bool , optional) – Pass True , if you require the user’s full name to complete the order.

need_phone_number ( bool , optional) – Pass True , if you require the user’s phone number to complete the order.

need_email ( bool , optional) – Pass True , if you require the user’s email address to complete the order.

need_shipping_address ( bool , optional) – Pass True , if you require the user’s shipping address to complete the order.

send_phone_number_to_provider ( bool , optional) – Pass True , if user’s phone number should be sent to provider.

send_email_to_provider ( bool , optional) – Pass True , if user’s email address should be sent to provider.

is_flexible ( bool , optional) – Pass True , if the final price depends on the shipping method.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the created invoice link is returned.

create_new_sticker_set ( user_id , name , title , emojis , png_sticker = None , contains_masks = None , mask_position = None , timeout = 20 , tgs_sticker = None , api_kwargs = None , webm_sticker = None , sticker_type = None ) ¶

Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. You must use exactly one of the fields png_sticker , tgs_sticker , or webm_sticker .

As of API 4.7 png_sticker is an optional argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly.

The png_sticker and tgs_sticker argument can be either a file_id, an URL or a file from disk open(filename, ‘rb’)

Changed in version 13.14: The parameter contains_masks has been depreciated as of Bot API 6.2. Use sticker_type instead.

user_id ( int ) – User identifier of created sticker set owner.

name ( str ) – Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can’t contain consecutive underscores and must end in “_by_<bot username>”. <bot_username> is case insensitive. 1-64 characters.

title ( str ) – Sticker set title, 1-64 characters.

png_sticker ( str | filelike object | bytes | pathlib.Path , optional) –

Changed in version 13.2: Accept bytes as input.

tgs_sticker ( str | filelike object | bytes | pathlib.Path , optional) –

TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements.

Changed in version 13.2: Accept bytes as input.

webm_sticker ( str | filelike object | bytes | pathlib.Path , optional) –

WEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements.

New in version 13.11.

emojis ( str ) – One or more emoji corresponding to the sticker.

contains_masks ( bool , optional) – Pass True , if a set of mask stickers should be created.

mask_position ( telegram.MaskPosition , optional) – Position where the mask should be placed on faces.

sticker_type ( str , optional) –

Type of stickers in the set, pass telegram.Sticker.REGULAR or telegram.Sticker.MASK . Custom emoji sticker sets can’t be created via the Bot API at the moment. By default, a regular sticker set is created.

New in version 13.14.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

declineChatJoinRequest ( chat_id , user_id , timeout = None , api_kwargs = None ) ¶

decline_chat_join_request ( chat_id , user_id , timeout = None , api_kwargs = None ) ¶

Use this method to decline a chat join request.

The bot must be an administrator in the chat for this to work and must have the telegram.ChatPermissions.can_invite_users administrator right.

New in version 13.8.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

user_id ( int ) – Unique identifier of the target user.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

deleteChatPhoto ( chat_id , timeout = None , api_kwargs = None ) ¶

deleteChatStickerSet ( chat_id , timeout = None , api_kwargs = None ) ¶

deleteForumTopic ( chat_id , message_thread_id , timeout = None , api_kwargs = None ) ¶

deleteMessage ( chat_id , message_id , timeout = None , api_kwargs = None ) ¶

deleteMyCommands ( scope = None , language_code = None , api_kwargs = None , timeout = None ) ¶

deleteStickerFromSet ( sticker , timeout = None , api_kwargs = None ) ¶

deleteWebhook ( timeout = None , api_kwargs = None , drop_pending_updates = None ) ¶

delete_chat_photo ( chat_id , timeout = None , api_kwargs = None ) ¶

Use this method to delete a chat photo. Photos can’t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

delete_chat_sticker_set ( chat_id , timeout = None , api_kwargs = None ) ¶

Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field telegram.Chat.can_set_sticker_set optionally returned in get_chat() requests to check if the bot can use this method.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

delete_forum_topic ( chat_id , message_thread_id , timeout = None , api_kwargs = None ) ¶

Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_delete_messages() administrator rights.

New in version 13.15.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername ).

message_thread_id ( int ) –

Unique identifier for the target message thread of the forum topic.

New in version 13.15.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

delete_message ( chat_id , message_id , timeout = None , api_kwargs = None ) ¶

Use this method to delete a message, including service messages, with the following limitations:

A message can only be deleted if it was sent less than 48 hours ago.

Service messages about a supergroup, channel, or forum topic creation can’t be deleted.

A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.

Bots can delete outgoing messages in private chats, groups, and supergroups.

Bots can delete incoming messages in private chats.

Bots granted telegram.ChatMember.can_post_messages permissions can delete outgoing messages in channels.

If the bot is an administrator of a group, it can delete any message there.

If the bot has telegram.ChatMember.can_delete_messages permission in a supergroup or a channel, it can delete any message there.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

message_id ( int ) – Identifier of the message to delete.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

delete_my_commands ( scope = None , language_code = None , api_kwargs = None , timeout = None ) ¶

Use this method to delete the list of the bot’s commands for the given scope and user language. After deletion, higher level commands will be shown to affected users.

New in version 13.7.

scope ( telegram.BotCommandScope , optional) – A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to telegram.BotCommandScopeDefault .

language_code ( str , optional) – A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

delete_sticker_from_set ( sticker , timeout = None , api_kwargs = None ) ¶

Use this method to delete a sticker from a set created by the bot.

sticker ( str ) – File identifier of the sticker.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

delete_webhook ( timeout = None , api_kwargs = None , drop_pending_updates = None ) ¶

Use this method to remove webhook integration if you decide to switch back to get_updates() .

drop_pending_updates ( bool , optional) – Pass True to drop all pending updates.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

editChatInviteLink ( chat_id , invite_link , expire_date = None , member_limit = None , timeout = None , api_kwargs = None , name = None , creates_join_request = None ) ¶

editForumTopic ( chat_id , message_thread_id , name , icon_custom_emoji_id , timeout = None , api_kwargs = None ) ¶

editMessageCaption ( chat_id = None , message_id = None , inline_message_id = None , caption = None , reply_markup = None , timeout = None , parse_mode = None , api_kwargs = None , caption_entities = None ) ¶

editMessageLiveLocation ( chat_id = None , message_id = None , inline_message_id = None , latitude = None , longitude = None , location = None , reply_markup = None , timeout = None , api_kwargs = None , horizontal_accuracy = None , heading = None , proximity_alert_radius = None ) ¶

editMessageMedia ( chat_id = None , message_id = None , inline_message_id = None , media = None , reply_markup = None , timeout = None , api_kwargs = None ) ¶

editMessageReplyMarkup ( chat_id = None , message_id = None , inline_message_id = None , reply_markup = None , timeout = None , api_kwargs = None ) ¶

editMessageText ( text , chat_id = None , message_id = None , inline_message_id = None , parse_mode = None , disable_web_page_preview = None , reply_markup = None , timeout = None , api_kwargs = None , entities = None ) ¶

edit_chat_invite_link ( chat_id , invite_link , expire_date = None , member_limit = None , timeout = None , api_kwargs = None , name = None , creates_join_request = None ) ¶

Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.

Though not stated explicitly in the official docs, Telegram changes not only the optional parameters that are explicitly passed, but also replaces all other optional parameters to the default values. However, since not documented, this behaviour may change unbeknown to PTB.

New in version 13.4.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

invite_link ( str ) – The invite link to edit.

expire_date ( int | datetime.datetime , optional) – Date when the link will expire. For timezone naive datetime.datetime objects, the default timezone of the bot will be used.

member_limit ( int , optional) – Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

name ( str , optional) –

Invite link name; 0-32 characters.

New in version 13.8.

creates_join_request ( bool , optional) –

True , if users joining the chat via the link need to be approved by chat administrators. If True , member_limit can’t be specified.

New in version 13.8.

edit_forum_topic ( chat_id , message_thread_id , name , icon_custom_emoji_id , timeout = None , api_kwargs = None ) ¶

Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic.

New in version 13.15.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername ).

message_thread_id ( int ) –

Unique identifier for the target message thread of the forum topic.

New in version 13.15.

name ( str ) – New topic name, 1-128 characters.

icon_custom_emoji_id ( str ) – New unique identifier of the custom emoji shown as the topic icon. Use get_forum_topic_icon_stickers() to get all allowed custom emoji identifiers.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

edit_message_caption ( chat_id = None , message_id = None , inline_message_id = None , caption = None , reply_markup = None , timeout = None , parse_mode = None , api_kwargs = None , caption_entities = None ) ¶

Use this method to edit captions of messages.

chat_id ( int | str , optional) – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername )

message_id ( int , optional) – Required if inline_message_id is not specified. Identifier of the message to edit.

inline_message_id ( str , optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.

caption ( str , optional) – New caption of the message, 0-1024 characters after entities parsing.

parse_mode ( str , optional) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the constants in telegram.ParseMode for the available modes.

caption_entities (List[ telegram.MessageEntity ], optional) – List of special entities that appear in message text, which can be specified instead of parse_mode .

reply_markup ( telegram.InlineKeyboardMarkup , optional) – A JSON-serialized object for an inline keyboard.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, if edited message is not an inline message, the edited message is returned, otherwise True is returned.

edit_message_live_location ( chat_id = None , message_id = None , inline_message_id = None , latitude = None , longitude = None , location = None , reply_markup = None , timeout = None , api_kwargs = None , horizontal_accuracy = None , heading = None , proximity_alert_radius = None ) ¶

Use this method to edit live location messages sent by the bot or via the bot (for inline bots). A location can be edited until its telegram.Location.live_period expires or editing is explicitly disabled by a call to stop_message_live_location() .

You can either supply a latitude and longitude or a location .

chat_id ( int | str , optional) – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

message_id ( int , optional) – Required if inline_message_id is not specified. Identifier of the message to edit.

inline_message_id ( str , optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.

latitude ( float , optional) – Latitude of location.

longitude ( float , optional) – Longitude of location.

location ( telegram.Location , optional) – The location to send.

horizontal_accuracy ( float , optional) – The radius of uncertainty for the location, measured in meters; 0-1500.

heading ( int , optional) – Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

proximity_alert_radius ( int , optional) – Maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

reply_markup ( telegram.InlineKeyboardMarkup , optional) – A JSON-serialized object for a new inline keyboard.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, if edited message is not an inline message, the edited message is returned, otherwise True is returned.

edit_message_media ( chat_id = None , message_id = None , inline_message_id = None , media = None , reply_markup = None , timeout = None , api_kwargs = None ) ¶

Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can’t be uploaded. Use a previously uploaded file via its file_id or specify a URL.

chat_id ( int | str , optional) – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

message_id ( int , optional) – Required if inline_message_id is not specified. Identifier of the message to edit.

inline_message_id ( str , optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.

media ( telegram.InputMedia ) – An object for a new media content of the message.

reply_markup ( telegram.InlineKeyboardMarkup , optional) – A JSON-serialized object for an inline keyboard.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.

edit_message_reply_markup ( chat_id = None , message_id = None , inline_message_id = None , reply_markup = None , timeout = None , api_kwargs = None ) ¶

Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots).

chat_id ( int | str , optional) – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

message_id ( int , optional) – Required if inline_message_id is not specified. Identifier of the message to edit.

inline_message_id ( str , optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.

reply_markup ( telegram.InlineKeyboardMarkup , optional) – A JSON-serialized object for an inline keyboard.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, if edited message is not an inline message, the edited message is returned, otherwise True is returned.

edit_message_text ( text , chat_id = None , message_id = None , inline_message_id = None , parse_mode = None , disable_web_page_preview = None , reply_markup = None , timeout = None , api_kwargs = None , entities = None ) ¶

Use this method to edit text and game messages.

chat_id ( int | str , optional) – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername )

message_id ( int , optional) – Required if inline_message_id is not specified. Identifier of the message to edit.

inline_message_id ( str , optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.

text ( str ) – New text of the message, 1-4096 characters after entities parsing.

parse_mode ( str , optional) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot’s message. See the constants in telegram.ParseMode for the available modes.

entities (List[ telegram.MessageEntity ], optional) – List of special entities that appear in message text, which can be specified instead of parse_mode .

disable_web_page_preview ( bool , optional) – Disables link previews for links in this message.

reply_markup ( telegram.InlineKeyboardMarkup , optional) – A JSON-serialized object for an inline keyboard.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, if edited message is not an inline message, the edited message is returned, otherwise True is returned.

exportChatInviteLink ( chat_id , timeout = None , api_kwargs = None ) ¶

export_chat_invite_link ( chat_id , timeout = None , api_kwargs = None ) ¶

Use this method to generate a new primary invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

Each administrator in a chat generates their own invite links. Bots can’t use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using export_chat_invite_link() or by calling the get_chat() method. If your bot needs to generate a new primary invite link replacing its previous one, use export_chat_invite_link again.

New invite link on success.

Bot’s first name.

forwardMessage ( chat_id , from_chat_id , message_id , disable_notification = None , timeout = None , api_kwargs = None , protect_content = None , message_thread_id = None ) ¶

forward_message ( chat_id , from_chat_id , message_id , disable_notification = None , timeout = None , api_kwargs = None , protect_content = None , message_thread_id = None ) ¶

Use this method to forward messages of any kind. Service messages can’t be forwarded.

Since the release of Bot API 5.5 it can be impossible to forward messages from some chats. Use the attributes telegram.Message.has_protected_content and telegram.Chat.has_protected_content to check this.

As a workaround, it is still possible to use copy_message() . However, this behaviour is undocumented and might be changed by Telegram.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

from_chat_id ( int | str ) – Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername ).

message_id ( int ) – Message identifier in the chat specified in from_chat_id.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent Message is returned.

getChat ( chat_id , timeout = None , api_kwargs = None ) ¶

getChatAdministrators ( chat_id , timeout = None , api_kwargs = None ) ¶

getChatMember ( chat_id , user_id , timeout = None , api_kwargs = None ) ¶

getChatMemberCount ( chat_id , timeout = None , api_kwargs = None ) ¶

getChatMembersCount ( chat_id , timeout = None , api_kwargs = None ) ¶

getChatMenuButton ( chat_id = None , timeout = None , api_kwargs = None ) ¶

getCustomEmojiStickers ( custom_emoji_ids , * , timeout = None , api_kwargs = None ) ¶

getFile ( file_id , timeout = None , api_kwargs = None ) ¶

getForumTopicIconStickers ( timeout = None , api_kwargs = None ) ¶

getGameHighScores ( user_id , chat_id = None , message_id = None , inline_message_id = None , timeout = None , api_kwargs = None ) ¶

getMe ( timeout = None , api_kwargs = None ) ¶

getMyCommands ( timeout = None , api_kwargs = None , scope = None , language_code = None ) ¶

getMyDefaultAdministratorRights ( for_channels = None , timeout = None , api_kwargs = None ) ¶

getStickerSet ( name , timeout = None , api_kwargs = None ) ¶

getUpdates ( offset = None , limit = 100 , timeout = 0 , read_latency = 2.0 , allowed_updates = None , api_kwargs = None ) ¶

getUserProfilePhotos ( user_id , offset = None , limit = 100 , timeout = None , api_kwargs = None ) ¶

getWebhookInfo ( timeout = None , api_kwargs = None ) ¶

get_chat ( chat_id , timeout = None , api_kwargs = None ) ¶

Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.).

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername ).

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

get_chat_administrators ( chat_id , timeout = None , api_kwargs = None ) ¶

Use this method to get a list of administrators in a chat.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername ).

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, returns a list of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.

get_chat_member ( chat_id , user_id , timeout = None , api_kwargs = None ) ¶

Use this method to get information about a member of a chat.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername ).

user_id ( int ) – Unique identifier of the target user.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

get_chat_member_count ( chat_id , timeout = None , api_kwargs = None ) ¶

Use this method to get the number of members in a chat.

New in version 13.7.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername ).

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

Number of members in the chat.

get_chat_members_count ( chat_id , timeout = None , api_kwargs = None ) ¶

Deprecated since version 13.7.

Use this method to get the current value of the bot’s menu button in a private chat, or the default menu button.

New in version 13.12.

chat_id ( int , optional) – Unique identifier for the target private chat. If not specified, default bot’s menu button will be returned.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the current menu button is returned.

get_custom_emoji_stickers ( custom_emoji_ids , * , timeout = None , api_kwargs = None ) ¶

Use this method to get information about emoji stickers by their identifiers.

New in version 13.14.

custom_emoji_ids (List[ str ]) – List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

get_file ( file_id , timeout = None , api_kwargs = None ) ¶

Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. The file can then be downloaded with telegram.File.download() . It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling get_file again.

This function may not preserve the original file name and MIME type. You should save the file’s MIME type and name (if available) when the File object is received.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

get_forum_topic_icon_stickers ( timeout = None , api_kwargs = None ) ¶ Use this method to get custom emoji stickers, which can be used as a forum topic

icon by any user. Requires no parameters.

New in version 13.15.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

get_game_high_scores ( user_id , chat_id = None , message_id = None , inline_message_id = None , timeout = None , api_kwargs = None ) ¶

Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game.

This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change.

user_id ( int ) – Target user id.

chat_id ( int | str , optional) – Required if inline_message_id is not specified. Unique identifier for the target chat.

message_id ( int , optional) – Required if inline_message_id is not specified. Identifier of the sent message.

inline_message_id ( str , optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

get_me ( timeout = None , api_kwargs = None ) ¶

A simple method for testing your bot’s auth token. Requires no parameters.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

A telegram.User instance representing that bot if the credentials are valid, None otherwise.

get_my_commands ( timeout = None , api_kwargs = None , scope = None , language_code = None ) ¶

Use this method to get the current list of the bot’s commands for the given scope and user language.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

A JSON-serialized object, describing scope of users. Defaults to telegram.BotCommandScopeDefault .

New in version 13.7.

language_code ( str , optional) –

A two-letter ISO 639-1 language code or an empty string.

New in version 13.7.

On success, the commands set for the bot. An empty list is returned if commands are not set.

get_my_default_administrator_rights ( for_channels = None , timeout = None , api_kwargs = None ) ¶

Use this method to get the current default administrator rights of the bot.

New in version 13.12.

for_channels ( bool , optional) – Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

get_sticker_set ( name , timeout = None , api_kwargs = None ) ¶

Use this method to get a sticker set.

name ( str ) – Name of the sticker set.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

get_updates ( offset = None , limit = 100 , timeout = 0 , read_latency = 2.0 , allowed_updates = None , api_kwargs = None ) ¶

Use this method to receive incoming updates using long polling.

offset ( int , optional) – Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its telegram.Update.update_id . The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.

limit ( int , optional) – Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100 .

timeout ( int , optional) – Timeout in seconds for long polling. Defaults to 0 , i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.

read_latency ( float | int , optional) – Grace time in seconds for receiving the reply from server. Will be added to the timeout value and used as the read timeout from server. Defaults to 2 .

allowed_updates (List[ str ]), optional) – A JSON-serialized list the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See telegram.Update for a complete list of available update types. Specify an empty list to receive all updates except telegram.Update.chat_member (default). If not specified, the previous setting will be used. Please note that this parameter doesn’t affect updates created before the call to the get_updates, so unwanted updates may be received for a short period of time.

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

This method will not work if an outgoing webhook is set up.

In order to avoid getting duplicate updates, recalculate offset after each server response.

To take full advantage of this library take a look at telegram.ext.Updater

get_user_profile_photos ( user_id , offset = None , limit = 100 , timeout = None , api_kwargs = None ) ¶

Use this method to get a list of profile pictures for a user.

user_id ( int ) – Unique identifier of the target user.

offset ( int , optional) – Sequential number of the first photo to be returned. By default, all photos are returned.

limit ( int , optional) – Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100 .

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

get_webhook_info ( timeout = None , api_kwargs = None ) ¶

Use this method to get current webhook status. Requires no parameters.

If the bot is using get_updates() , will return an object with the telegram.WebhookInfo.url field empty.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

Unique identifier for this bot.

kickChatMember ( chat_id , user_id , timeout = None , until_date = None , api_kwargs = None , revoke_messages = None ) ¶

kick_chat_member ( chat_id , user_id , timeout = None , until_date = None , api_kwargs = None , revoke_messages = None ) ¶

Deprecated, use ban_chat_member() instead.

Deprecated since version 13.7.

Optional. Bot’s last name.

leaveChat ( chat_id , timeout = None , api_kwargs = None ) ¶

leave_chat ( chat_id , timeout = None , api_kwargs = None ) ¶

Use this method for your bot to leave a group, supergroup or channel.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername ).

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

Convenience property. Returns the t.me link of the bot.

logOut ( timeout = None ) ¶

log_out ( timeout = None ) ¶

Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

pinChatMessage ( chat_id , message_id , disable_notification = None , timeout = None , api_kwargs = None ) ¶

pin_chat_message ( chat_id , message_id , disable_notification = None , timeout = None , api_kwargs = None ) ¶

Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the telegram.ChatMember.can_pin_messages admin right in a supergroup or telegram.ChatMember.can_edit_messages admin right in a channel.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

message_id ( int ) – Identifier of a message to pin.

disable_notification ( bool , optional) – Pass True , if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

promoteChatMember ( chat_id , user_id , can_change_info = None , can_post_messages = None , can_edit_messages = None , can_delete_messages = None , can_invite_users = None , can_restrict_members = None , can_pin_messages = None , can_promote_members = None , timeout = None , api_kwargs = None , is_anonymous = None , can_manage_chat = None , can_manage_voice_chats = None , can_manage_video_chats = None , can_manage_topics = None ) ¶

promote_chat_member ( chat_id , user_id , can_change_info = None , can_post_messages = None , can_edit_messages = None , can_delete_messages = None , can_invite_users = None , can_restrict_members = None , can_pin_messages = None , can_promote_members = None , timeout = None , api_kwargs = None , is_anonymous = None , can_manage_chat = None , can_manage_voice_chats = None , can_manage_video_chats = None , can_manage_topics = None ) ¶

Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

user_id ( int ) – Unique identifier of the target user.

is_anonymous ( bool , optional) – Pass True , if the administrator’s presence in the chat is hidden.

can_manage_chat ( bool , optional) –

Pass True , if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege.

New in version 13.4.

can_manage_voice_chats ( bool , optional) –

Pass True , if the administrator can manage voice chats.

New in version 13.4.

Deprecated since version 13.12: Since Bot API 6.0, voice chat was renamed to video chat.

can_manage_video_chats ( bool , optional) –

Pass True , if the administrator can manage video chats.

New in version 13.12.

can_change_info ( bool , optional) – Pass True , if the administrator can change chat title, photo and other settings.

can_post_messages ( bool , optional) – Pass True , if the administrator can create channel posts, channels only.

can_edit_messages ( bool , optional) – Pass True , if the administrator can edit messages of other users and can pin messages, channels only.

can_delete_messages ( bool , optional) – Pass True , if the administrator can delete messages of other users.

can_invite_users ( bool , optional) – Pass True , if the administrator can invite new users to the chat.

can_restrict_members ( bool , optional) – Pass True , if the administrator can restrict, ban or unban chat members.

can_pin_messages ( bool , optional) – Pass True , if the administrator can pin messages, supergroups only.

can_promote_members ( bool , optional) – Pass True , if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him).

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

can_manage_topics ( bool , optional) –

Pass True , if the user is allowed to create, rename, close, and reopen forum topics; supergroups only.

New in version 13.15.

On success, True is returned.

reopenForumTopic ( chat_id , message_thread_id , timeout = None , api_kwargs = None ) ¶

reopen_forum_topic ( chat_id , message_thread_id , timeout = None , api_kwargs = None ) ¶

Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics() administrator rights, unless it is the creator of the topic.

New in version 13.15.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername ).

message_thread_id ( int ) –

Unique identifier for the target message thread of the forum topic.

New in version 13.15.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

restrictChatMember ( chat_id , user_id , permissions , until_date = None , timeout = None , api_kwargs = None ) ¶

restrict_chat_member ( chat_id , user_id , permissions , until_date = None , timeout = None , api_kwargs = None ) ¶

Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all boolean parameters to lift restrictions from a user.

Since Bot API 4.4, restrict_chat_member() takes the new user permissions in a single argument of type telegram.ChatPermissions . The old way of passing parameters will not keep working forever.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).

user_id ( int ) – Unique identifier of the target user.

until_date ( int | datetime.datetime , optional) – Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever. For timezone naive datetime.datetime objects, the default timezone of the bot will be used.

permissions ( telegram.ChatPermissions ) – A JSON-serialized object for new user permissions.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

revokeChatInviteLink ( chat_id , invite_link , timeout = None , api_kwargs = None ) ¶

revoke_chat_invite_link ( chat_id , invite_link , timeout = None , api_kwargs = None ) ¶

Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.

New in version 13.4.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

invite_link ( str ) – The invite link to edit.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

sendAnimation ( chat_id , animation , duration = None , width = None , height = None , thumb = None , caption = None , parse_mode = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , api_kwargs = None , allow_sending_without_reply = None , caption_entities = None , filename = None , protect_content = None , message_thread_id = None ) ¶

sendAudio ( chat_id , audio , duration = None , performer = None , title = None , caption = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , parse_mode = None , thumb = None , api_kwargs = None , allow_sending_without_reply = None , caption_entities = None , filename = None , protect_content = None , message_thread_id = None ) ¶

sendChatAction ( chat_id , action , timeout = None , api_kwargs = None ) ¶

sendContact ( chat_id , phone_number = None , first_name = None , last_name = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , contact = None , vcard = None , api_kwargs = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

sendDice ( chat_id , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , emoji = None , api_kwargs = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

sendDocument ( chat_id , document , filename = None , caption = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , parse_mode = None , thumb = None , api_kwargs = None , disable_content_type_detection = None , allow_sending_without_reply = None , caption_entities = None , protect_content = None , message_thread_id = None ) ¶

sendGame ( chat_id , game_short_name , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , api_kwargs = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

sendInvoice ( chat_id , title , description , payload , provider_token , currency , prices , start_parameter = None , photo_url = None , photo_size = None , photo_width = None , photo_height = None , need_name = None , need_phone_number = None , need_email = None , need_shipping_address = None , is_flexible = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , provider_data = None , send_phone_number_to_provider = None , send_email_to_provider = None , timeout = None , api_kwargs = None , allow_sending_without_reply = None , max_tip_amount = None , suggested_tip_amounts = None , protect_content = None , message_thread_id = None ) ¶

sendLocation ( chat_id , latitude = None , longitude = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , location = None , live_period = None , api_kwargs = None , horizontal_accuracy = None , heading = None , proximity_alert_radius = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

sendMediaGroup ( chat_id , media , disable_notification = None , reply_to_message_id = None , timeout = 20 , api_kwargs = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

sendMessage ( chat_id , text , parse_mode = None , disable_web_page_preview = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , api_kwargs = None , allow_sending_without_reply = None , entities = None , protect_content = None , message_thread_id = None ) ¶

sendPhoto ( chat_id , photo , caption = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , parse_mode = None , api_kwargs = None , allow_sending_without_reply = None , caption_entities = None , filename = None , protect_content = None , message_thread_id = None ) ¶

sendPoll ( chat_id , question , options , is_anonymous = True , type = ‘regular’ , allows_multiple_answers = False , correct_option_id = None , is_closed = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , explanation = None , explanation_parse_mode = None , open_period = None , close_date = None , api_kwargs = None , allow_sending_without_reply = None , explanation_entities = None , protect_content = None , message_thread_id = None ) ¶

sendSticker ( chat_id , sticker , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , api_kwargs = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

sendVenue ( chat_id , latitude = None , longitude = None , title = None , address = None , foursquare_id = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , venue = None , foursquare_type = None , api_kwargs = None , google_place_id = None , google_place_type = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

sendVideo ( chat_id , video , duration = None , caption = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , width = None , height = None , parse_mode = None , supports_streaming = None , thumb = None , api_kwargs = None , allow_sending_without_reply = None , caption_entities = None , filename = None , protect_content = None , message_thread_id = None ) ¶

sendVideoNote ( chat_id , video_note , duration = None , length = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , thumb = None , api_kwargs = None , allow_sending_without_reply = None , filename = None , protect_content = None , message_thread_id = None ) ¶

sendVoice ( chat_id , voice , duration = None , caption = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , parse_mode = None , api_kwargs = None , allow_sending_without_reply = None , caption_entities = None , filename = None , protect_content = None , message_thread_id = None ) ¶

send_animation ( chat_id , animation , duration = None , width = None , height = None , thumb = None , caption = None , parse_mode = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , api_kwargs = None , allow_sending_without_reply = None , caption_entities = None , filename = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

thumb will be ignored for small files, for which Telegram can easily generate thumbnails. However, this behaviour is undocumented and might be changed by Telegram.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

animation ( str | filelike object | bytes | pathlib.Path | telegram.Animation ) –

Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. Lastly you can pass an existing telegram.Animation object to send.

Changed in version 13.2: Accept bytes as input.

filename ( str , optional) –

Custom file name for the animation, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the tempfile module.

New in version 13.1.

duration ( int , optional) – Duration of sent animation in seconds.

width ( int , optional) – Animation width.

height ( int , optional) – Animation height.

thumb ( filelike object | bytes | pathlib.Path , optional) –

Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file.

Changed in version 13.2: Accept bytes as input.

caption ( str , optional) – Animation caption (may also be used when resending animations by file_id), 0-1024 characters after entities parsing.

caption_entities (List[ telegram.MessageEntity ], optional) – List of special entities that appear in message text, which can be specified instead of parse_mode .

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

timeout ( int | float , optional) – Send file timeout (default: 20 seconds).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent Message is returned.

send_audio ( chat_id , audio , duration = None , performer = None , title = None , caption = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , parse_mode = None , thumb = None , api_kwargs = None , allow_sending_without_reply = None , caption_entities = None , filename = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .mp3 or .m4a format.

Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

For sending voice messages, use the send_voice() method instead.

The audio argument can be either a file_id, an URL or a file from disk open(filename, ‘rb’)

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

audio ( str | filelike object | bytes | pathlib.Path | telegram.Audio ) –

Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. Lastly you can pass an existing telegram.Audio object to send.

Changed in version 13.2: Accept bytes as input.

filename ( str , optional) –

Custom file name for the audio, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the tempfile module.

New in version 13.1.

caption ( str , optional) – Audio caption, 0-1024 characters after entities parsing.

caption_entities (List[ telegram.MessageEntity ], optional) – List of special entities that appear in message text, which can be specified instead of parse_mode .

duration ( int , optional) – Duration of sent audio in seconds.

performer ( str , optional) – Performer.

title ( str , optional) – Track name.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

thumb ( filelike object | bytes | pathlib.Path , optional) –

Changed in version 13.2: Accept bytes as input.

timeout ( int | float , optional) – Send file timeout (default: 20 seconds).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent Message is returned.

send_chat_action ( chat_id , action , timeout = None , api_kwargs = None ) ¶

Use this method when you need to tell the user that something is happening on the bot’s side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Telegram only recommends using this method when a response from the bot will take a noticeable amount of time to arrive.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

action ( telegram.ChatAction | str ) – Type of action to broadcast. Choose one, depending on what the user is about to receive. For convenience look at the constants in telegram.ChatAction

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

send_contact ( chat_id , phone_number = None , first_name = None , last_name = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , contact = None , vcard = None , api_kwargs = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send phone contacts.

You can either supply contact or phone_number and first_name with optionally last_name and optionally vcard .

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

phone_number ( str , optional) – Contact’s phone number.

first_name ( str , optional) – Contact’s first name.

last_name ( str , optional) – Contact’s last name.

vcard ( str , optional) – Additional data about the contact in the form of a vCard, 0-2048 bytes.

contact ( telegram.Contact , optional) – The contact to send.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent Message is returned.

send_dice ( chat_id , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , emoji = None , api_kwargs = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send an animated emoji that will display a random value.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

emoji ( str , optional) –

Changed in version 13.4: Added the “��” emoji.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

On success, the sent Message is returned.

send_document ( chat_id , document , filename = None , caption = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , parse_mode = None , thumb = None , api_kwargs = None , disable_content_type_detection = None , allow_sending_without_reply = None , caption_entities = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send general files.

Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

The document argument can be either a file_id, an URL or a file from disk open(filename, ‘rb’)

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

document ( str | filelike object | bytes | pathlib.Path | telegram.Document ) –

File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), 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. Lastly you can pass an existing telegram.Document object to send.

Changed in version 13.2: Accept bytes as input.

filename ( str , optional) – Custom file name for the document, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the tempfile module.

caption ( str , optional) – Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing.

disable_content_type_detection ( bool , optional) – Disables automatic server-side content type detection for files uploaded using multipart/form-data.

caption_entities (List[ telegram.MessageEntity ], optional) – List of special entities that appear in message text, which can be specified instead of parse_mode .

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

thumb ( filelike object | bytes | pathlib.Path , optional) –

Changed in version 13.2: Accept bytes as input.

timeout ( int | float , optional) – Send file timeout (default: 20 seconds).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent Message is returned.

send_game ( chat_id , game_short_name , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , api_kwargs = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send a game.

chat_id ( int | str ) – Unique identifier for the target chat.

game_short_name ( str ) –

Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

reply_markup ( telegram.InlineKeyboardMarkup , optional) – A JSON-serialized object for a new inline keyboard. If empty, one ‘Play game_title’ button will be shown. If not empty, the first button must launch the game.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent Message is returned.

send_invoice ( chat_id , title , description , payload , provider_token , currency , prices , start_parameter = None , photo_url = None , photo_size = None , photo_width = None , photo_height = None , need_name = None , need_phone_number = None , need_email = None , need_shipping_address = None , is_flexible = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , provider_data = None , send_phone_number_to_provider = None , send_email_to_provider = None , timeout = None , api_kwargs = None , allow_sending_without_reply = None , max_tip_amount = None , suggested_tip_amounts = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send invoices.

As of API 5.2 start_parameter is an optional argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly.

Changed in version 13.5: As of Bot API 5.2, the parameter start_parameter is optional.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

title ( str ) – Product name, 1-32 characters.

description ( str ) – Product description, 1-255 characters.

payload ( str ) – Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

provider_token ( str ) –

Payments provider token, obtained via @BotFather.

currency ( str ) – Three-letter ISO 4217 currency code.

prices (List[ telegram.LabeledPrice ) – Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).

max_tip_amount ( int , optional) –

The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145 . See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0 .

New in version 13.5.

suggested_tip_amounts (List[ int ], optional) –

A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount .

New in version 13.5.

start_parameter ( str , optional) –

Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter.

Changed in version 13.5: As of Bot API 5.2, this parameter is optional.

provider_data ( str | object , optional) – JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. When an object is passed, it will be encoded as JSON.

photo_url ( str , optional) – URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.

photo_size ( str , optional) – Photo size.

photo_width ( int , optional) – Photo width.

photo_height ( int , optional) – Photo height.

need_name ( bool , optional) – Pass True , if you require the user’s full name to complete the order.

need_phone_number ( bool , optional) – Pass True , if you require the user’s phone number to complete the order.

need_email ( bool , optional) – Pass True , if you require the user’s email to complete the order.

need_shipping_address ( bool , optional) – Pass True , if you require the user’s shipping address to complete the order.

send_phone_number_to_provider ( bool , optional) – Pass True , if user’s phone number should be sent to provider.

send_email_to_provider ( bool , optional) – Pass True , if user’s email address should be sent to provider.

is_flexible ( bool , optional) – Pass True , if the final price depends on the shipping method.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

On success, the sent Message is returned.

send_location ( chat_id , latitude = None , longitude = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , location = None , live_period = None , api_kwargs = None , horizontal_accuracy = None , heading = None , proximity_alert_radius = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send point on the map.

You can either supply a latitude and longitude or a location .

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

latitude ( float , optional) – Latitude of location.

longitude ( float , optional) – Longitude of location.

location ( telegram.Location , optional) – The location to send.

horizontal_accuracy ( int , optional) – The radius of uncertainty for the location, measured in meters; 0-1500.

live_period ( int , optional) – Period in seconds for which the location will be updated, should be between 60 and 86400.

heading ( int , optional) – For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

proximity_alert_radius ( int , optional) – For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

On success, the sent Message is returned.

send_media_group ( chat_id , media , disable_notification = None , reply_to_message_id = None , timeout = 20 , api_kwargs = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send a group of photos or videos as an album.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

timeout ( int | float , optional) – Send file timeout (default: 20 seconds).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

An array of the sent Messages.

send_message ( chat_id , text , parse_mode = None , disable_web_page_preview = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , api_kwargs = None , allow_sending_without_reply = None , entities = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send text messages.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

text ( str ) – Text of the message to be sent. Max 4096 characters after entities parsing. Also found as telegram.constants.MAX_MESSAGE_LENGTH .

parse_mode ( str ) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot’s message. See the constants in telegram.ParseMode for the available modes.

entities (List[ telegram.MessageEntity ], optional) – List of special entities that appear in message text, which can be specified instead of parse_mode .

disable_web_page_preview ( bool , optional) – Disables link previews for links in this message.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of sent messages from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent message is returned.

send_photo ( chat_id , photo , caption = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , parse_mode = None , api_kwargs = None , allow_sending_without_reply = None , caption_entities = None , filename = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send photos.

The photo argument can be either a file_id, an URL or a file from disk open(filename, ‘rb’)

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

photo ( str | filelike object | bytes | pathlib.Path | telegram.PhotoSize ) –

Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. Lastly you can pass an existing telegram.PhotoSize object to send.

Changed in version 13.2: Accept bytes as input.

filename ( str , optional) –

Custom file name for the photo, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the tempfile module.

New in version 13.1.

caption ( str , optional) – Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing.

caption_entities (List[ telegram.MessageEntity ], optional) – List of special entities that appear in message text, which can be specified instead of parse_mode .

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

timeout ( int | float , optional) – Send file timeout (default: 20 seconds).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent Message is returned.

send_poll ( chat_id , question , options , is_anonymous = True , type = ‘regular’ , allows_multiple_answers = False , correct_option_id = None , is_closed = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , explanation = None , explanation_parse_mode = None , open_period = None , close_date = None , api_kwargs = None , allow_sending_without_reply = None , explanation_entities = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send a native poll.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

question ( str ) – Poll question, 1-300 characters.

options (List[ str ]) – List of answer options, 2-10 strings 1-100 characters each.

is_anonymous ( bool , optional) – True , if the poll needs to be anonymous, defaults to True .

type ( str , optional) – Poll type, telegram.Poll.QUIZ or telegram.Poll.REGULAR , defaults to telegram.Poll.REGULAR .

allows_multiple_answers ( bool , optional) – True , if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False .

correct_option_id ( int , optional) – 0-based identifier of the correct answer option, required for polls in quiz mode.

explanation ( str , optional) – Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing.

explanation_parse_mode ( str , optional) – Mode for parsing entities in the explanation. See the constants in telegram.ParseMode for the available modes.

explanation_entities (List[ telegram.MessageEntity ], optional) – List of special entities that appear in message text, which can be specified instead of parse_mode .

open_period ( int , optional) – Amount of time in seconds the poll will be active after creation, 5-600. Can’t be used together with close_date .

close_date ( int | datetime.datetime , optional) – Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can’t be used together with open_period . For timezone naive datetime.datetime objects, the default timezone of the bot will be used.

is_closed ( bool , optional) – Pass True , if the poll needs to be immediately closed. This can be useful for poll preview.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent Message is returned.

send_sticker ( chat_id , sticker , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , api_kwargs = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send static .WEBP , animated .TGS , or video .WEBM stickers.

The sticker argument can be either a file_id, an URL or a file from disk open(filename, ‘rb’)

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

sticker ( str | filelike object | bytes | pathlib.Path | telegram.Sticker ) –

Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .webp file from the Internet, or upload a new one using multipart/form-data. Lastly you can pass an existing telegram.Sticker object to send.

Changed in version 13.2: Accept bytes as input.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

timeout ( int | float , optional) – Send file timeout (default: 20 seconds).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent Message is returned.

send_venue ( chat_id , latitude = None , longitude = None , title = None , address = None , foursquare_id = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = None , venue = None , foursquare_type = None , api_kwargs = None , google_place_id = None , google_place_type = None , allow_sending_without_reply = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send information about a venue.

You can either supply venue , or latitude , longitude , title and address and optionally foursquare_id and foursquare_type or optionally google_place_id and google_place_type .

Foursquare details and Google Pace details are mutually exclusive. However, this behaviour is undocumented and might be changed by Telegram.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

latitude ( float , optional) – Latitude of venue.

longitude ( float , optional) – Longitude of venue.

title ( str , optional) – Name of the venue.

address ( str , optional) – Address of the venue.

foursquare_id ( str , optional) – Foursquare identifier of the venue.

foursquare_type ( str , optional) – Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

google_place_id ( str , optional) – Google Places identifier of the venue.

google_place_type ( str , optional) – Google Places type of the venue. (See supported types.)

venue ( telegram.Venue , optional) – The venue to send.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent Message is returned.

send_video ( chat_id , video , duration = None , caption = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , width = None , height = None , parse_mode = None , supports_streaming = None , thumb = None , api_kwargs = None , allow_sending_without_reply = None , caption_entities = None , filename = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document).

Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

The video argument can be either a file_id, an URL or a file from disk open(filename, ‘rb’)

thumb will be ignored for small video files, for which Telegram can easily generate thumb nails. However, this behaviour is undocumented and might be changed by Telegram.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

video ( str | filelike object | bytes | pathlib.Path | telegram.Video ) –

Video file to send. Pass a file_id as String to send an video file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an video file from the Internet, or upload a new one using multipart/form-data. Lastly you can pass an existing telegram.Video object to send.

Changed in version 13.2: Accept bytes as input.

filename ( str , optional) –

Custom file name for the video, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the tempfile module.

New in version 13.1.

duration ( int , optional) – Duration of sent video in seconds.

width ( int , optional) – Video width.

height ( int , optional) – Video height.

caption ( str , optional) – Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing.

caption_entities (List[ telegram.MessageEntity ], optional) – List of special entities that appear in message text, which can be specified instead of parse_mode .

supports_streaming ( bool , optional) – Pass True , if the uploaded video is suitable for streaming.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

thumb ( filelike object | bytes | pathlib.Path , optional) –

Changed in version 13.2: Accept bytes as input.

timeout ( int | float , optional) – Send file timeout (default: 20 seconds).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent Message is returned.

send_video_note ( chat_id , video_note , duration = None , length = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , thumb = None , api_kwargs = None , allow_sending_without_reply = None , filename = None , protect_content = None , message_thread_id = None ) ¶

As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages.

The video_note argument can be either a file_id or a file from disk open(filename, ‘rb’)

thumb will be ignored for small video files, for which Telegram can easily generate thumb nails. However, this behaviour is undocumented and might be changed by Telegram.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

video_note ( str | filelike object | bytes | pathlib.Path | telegram.VideoNote ) –

Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. Or you can pass an existing telegram.VideoNote object to send. Sending video notes by a URL is currently unsupported.

Changed in version 13.2: Accept bytes as input.

filename ( str , optional) –

Custom file name for the video note, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the tempfile module.

New in version 13.1.

duration ( int , optional) – Duration of sent video in seconds.

length ( int , optional) – Video width and height, i.e. diameter of the video message.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

thumb ( filelike object | bytes | pathlib.Path , optional) –

Changed in version 13.2: Accept bytes as input.

timeout ( int | float , optional) – Send file timeout (default: 20 seconds).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent Message is returned.

send_voice ( chat_id , voice , duration = None , caption = None , disable_notification = None , reply_to_message_id = None , reply_markup = None , timeout = 20 , parse_mode = None , api_kwargs = None , allow_sending_without_reply = None , caption_entities = None , filename = None , protect_content = None , message_thread_id = None ) ¶

Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Audio or Document). Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

The voice argument can be either a file_id, an URL or a file from disk open(filename, ‘rb’)

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

voice ( str | filelike object | bytes | pathlib.Path | telegram.Voice ) –

Voice file to send. Pass a file_id as String to send an voice file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an voice file from the Internet, or upload a new one using multipart/form-data. Lastly you can pass an existing telegram.Voice object to send.

Changed in version 13.2: Accept bytes as input.

filename ( str , optional) –

Custom file name for the voice, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the tempfile module.

New in version 13.1.

caption ( str , optional) – Voice message caption, 0-1024 characters after entities parsing.

caption_entities (List[ telegram.MessageEntity ], optional) – List of special entities that appear in message text, which can be specified instead of parse_mode .

duration ( int , optional) – Duration of the voice message in seconds.

disable_notification ( bool , optional) – Sends the message silently. Users will receive a notification with no sound.

protect_content ( bool , optional) –

Protects the contents of the sent message from forwarding and saving.

New in version 13.10.

message_thread_id ( int , optional) –

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

New in version 13.15.

reply_to_message_id ( int , optional) – If the message is a reply, ID of the original message.

allow_sending_without_reply ( bool , optional) – Pass True , if the message should be sent even if the specified replied-to message is not found.

timeout ( int | float , optional) – Send file timeout (default: 20 seconds).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the sent Message is returned.

setChatAdministratorCustomTitle ( chat_id , user_id , custom_title , timeout = None , api_kwargs = None ) ¶

setChatDescription ( chat_id , description , timeout = None , api_kwargs = None ) ¶

setChatMenuButton ( chat_id = None , menu_button = None , timeout = None , api_kwargs = None ) ¶

setChatPermissions ( chat_id , permissions , timeout = None , api_kwargs = None ) ¶

setChatPhoto ( chat_id , photo , timeout = 20 , api_kwargs = None ) ¶

setChatStickerSet ( chat_id , sticker_set_name , timeout = None , api_kwargs = None ) ¶

setChatTitle ( chat_id , title , timeout = None , api_kwargs = None ) ¶

setGameScore ( user_id , score , chat_id = None , message_id = None , inline_message_id = None , force = None , disable_edit_message = None , timeout = None , api_kwargs = None ) ¶

setMyCommands ( commands , timeout = None , api_kwargs = None , scope = None , language_code = None ) ¶

setMyDefaultAdministratorRights ( rights = None , for_channels = None , timeout = None , api_kwargs = None ) ¶

setPassportDataErrors ( user_id , errors , timeout = None , api_kwargs = None ) ¶

setStickerPositionInSet ( sticker , position , timeout = None , api_kwargs = None ) ¶

setStickerSetThumb ( name , user_id , thumb = None , timeout = None , api_kwargs = None ) ¶

setWebhook ( url = None , certificate = None , timeout = None , max_connections = 40 , allowed_updates = None , api_kwargs = None , ip_address = None , drop_pending_updates = None , secret_token = None ) ¶

set_chat_administrator_custom_title ( chat_id , user_id , custom_title , timeout = None , api_kwargs = None ) ¶

Use this method to set a custom title for administrators promoted by the bot in a supergroup. The bot must be an administrator for this to work.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername ).

user_id ( int ) – Unique identifier of the target administrator.

custom_title ( str ) – New custom title for the administrator; 0-16 characters, emoji are not allowed.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

set_chat_description ( chat_id , description , timeout = None , api_kwargs = None ) ¶

Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

description ( str ) – New chat description, 0-255 characters.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

set_chat_menu_button ( chat_id = None , menu_button = None , timeout = None , api_kwargs = None ) ¶

Use this method to change the bot’s menu button in a private chat, or the default menu button.

New in version 13.12.

chat_id ( int , optional) – Unique identifier for the target private chat. If not specified, default bot’s menu button will be changed

menu_button ( telegram.MenuButton , optional) – An object for the new bot’s menu button. Defaults to telegram.MenuButtonDefault .

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

set_chat_permissions ( chat_id , permissions , timeout = None , api_kwargs = None ) ¶

Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the telegram.ChatMember.can_restrict_members admin rights.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername ).

permissions ( telegram.ChatPermissions ) – New default chat permissions.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

set_chat_photo ( chat_id , photo , timeout = 20 , api_kwargs = None ) ¶

Use this method to set a new profile photo for the chat.

Photos can’t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

photo ( filelike object | bytes | pathlib.Path ) –

Changed in version 13.2: Accept bytes as input.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

set_chat_sticker_set ( chat_id , sticker_set_name , timeout = None , api_kwargs = None ) ¶

Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field telegram.Chat.can_set_sticker_set optionally returned in get_chat() requests to check if the bot can use this method.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).

sticker_set_name ( str ) – Name of the sticker set to be set as the group sticker set.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

set_chat_title ( chat_id , title , timeout = None , api_kwargs = None ) ¶

Use this method to change the title of a chat. Titles can’t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

title ( str ) – New chat title, 1-255 characters.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

set_game_score ( user_id , score , chat_id = None , message_id = None , inline_message_id = None , force = None , disable_edit_message = None , timeout = None , api_kwargs = None ) ¶

Use this method to set the score of the specified user in a game.

user_id ( int ) – User identifier.

score ( int ) – New score, must be non-negative.

force ( bool , optional) – Pass True , if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters.

disable_edit_message ( bool , optional) – Pass True , if the game message should not be automatically edited to include the current scoreboard.

chat_id ( int | str , optional) – Required if inline_message_id is not specified. Unique identifier for the target chat.

message_id ( int , optional) – Required if inline_message_id is not specified. Identifier of the sent message.

inline_message_id ( str , optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

The edited message, or if the message wasn’t sent by the bot , True .

telegram.error.TelegramError – If the new score is not greater than the user’s current score in the chat and force is False .

set_my_commands ( commands , timeout = None , api_kwargs = None , scope = None , language_code = None ) ¶

Use this method to change the list of the bot’s commands. See the Telegram docs for more details about bot commands.

commands (List[ BotCommand | ( str , str )]) – A JSON-serialized list of bot commands to be set as the list of the bot’s commands. At most 100 commands can be specified.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to telegram.BotCommandScopeDefault .

New in version 13.7.

language_code ( str , optional) –

A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands.

New in version 13.7.

On success, True is returned.

set_my_default_administrator_rights ( rights = None , for_channels = None , timeout = None , api_kwargs = None ) ¶

Use this method to change the default administrator rights requested by the bot when it’s added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot.

New in version 13.12.

rights ( telegram.ChatAdministratorRights , optional) – A telegram.ChatAdministratorRights object describing new default administrator rights. If not specified, the default administrator rights will be cleared.

for_channels ( bool , optional) – Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

Returns True on success.

set_passport_data_errors ( user_id , errors , timeout = None , api_kwargs = None ) ¶

Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change).

Use this if the data submitted by the user doesn’t satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.

user_id ( int ) – User identifier

errors (List[ PassportElementError ]) – A JSON-serialized array describing the errors.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

set_sticker_position_in_set ( sticker , position , timeout = None , api_kwargs = None ) ¶

Use this method to move a sticker in a set created by the bot to a specific position.

sticker ( str ) – File identifier of the sticker.

position ( int ) – New sticker position in the set, zero-based.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

set_sticker_set_thumb ( name , user_id , thumb = None , timeout = None , api_kwargs = None ) ¶

Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only.

The thumb can be either a file_id, an URL or a file from disk open(filename, ‘rb’)

name ( str ) – Sticker set name

user_id ( int ) – User identifier of created sticker set owner.

thumb ( str | filelike object | bytes | pathlib.Path , optional) –

A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the 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. Animated sticker set thumbnails can’t be uploaded via HTTP URL.

Changed in version 13.2: Accept bytes as input.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

set_webhook ( url = None , certificate = None , timeout = None , max_connections = 40 , allowed_updates = None , api_kwargs = None , ip_address = None , drop_pending_updates = None , secret_token = None ) ¶

Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, Telegram will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, Telegram will give up after a reasonable amount of attempts.

If you’d like to make sure that the Webhook was set by you, you can specify secret data in the parameter secret_token . If specified, the request will contain a header X-Telegram-Bot-Api-Secret-Token with the secret token as content.

The certificate argument should be a file from disk open(filename, ‘rb’) .

url ( str ) – HTTPS url to send updates to. Use an empty string to remove webhook integration.

certificate ( filelike ) – Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. (https://goo.gl/rw7w6Y)

ip_address ( str , optional) – The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS.

max_connections ( int , optional) – Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40 . Use lower values to limit the load on your bot’s server, and higher values to increase your bot’s throughput.

allowed_updates (List[ str ], optional) – A JSON-serialized list the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See telegram.Update for a complete list of available update types. Specify an empty list to receive all updates except telegram.Update.chat_member (default). If not specified, the previous setting will be used. Please note that this parameter doesn’t affect updates created before the call to the set_webhook, so unwanted updates may be received for a short period of time.

drop_pending_updates ( bool , optional) – Pass True to drop all pending

secret_token ( str , optional): A secret token to be sent in a header

X-Telegram-Bot-Api-Secret-Token in every webhook request, 1-256 characters. Only characters A-Z , a-z , 0-9 , _ and — are allowed. The header is useful to ensure that the request comes from a webhook set by you.

New in version 13.13.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

You will not be able to receive updates using get_updates() for long as an outgoing webhook is set up.

To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.

Ports currently supported for Webhooks: 443 , 80 , 88 , 8443 .

If you’re having any trouble setting up webhooks, please check out this guide to Webhooks.

bool On success, True is returned.

stopMessageLiveLocation ( chat_id = None , message_id = None , inline_message_id = None , reply_markup = None , timeout = None , api_kwargs = None ) ¶

stopPoll ( chat_id , message_id , reply_markup = None , timeout = None , api_kwargs = None ) ¶

stop_message_live_location ( chat_id = None , message_id = None , inline_message_id = None , reply_markup = None , timeout = None , api_kwargs = None ) ¶

Use this method to stop updating a live location message sent by the bot or via the bot (for inline bots) before live_period expires.

chat_id ( int | str ) – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

message_id ( int , optional) – Required if inline_message_id is not specified. Identifier of the sent message with live location to stop.

inline_message_id ( str , optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.

reply_markup ( telegram.InlineKeyboardMarkup , optional) – A JSON-serialized object for a new inline keyboard.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, if edited message is sent by the bot, the sent Message is returned, otherwise True is returned.

stop_poll ( chat_id , message_id , reply_markup = None , timeout = None , api_kwargs = None ) ¶

Use this method to stop a poll which was sent by the bot.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

message_id ( int ) – Identifier of the original message with the poll.

reply_markup ( telegram.InlineKeyboardMarkup , optional) – A JSON-serialized object for a new message inline keyboard.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, the stopped Poll with the final results is returned.

unbanChatMember ( chat_id , user_id , timeout = None , api_kwargs = None , only_if_banned = None ) ¶

unbanChatSenderChat ( chat_id , sender_chat_id , timeout = None , api_kwargs = None ) ¶

unban_chat_member ( chat_id , user_id , timeout = None , api_kwargs = None , only_if_banned = None ) ¶

Use this method to unban a previously kicked user in a supergroup or channel.

The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don’t want this, use the parameter only_if_banned .

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername ).

user_id ( int ) – Unique identifier of the target user.

only_if_banned ( bool , optional) – Do nothing if the user is not banned.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

unban_chat_sender_chat ( chat_id , sender_chat_id , timeout = None , api_kwargs = None ) ¶

Use this method to unban a previously banned channel in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights.

New in version 13.9.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername ).

sender_chat_id ( int ) – Unique identifier of the target sender chat.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

unpinAllChatMessages ( chat_id , timeout = None , api_kwargs = None ) ¶

unpinAllForumTopicMessages ( chat_id , message_thread_id , timeout = None , api_kwargs = None ) ¶

unpinChatMessage ( chat_id , timeout = None , api_kwargs = None , message_id = None ) ¶

unpin_all_chat_messages ( chat_id , timeout = None , api_kwargs = None ) ¶

Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the telegram.ChatMember.can_pin_messages admin right in a supergroup or telegram.ChatMember.can_edit_messages admin right in a channel.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

unpin_all_forum_topic_messages ( chat_id , message_thread_id , timeout = None , api_kwargs = None ) ¶

Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have can_pin_messages() administrator rights in the supergroup.

New in version 13.15.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername ).

message_thread_id ( int ) –

Unique identifier for the target message thread of the forum topic.

New in version 13.15.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

unpin_chat_message ( chat_id , timeout = None , api_kwargs = None , message_id = None ) ¶

Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the telegram.ChatMember.can_pin_messages admin right in a supergroup or telegram.ChatMember.can_edit_messages admin right in a channel.

chat_id ( int | str ) – Unique identifier for the target chat or username of the target channel (in the format @channelusername ).

message_id ( int , optional) – Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

On success, True is returned.

uploadStickerFile ( user_id , png_sticker , timeout = 20 , api_kwargs = None ) ¶

upload_sticker_file ( user_id , png_sticker , timeout = 20 , api_kwargs = None ) ¶

Use this method to upload a .PNG file with a sticker for later use in create_new_sticker_set() and add_sticker_to_set() methods (can be used multiple times).

The png_sticker argument can be either a file_id, an URL or a file from disk open(filename, ‘rb’)

user_id ( int ) – User identifier of sticker file owner.

png_sticker ( str | filelike object | bytes | pathlib.Path ) –

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.

Changed in version 13.2: Accept bytes as input.

timeout ( int | float , optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).

api_kwargs ( dict , optional) – Arbitrary keyword arguments to be passed to the Telegram API.

Как создать Python Telegram Bot [Учебник хакера]

Благодаря популярности платформ обмена мгновенными сообщениями и достижениями в AI Chatbots испытывали взрывоопасный рост со скоростью 80% предприятий, желающих использовать боты Чата к 2020 году. Это создало отличную возможность для внештатных разработчиков Python, так как есть большая потребность в развитии как простые, так и сложные боты чата.

Одной из более популярных платформ обмена сообщениями является телеграмма, с отчетом 200 миллионов ежемесячных пользователей. Telegram предоставляет превосходное API для ботов в чате, позволяющую пользователю не только общаться с помощью текстовых сообщений, но и мультимедийного контента с изображениями и видео и богатым контентом с HTML и JavaScript. API можно даже использовать для управления покупками непосредственно в телеграмме.

Python отлично подходит для создания ботов Telegram, и чрезвычайно популярные Python Telegram Bot Framework делает это гораздо проще, позволяя вам по умолчанию создавать боты, которые проходят асинхронно, чтобы вы могли легко кодовые боты, которые могут общаться со многими пользователями одновременно.

Давайте начнем с созданием нашей первой телеграммы бота в Python, первое, что нам нужно будет сделать, это скачать телеграмму, создать учетную запись и общаться с «BotFather». Botfather – это бот чата, созданный Telegram, через который мы можем получить нашу Telegram Bot API Token.

Для скачивания головы телеграммы до Telegram.org И загрузите и установите соответствующую версию для вашей ОС, установите и создайте учетную запись.

Теперь добавьте Botfather в качестве контакта, сделайте это, нажав на значок меню, выбрав контакты, поиск «BotFather» и выбрав пользователя @botfather.

Разговор будет всплыть с помощью кнопки «Пуск» внизу, нажмите кнопку «Пуск», и вы получите список команд.

Команда для создания нового бота/Newbot введите «/newbot» и ответьте на подсказки для именования вашего бота, и вы получите токен API Telegram Bot. Вы можете назвать бот, что вам нравится, но имя пользователя Bot нужно будет уникальным на телеграмме.

Храните токен доступа где-то, поскольку нам понадобится, чтобы авторизовать наш бот.

Установка Python Telegram Bot Framework

Для создания бота мы будем использовать Python версию 3.7. Бота Python Telegram Bot совместима с Python 2.7 и выше.

Прежде чем мы доберемся до фактического кодирования, нам нужно будет установить бот Python Telegram Bot самый простой способ сделать это с:

Если вы предпочитаете использовать исходный код, вы можете найти проект на Github Отказ

Сейчас с установленной библиотекой Bot Bot Python Telegram.

Подключение бота к телеграмме

Первое, что вам нужно будет иметь, у него будет подключиться к боту и аутентифицироваться с API Telegram.

Мы импортируем библиотеку регистратора Python, чтобы использовать фреймворки бота Python Telegram, построенные в журнале, чтобы мы могли видеть в реальном времени, что происходит с ботом, и если есть какие-либо ошибки.

Поместите следующий код в файл Python и поместите ключ Bot Telegram, где указано в операторе обновления:

Если вы просто хотите попробовать его в своей онлайн-оболочке, используйте эту refl.it, я создал для вас. Это уже настроено, и все зависимости устанавливаются!

Упражнение : Получите свой токен API, загрузив телеграмму и следуя вышеуказанным простым инструкциям. Это займет вас 10 минут или меньше! �� Затем запустите это своим собственным токеном API и общайтесь с собой!

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

Мы создали переменную Updater, и это будет держать обновленную для нашей телеграммы бота Telegram, которая помещается в глобальную переменную, чтобы мы могли легко получить доступ к нему позже от UI.

UPDATER обеспечивает легкий передний конец для работы с ботом и запустить наш новый бот с помощью Updater, нам просто нужно пройти в ключ аутентификации, и мы также передадим, чтобы избежать ошибок анонсов, поскольку контекстные обратные вызовы сейчас По умолчанию для Python Telegram Bot.

UPDATATER.START_POLLING () на самом деле запускает бот, и после этого будет пропущено в боте, начнут начать опрос телеграмму для любых обновлений чата по телеграмме. Бот начнет опрос в своих отдельных потоках, чтобы это не остановит ваш сценарий Python.

Мы используем команду UPDATER.IDLE () здесь, чтобы заблокировать скрипт, пока пользователь не отправит команду, чтобы вырваться из скрипта Python, такого как Ctrl-C в Windows.

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

Заставить бот понять команды

Давайте обновим сценарий и сделайте нашу функцию start_bot выглядеть так:

Мы добавили переменную диспетчера для более четкого доступа к диспетчеру для нашего бота, мы будем использовать диспетчеров для добавления команд.

С линией Dispatcher.add_handler (Commenthandler («Пуск», Пуск)) Мы добавили командный обработчик, который будет выполнять, когда пользователь вводит/запускается, и будет выполняться запустить функцию обратного вызова. Эта команда автоматически выполняет при добавлении бота в качестве нового контакта и нажмите кнопку «Пуск» в Telegram. Теперь добавьте функцию для нашей команды запуска:

Обработчики команд требуют как обновление, так и параметр CallbackContext. Через обновление мы отправляем обновления в чате, здесь используя Update.message.reply_text автоматически добавляет ответ только на конкретный чат, где была отправлена команда/начала/начала.

Теперь при вводе в чате с ботом или набрав команду/начала, вы должны получить такой ответ:

Добавление более продвинутой команды, которая читает чат

Команда START выполняет функцию в нашем боте всякий раз, когда пользовательские типы/начала, но что, если мы хотим, чтобы наш бот читать и отвечать на чат, а не просто выполнять команду?

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

Добавьте следующую строку в функцию start_bot под предыдущим утверждением add_handler:

Это добавит MessageHandler в бот, мы также используем фильтр здесь, чтобы этот обработчик сообщений фильтрует все, кроме текста, потому что пользователь может публиковать что-то другое, чем текст в их сообщениях (таких как изображения или видео). Для этого обработчика мы создадим функцию обратного вызова с именем Repeater с кодом:

В нашем ретранслятере мы используем метод Reply_Text, отвечая с update.message.text, который отправляет сообщение Text Chat обратно пользователю.

Отказ от команды бота или на пользователя

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

К счастью, BOT Python Telegram позволяет нам хранить конкретные данные пользователя, используя контекст, который передается на наши функции обратного вызова. Давайте добавим еще один обработчик под обработчиком повторителя:

Теперь мы сначала изменим обработчик повторителя, чтобы проверить, следует ли повторять текст пользователя:

Здесь мы добавили утверждение, если context.user_data [echo]: перед тем, как получить ответ бота пользователю. У Python Telegram Bot имеет словарь user_data, который может быть доступен с использованием контекста.

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

Теперь мы добавим в другую функцию, чтобы пользователь мог установить словарь ECHO с помощью команды echo в чате:

В этой функции обратного вызова мы собираем параметры дополнительных команд пользователей из контекста. Параметры пользователей содержатся с CONTEXT.ARGS, которые предоставляют массив на основе пробелов от пользователя, в этой функции мы проверяем первый параметр, передаваемый пользователем, ищем включение или выключение, и измените переменную user_data [echo].

Размещение данных из веб-сайтов и крепежных команд

Python Telegram Bot позволяет легко ответить с файлами из веб-сайта, таких как фотографии, видео и документы, вам просто нужно дать URL к указанному типу контента.

Мы будем использовать USCUBICK API, чтобы собрать бесплатное изображение на основе пользователей, предоставляемых условиями и опубликуйте его в чате, и мы также будем использовать фильтр, чтобы эта команда работает только для вашего имени пользователя.

Добавьте следующий код в функцию start_bot ():

Замените your_username с вашим именем пользователя.

Этот код будет выполнять функцию get_image, но только если имя пользователя соответствует вашим собственным. С помощью этого фильтра мы проходим только в 1 имени пользователя, но вы также можете пройти в список пользователей.

Теперь давайте создадим функцию Get_Image:

Как и в предыдущем примере, мы получаем термины, используя переменную args из контекста, но в этом случае мы объединяем условия вместе с A и преобразовываться в нижний регистр, потому что это то, что требуется от разбавления API.

Затем вы можете получить изображение в чате, используя/get_image и некоторые ключевые слова такие:

Добавление графического интерфейса

Теперь мы узнали о том, как бот бежать и управляемость команд. Благодаря многопоточной природе Python Telegram Bot этот бот может справиться со многими пользователями со всего мира.

Во многих проектах на фрилансельных сайтах, таких как UPSCORK, клиент не заботится о том, какой язык используется для создания бота. Тем не менее, они часто хотят интерфейс для управления ботом, поэтому давайте создадим простой интерфейс, который позволяет владельцу бота начать и остановить бот.

Чтобы построить наш пользовательский интерфейс Мы будем использовать библиотеку Pysimplegui. С Pysimplegui вы можете создать перекрестную платформу GUI, которая работает на Windows, Mac и Linux без какого-либо исходного кода с легко читаемым синтаксисом и минимальным кодом для котла.

Чтобы начать добавление кода GUI Давайте сначала удалите строку UPDATER_IDLE () из нашей функции start_bot, поэтому функция start_bot читает так:

Сняв линию Updater.idle (), бот больше не приостанавливает скрипт после запуска и прогон в отдельной резьбе, пока не решили остановить бот или останавливаться основным потоком.

Теперь мы создадим графический интерфейс, этот графический интерфейс состоит из строки состояния, чтобы показать, включается ли бот в настоящее время вместе с началом и кнопкой остановки и название, как это:

Чтобы создать этот графический интерфейс, добавьте следующий код:

Теперь, чтобы запустить GUI Удалить оператор Start_bot () в нижней части нашего сценария и замените на GUI ():

В переменной макета вы можете видеть, что мы определили некоторые элементы текста и кнопки, и каждый элемент в списке отображается как строка в нашем интерфейсе UI. Наша первая строка состоит из 2 элементов, чтобы показать состояние (мы дали второй элемент ключ, чтобы мы могли легко обратиться к нему позже), а наша вторая строка состоит из трех кнопок.

Функция SG.Window – это то, где мы предоставляем наш заголовок и макет.

В то время как True: Loop – это стандартная петля событий Pysimplegui.

Функция Window.read () возвращает любые события GUI вместе с любыми значениями, передаваемыми вместе с событием (таким как текст ввода пользователя), мы не будем использовать какие-либо значения в нашей петле, поэтому мы передаем их в переменную, вы можете пройти Время ждать функции чтения Windows в миллисекундах, ничего не проезжая, поскольку мы сделаем, делает функцию ждать, пока событие не будет запущено.

IF INTER IN (NOTE, «EXIT»): оператор выполняет, если пользователь ударяет кнопку выхода или пользователь закрывает окно другим способом (например, кнопка закрытия в углу окна), в этом случае мы просто сломаемся петля.

Запуск и остановка бота из графического интерфейса

Теперь, если вы начнете скрипт кнопки «Пуск» и «Стоп» на самом деле ничего не сделают, поэтому мы добавим в код, чтобы начать и остановить скрипт и обновить состояние, создавая нашу функцию GUI:

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

В нашем мероприятии начала мы запускаем бот, используя start_bot, если еще нет обновлений, в противном случае мы выполняем метод start_polling нашего Updater в виде повторного запуска обновлений таким образом, намного быстрее, чем использовать start_bot для инициализации бота.

Мы также используем функцию окна Find_Element к окну, чтобы получить доступ к тексту состояния, используя ключ, созданный «Состояние» и измените, что для отображения запущенного бота.

Поворачивая кнопки графического интерфейса включения и выключения

Теперь, если мы запустим наш скрипт, мы получаем пользовательский интерфейс, и нажав кнопку «Пуск», начнут бот, и нажав кнопку «Стоп» остановит бот, но получаем ошибку, когда мы нажимаем кнопки из строя.

Мы восстановим эту ситуацию, изменяя цикл нашего события, чтобы отключить кнопки «Пуск» и «Стоп», чтобы пользователь мог сделать только один или другой в соответствующие времена.

Вы можете увидеть, что мы использовали метод findelement на кнопках здесь, а затем используя метод обновления, изменил переменную отключенную переменную, которая позволяет вам отключить кнопки.

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

Кнопки теперь должны включать и отключить соответствующим образом в графическом интерфейсе:

И там у нас есть, работающий графический интерфейс для нашей телеграммы бота.

Заключение

Мы узнали совсем немного в этом руководстве, и теперь вы можете иметь BOT Python Telegram, который отвечает командам, и даже представлены данные, показанные из Интернета.

Мы также создали простое интерфейс для запуска и остановки бота. С вашими новыми навыками вы теперь готовы ответить на эти потенциальные клиенты на фрилансских сайтах, которые ищут телеграмму бота.

об авторе

Johann – это фрилансер Python, специализирующийся на веб-ботах и веб-соскоб. Окончил с дипломом в компьютерных системах технологии 2009 года. Профиль на высоте.

Telegram Bot на Python. Часть 2. PyCharm. Python3. Пишем код.

Привет Друзья. Мы постепенно продвигаемся к цели — создать собственного бота в Telegram. В первой части мы разобрались, кто такие боты и зачем они нужны. При помощи @BotFather создали нашего первого бота — @BotanikRobot. Изучили как при помощи команд провести первоначальную настройку бота, задать аватарку. Заполнили описание бота и приветственное сообщение. Определились с методами взаимодействия с ботом.

PyCharm и Python3

Пришло время установить Python (язык программирования на котором мы будем писать нашего бота ), и среду разработки PyCharm. Конечно по началу можно обойтись стандартными средствами операционной системы, простым Блокнотом или другим текстовым редактором. Но как показывает практика, Python очень привередлив к синтаксису и оформлению кода, поэтому лучшим решением будет, использовать среду разработки.

Писать код я буду под Виндой, поэтому:

Переходим на официальный сайт Python и выбираем нужную нам версию 3.6.4: для 32-разрядных или версию для 64-разрядных систем (зависит от твоего компьютера; узнать разрядность можно, открыв Проводник — Этот компьютер — и по нажатию на правую кнопку мыши выбрать пункт Свойства).

Когда мы скачали нужную версию Python, запускаем установщик.

Важно: на самом первом этапе установки необходимо отметить Add Python 3.6 to PATH , это очень упростит нашу работу в будущем. Затем нажимаем на Install now и ждём окончания установки.

Чтобы проверить, правильно ли установился Python, открываем меню Пуск и в строке поиска набираем командная строка (в Windows 10 открыть поиск можно, просто нажав на лупу рядом с кнопкой Пуск) или Win+R.

В открывшемся окне командной строки выполняем команду python . В ответ должна открыться консоль Python (начинается с >>> ) как на картинке ниже.

Выполняем команду exit() , чтобы выйти из режима интерпретатора Python. Менеджер пакетов pip так же должен быть установлен, чтобы проверить, выполни команду pip -V . В ответ в консоли должна отобразиться версия pip :

Возвращаемся в терминал (или в командную строку) и выполняем следующую команду:

Что здесь просиходит? Мы обращаемся к pip и хотим установить ( install ) волшебный модуль pyTelegramBotAPI , который и отвечает за создание и работу ботов.

Если модуль успешно установился, то мы должны увидеть надпись Successfully installed pyTelegramBotAPI-x.x.x. Собственно говоря, существует множество других модулей для Python (и не только), с помощью которых можно быстро запустить Telegram-бота; простыми словами pyTelegramBotAPI — это такой “конструктор”, в котором содержатся все необходимые нам компоненты-“кубики”.

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

Могу порекомендовать отличную и бесплатную среду — PyCharm от JetBrains. Эта компания специализируется на создании профессиональных сред для программирования. Если Microsoft Office практически всегда используется для работы с таблицами/презентациями и текстовыми документами, то программы от JetBrains занимают лидирующее положение среди программистов.

Итак, переходим на страницу скачивания PyCharm. Для скачивания доступно две версии: профессиональная и версия для сообщества. Версия для сообщества бесплатная. Ее и скачаем:

Запускаем скачанный .exe файл. В первом окне нас приветствует сам установщик. Смело кликаем «Next». Дальше надо указать место установки среды.

Важный момент! На следующем окне обязательно выделить галочку «Download and install JRE x86 by JetBrains», если у вас на компьютере не установлена Java. Если вы не знаете, что это такое, то лучше поставьте эту галочку ? Также рекомендую отметить галочку «.py» для того, чтобы все файлы с программным кодом по умолчанию открывались в PyCharm. Это удобно.

После окончания установки запускайте PyCharm. После красивого окна загрузки появится стартовое окно программы. Если поверх стартового окна у вас выскочило второе маленькое окошко, то просто нажмите «OK». Создайте новый проект, кликнув на «Create New Project»

В следующем окне будет два поля. В первом укажите, где будет располагаться новый проект. Второе поле должно быть заполненным по умолчанию. Там содержится путь к установленному ранее Python. Если там пусто, то укажите путь вручную.

Дальше откроется окно самого редактора.

Теперь вы готовы начать писать программы на Python!

Давайте проверим, как все работает. Для этого кликните правой кнопкой на название вашего проекта и в раскрывающемся списке выберите пункт «New > Python file». Появится окно, в котором вы можете задать имя файлу. Задайте какое-нибудь имя и нажмите «OK». Справа откроется сам файл. Пока он пустой.

Начинаем писать код

Можно переходить к самой интересной части — написанию кода нашего бота. Открываем

Перво-наперво подключаем модуль telebot, который мы установили с помощью pip. Делаем это так:

Как остановить телеграм бота на python

Как остановить бота в Telegram за 3 секунды?

Почему это происходит?

Что делать?

Настройка уведомлений

Управление рекламой

Взломанный бот

К чёрту подробности, какая планета?

Python-сообщество

#2 Сен. 7, 2020 21:17:18

Как остановить выполнение всех потоков при помощи команды боту Telegram?

Как остановить телеграм бота на python

Почему это происходит?

Что делать?

Настройка уведомлений

Управление рекламой

Взломанный бот

К чёрту подробности, какая планета?

Question: How to shutdown properly? #801

telegram.Bot¶

Как создать Python Telegram Bot [Учебник хакера]

Установка Python Telegram Bot Framework

Подключение бота к телеграмме

Заставить бот понять команды

Добавление более продвинутой команды, которая читает чат

Отказ от команды бота или на пользователя

Размещение данных из веб-сайтов и крепежных команд

Добавление графического интерфейса

Запуск и остановка бота из графического интерфейса

Поворачивая кнопки графического интерфейса включения и выключения

Заключение

об авторе

Telegram Bot на Python. Часть 2. PyCharm. Python3. Пишем код.

Начинаем писать код

Добавить комментарий Отменить ответ