Bot

class telegram.Bot(token, base_url='https://api.telegram.org/bot', base_file_url='https://api.telegram.org/file/bot', request=None, get_updates_request=None, private_key=None, private_key_password=None, local_mode=False)[source]

Bases: telegram.TelegramObject, typing.AsyncContextManager

This object represents a Telegram Bot.

Instances of this class can be used as asyncio context managers, where

async with bot:
    # code

is roughly equivalent to

try:
    await bot.initialize()
    # code
finally:
    await bot.shutdown()

Use In

telegram.ext.ApplicationBuilder.bot()

Available In

See also

__aenter__() and __aexit__().

Note

  • Most bot methods have the argument api_kwargs which allows passing arbitrary keywords to the Telegram API. This can be used to access new features of the API before they are incorporated into PTB. The limitations to this argument are the same as the ones described in do_api_request().

  • Bots should not be serialized since if you for e.g. change the bots token, then your serialized instance will not reflect that change. Trying to pickle a bot instance will raise pickle.PicklingError. Trying to deepcopy a bot instance will raise TypeError.

Examples

Raw API Bot

See also

Your First Bot, Builder Pattern

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

Changed in version 20.0:

  • Removed the deprecated methods kick_chat_member, kickChatMember, get_chat_members_count and getChatMembersCount.

  • Removed the deprecated property commands.

  • Removed the deprecated defaults parameter. If you want to use telegram.ext.Defaults, please use the subclass telegram.ext.ExtBot instead.

  • Attempting to pickle a bot instance will now raise pickle.PicklingError.

  • Attempting to deepcopy a bot instance will now raise TypeError.

  • The following are now keyword-only arguments in Bot methods: location, filename, venue, contact, {read, write, connect, pool}_timeout, api_kwargs. Use a named argument for those, and notice that some positional arguments changed position as a result.

  • For uploading files, file paths are now always accepted. If local_mode is False, the file contents will be read in binary mode and uploaded. Otherwise, the file path will be passed in the file URI scheme.

Changed in version 20.5: Removed deprecated methods set_sticker_set_thumb and setStickerSetThumb. Use set_sticker_set_thumbnail() and setStickerSetThumbnail() instead.

Parameters:

Since this class has a large number of methods and attributes, below you can find a quick overview.

Sending Messages

send_animation()

Used for sending animations

send_audio()

Used for sending audio files

send_chat_action()

Used for sending chat actions

send_contact()

Used for sending contacts

send_dice()

Used for sending dice messages

send_document()

Used for sending documents

send_game()

Used for sending a game

send_invoice()

Used for sending an invoice

send_location()

Used for sending location

send_media_group()

Used for sending media grouped together

send_message()

Used for sending text messages

send_paid_media()

Used for sending paid media to channels

send_photo()

Used for sending photos

send_poll()

Used for sending polls

send_sticker()

Used for sending stickers

send_venue()

Used for sending venue locations.

send_video()

Used for sending videos

send_video_note()

Used for sending video notes

send_voice()

Used for sending voice messages

copy_message()

Used for copying the contents of an arbitrary message

copy_messages()

Used for copying the contents of an multiple arbitrary messages

forward_message()

Used for forwarding messages

forward_messages()

Used for forwarding multiple messages at once

Updating Messages

answer_callback_query()

Used for answering the callback query

answer_inline_query()

Used for answering the inline query

answer_pre_checkout_query()

Used for answering a pre checkout query

answer_shipping_query()

Used for answering a shipping query

answer_web_app_query()

Used for answering a web app query

delete_message()

Used for deleting messages.

delete_messages()

Used for deleting multiple messages as once.

edit_message_caption()

Used for editing captions

edit_message_media()

Used for editing the media on messages

edit_message_live_location()

Used for editing the location in live location messages

edit_message_reply_markup()

Used for editing the reply markup on messages

edit_message_text()

Used for editing text messages

stop_poll()

Used for stopping the running poll

set_message_reaction()

Used for setting reactions on messages

Chat Moderation and information

approve_chat_join_request()

Used for approving a chat join request

decline_chat_join_request()

Used for declining a chat join request

ban_chat_member()

Used for banning a member from the chat

unban_chat_member()

Used for unbanning a member from the chat

ban_chat_sender_chat()

Used for banning a channel in a channel or supergroup

unban_chat_sender_chat()

Used for unbanning a channel in a channel or supergroup

restrict_chat_member()

Used for restricting a chat member

promote_chat_member()

Used for promoting a chat member

set_chat_administrator_custom_title()

Used for assigning a custom admin title to an admin

set_chat_permissions()

Used for setting the permissions of a chat

export_chat_invite_link()

Used for creating a new primary invite link for a chat

create_chat_invite_link()

Used for creating an additional invite link for a chat

edit_chat_invite_link()

Used for editing a non-primary invite link

revoke_chat_invite_link()

Used for revoking an invite link created by the bot

set_chat_photo()

Used for setting a photo to a chat

delete_chat_photo()

Used for deleting a chat photo

set_chat_title()

Used for setting a chat title

set_chat_description()

Used for setting the description of a chat

pin_chat_message()

Used for pinning a message

unpin_chat_message()

Used for unpinning a message

unpin_all_chat_messages()

Used for unpinning all pinned chat messages

get_business_connection()

Used for getting information about the business account.

get_user_profile_photos()

Used for obtaining user’s profile pictures

get_chat()

Used for getting information about a chat

get_chat_administrators()

Used for getting the list of admins in a chat

get_chat_member_count()

Used for getting the number of members in a chat

get_chat_member()

Used for getting a member of a chat

get_user_chat_boosts()

Used for getting the list of boosts added to a chat

leave_chat()

Used for leaving a chat

Bot settings

set_my_commands()

Used for setting the list of commands

delete_my_commands()

Used for deleting the list of commands

get_my_commands()

Used for obtaining the list of commands

get_my_default_administrator_rights()

Used for obtaining the default administrator rights for the bot

set_my_default_administrator_rights()

Used for setting the default administrator rights for the bot

get_chat_menu_button()

Used for obtaining the menu button of a private chat or the default menu button

set_chat_menu_button()

Used for setting the menu button of a private chat or the default menu button

set_my_description()

Used for setting the description of the bot

get_my_description()

Used for obtaining the description of the bot

set_my_short_description()

Used for setting the short description of the bot

get_my_short_description()

Used for obtaining the short description of the bot

set_my_name()

Used for setting the name of the bot

get_my_name()

Used for obtaining the name of the bot

Stickerset management

add_sticker_to_set()

Used for adding a sticker to a set

delete_sticker_from_set()

Used for deleting a sticker from a set

create_new_sticker_set()

Used for creating a new sticker set

delete_sticker_set()

Used for deleting a sticker set made by a bot

set_chat_sticker_set()

Used for setting a sticker set of a chat

delete_chat_sticker_set()

Used for deleting the set sticker set of a chat

replace_sticker_in_set()

Used for replacing a sticker in a set

set_sticker_position_in_set()

Used for moving a sticker’s position in the set

set_sticker_set_title()

Used for setting the title of a sticker set

set_sticker_emoji_list()

Used for setting the emoji list of a sticker

set_sticker_keywords()

Used for setting the keywords of a sticker

set_sticker_mask_position()

Used for setting the mask position of a mask sticker

set_sticker_set_thumbnail()

Used for setting the thumbnail of a sticker set

set_custom_emoji_sticker_set_thumbnail()

Used for setting the thumbnail of a custom emoji sticker set

get_sticker_set()

Used for getting a sticker set

upload_sticker_file()

Used for uploading a sticker file

get_custom_emoji_stickers()

Used for getting custom emoji files based on their IDs

Games

get_game_high_scores()

Used for getting the game high scores

set_game_score()

Used for setting the game score

Getting updates

get_updates()

Used for getting updates using long polling

get_webhook_info()

Used for getting current webhook status

set_webhook()

Used for setting a webhook to receive updates

delete_webhook()

Used for removing webhook integration

Forum topic management

close_forum_topic()

Used for closing a forum topic

close_general_forum_topic()

Used for closing the general forum topic

create_forum_topic()

Used to create a topic

delete_forum_topic()

Used for deleting a forum topic

edit_forum_topic()

Used to edit a topic

edit_general_forum_topic()

Used to edit the general topic

get_forum_topic_icon_stickers()

Used to get custom emojis to use as topic icons

hide_general_forum_topic()

Used to hide the general topic

unhide_general_forum_topic()

Used to unhide the general topic

reopen_forum_topic()

Used to reopen a topic

reopen_general_forum_topic()

Used to reopen the general topic

unpin_all_forum_topic_messages()

Used to unpin all messages in a forum topic

unpin_all_general_forum_topic_messages()

Used to unpin all messages in the general forum topic

Miscellaneous

create_invoice_link()

Used to generate an HTTP link for an invoice

close()

Used for closing server instance when switching to another local server

log_out()

Used for logging out from cloud Bot API server

get_file()

Used for getting basic info about a file

get_me()

Used for getting basic information about the bot

get_star_transactions()

Used for obtaining the bot’s Telegram Stars transactions

refund_star_payment()

Used for refunding a payment in Telegram Stars

Properties

base_file_url

Telegram Bot API file URL

base_url

Telegram Bot API service URL

bot

The user instance of the bot as returned by get_me()

can_join_groups

Whether the bot can join groups

can_read_all_group_messages

Whether the bot can read all incoming group messages

id

The user id of the bot

name

The username of the bot, with leading @

first_name

The first name of the bot

last_name

The last name of the bot

local_mode

Whether the bot is running in local mode

username

The username of the bot, without leading @

link

The t.me link of the bot

private_key

Deserialized private key for decryption of telegram passport data

supports_inline_queries

Whether the bot supports inline queries

token

Bot’s unique authentication token

async __aenter__()[source]

Asynchronous context manager which initializes the Bot.

Returns:

The initialized Bot instance.

Raises:

Exception – If an exception is raised during initialization, shutdown() is called in this case.

async __aexit__(exc_type, exc_val, exc_tb)[source]

Asynchronous context manager which shuts down the Bot.

__deepcopy__(memodict)[source]

Customizes how copy.deepcopy() processes objects of this type. Bots can not be deepcopied and this method will always raise an exception.

Added in version 20.0.

Raises:

TypeError –

__eq__(other)[source]

Defines equality condition for the telegram.Bot object. Two objects of this class are considered to be equal if their attributes bot are equal.

Returns:

True if both attributes bot are equal. False otherwise.

__hash__()[source]

See telegram.TelegramObject.__hash__()

__reduce__()[source]

Customizes how copy.deepcopy() processes objects of this type. Bots can not be pickled and this method will always raise an exception.

Added in version 20.0.

Raises:

pickle.PicklingError –

__repr__()[source]

Give a string representation of the bot in the form Bot[token=...].

As this class doesn’t implement object.__str__(), the default implementation will be used, which is equivalent to __repr__().

Returns:

str

async addStickerToSet(user_id, name, sticker, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for add_sticker_to_set()

async add_sticker_to_set(user_id, name, sticker, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers.

Changed in version 20.2: Since Bot API 6.6, the parameter sticker replace the parameters png_sticker, tgs_sticker, webm_sticker, emojis, and mask_position.

Changed in version 20.5: Removed deprecated parameters png_sticker, tgs_sticker, webm_sticker, emojis, and mask_position.

Parameters:

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

  • name (str) – Sticker set name.

  • sticker (telegram.InputSticker) –

    An object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn’t changed.

    Added in version 20.2.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async answerCallbackQuery(callback_query_id, text=None, show_alert=None, url=None, cache_time=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for answer_callback_query()

async answerInlineQuery(inline_query_id, results, cache_time=None, is_personal=None, next_offset=None, button=None, *, current_offset=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for answer_inline_query()

async answerPreCheckoutQuery(pre_checkout_query_id, ok, error_message=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for answer_pre_checkout_query()

async answerShippingQuery(shipping_query_id, ok, shipping_options=None, error_message=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for answer_shipping_query()

async answerWebAppQuery(web_app_query_id, result, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for answer_web_app_query()

async answer_callback_query(callback_query_id, text=None, show_alert=None, url=None, cache_time=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Shortcuts

telegram.CallbackQuery.answer()

Parameters:

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

Keyword Arguments:
Returns:

bool On success, True is returned.

Raises:

telegram.error.TelegramError –

async answer_inline_query(inline_query_id, results, cache_time=None, is_personal=None, next_offset=None, button=None, *, current_offset=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Warning

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

Shortcuts

telegram.InlineQuery.answer()

See also

Working with Files and Media

Changed in version 20.5: Removed deprecated arguments switch_pm_text and switch_pm_parameter.

Parameters:

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

  • button (telegram.InlineQueryResultsButton, optional) –

    A button to be shown above the inline query results.

    Added in version 20.3.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async answer_pre_checkout_query(pre_checkout_query_id, ok, error_message=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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 telegram.Update.pre_checkout_query. Use this method to respond to such pre-checkout queries.

Note

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

Shortcuts

telegram.PreCheckoutQuery.answer()

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned

Return type:

bool

Raises:

telegram.error.TelegramError –

async answer_shipping_query(shipping_query_id, ok, shipping_options=None, error_message=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Shortcuts

telegram.ShippingQuery.answer()

Parameters:

  • 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 (Sequence[telegram.ShippingOption]), optional) –

    Required if ok is True. A sequence of available shipping options.

    Changed in version 20.0: Accepts any collections.abc.Sequence as input instead of just a list.

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async answer_web_app_query(web_app_query_id, result, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Added in version 20.0.

Parameters:
Keyword Arguments:
Returns:

On success, a sent telegram.SentWebAppMessage is returned.

Return type:

telegram.SentWebAppMessage

Raises:

telegram.error.TelegramError –

async approveChatJoinRequest(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for approve_chat_join_request()

async approve_chat_join_request(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Shortcuts

Added in version 13.8.

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async banChatMember(chat_id, user_id, until_date=None, revoke_messages=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for ban_chat_member()

async banChatSenderChat(chat_id, sender_chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for ban_chat_sender_chat()

async ban_chat_member(chat_id, user_id, until_date=None, revoke_messages=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Added in version 13.7.

Parameters:

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

  • 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, which is UTC unless telegram.ext.Defaults.tzinfo is 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.

    Added in version 13.4.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async ban_chat_sender_chat(chat_id, sender_chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Added in version 13.9.

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

property base_file_url[source]

Telegram Bot API file URL, built from Bot.base_file_url and Bot.token.

Added in version 20.0.

Type:

str

property base_url[source]

Telegram Bot API service URL, built from Bot.base_url and Bot.token.

Added in version 20.0.

Type:

str

property bot[source]

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

Warning

This value is the cached return value of get_me(). If the bots profile is changed during runtime, this value won’t reflect the changes until get_me() is called again.

See also

initialize()

Type:

telegram.User

property can_join_groups[source]

Bot’s telegram.User.can_join_groups attribute. Shortcut for the corresponding attribute of bot.

Type:

bool

property can_read_all_group_messages[source]

Bot’s telegram.User.can_read_all_group_messages attribute. Shortcut for the corresponding attribute of bot.

Type:

bool

async close(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

True

Raises:

telegram.error.TelegramError –

async closeForumTopic(chat_id, message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for close_forum_topic()

async closeGeneralForumTopic(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for close_general_forum_topic()

async close_forum_topic(chat_id, message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Shortcuts

telegram.Message.close_forum_topic()

Added in version 20.0.

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async close_general_forum_topic(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to close an open ‘General’ 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.

Added in version 20.0.

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async copyMessage(chat_id, from_chat_id, message_id, caption=None, parse_mode=None, caption_entities=None, disable_notification=None, reply_markup=None, protect_content=None, message_thread_id=None, reply_parameters=None, show_caption_above_media=None, *, allow_sending_without_reply=None, reply_to_message_id=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for copy_message()

async copyMessages(chat_id, from_chat_id, message_ids, disable_notification=None, protect_content=None, message_thread_id=None, remove_caption=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for copy_messages()

async copy_message(chat_id, from_chat_id, message_id, caption=None, parse_mode=None, caption_entities=None, disable_notification=None, reply_markup=None, protect_content=None, message_thread_id=None, reply_parameters=None, show_caption_above_media=None, *, allow_sending_without_reply=None, reply_to_message_id=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Shortcuts

Parameters:
Keyword Arguments:
Returns:

On success, the telegram.MessageId of the sent

message is returned.

Return type:

telegram.MessageId

Raises:

telegram.error.TelegramError –

async copy_messages(chat_id, from_chat_id, message_ids, disable_notification=None, protect_content=None, message_thread_id=None, remove_caption=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Shortcuts

Added in version 20.8.

Parameters:

  • 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_ids (Sequence[int]) – A list of 1 - 100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.

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

  • message_thread_id (int, optional) – Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

  • remove_caption (bool, optional) – Pass True to copy the messages without their captions.

Keyword Arguments:
Returns:

On success, a tuple of MessageId of the sent messages is returned.

Return type:

Tuple[telegram.MessageId]

Raises:

telegram.error.TelegramError –

Alias for create_chat_invite_link()

Alias for create_chat_subscription_invite_link()

async createForumTopic(chat_id, name, icon_color=None, icon_custom_emoji_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for create_forum_topic()

Alias for create_invoice_link()

async createNewStickerSet(user_id, name, title, stickers, sticker_type=None, needs_repainting=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for create_new_sticker_set()

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

Note

When joining public groups via an invite link, Telegram clients may display the usual “Join” button, effectively ignoring the invite link. In particular, the parameter creates_join_request has no effect in this case. However, this behavior is undocument and may be subject to change. See this GitHub thread for some discussion.

Added in version 13.4.

Parameters:

  • 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, which is UTC unless telegram.ext.Defaults.tzinfo is 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.

  • name (str, optional) –

    Invite link name; 0-32 characters.

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

    Added in version 13.8.

Keyword Arguments:
Returns:

telegram.ChatInviteLink

Raises:

telegram.error.TelegramError –

Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator right. The link can be edited using the edit_chat_subscription_invite_link() or revoked using the revoke_chat_invite_link().

Added in version 21.5.

Parameters:

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

  • subscription_period (int) – The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).

  • subscription_price (int) – The number of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1- 2500.

  • name (str, optional) – Invite link name; 0-32 characters.

Keyword Arguments:
Returns:

telegram.ChatInviteLink

Raises:

telegram.error.TelegramError –

async create_forum_topic(chat_id, name, icon_color=None, icon_custom_emoji_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Added in version 20.0.

Parameters:
Keyword Arguments:
Returns:

telegram.ForumTopic

Raises:

telegram.error.TelegramError –

Use this method to create a link for an invoice.

Added in version 20.0.

Parameters:

  • 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 it for your internal processes.

  • provider_token (str) –

    Payments provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.

    Deprecated since version 21.3: As of Bot API 7.4, this parameter is now optional and future versions of the library will make it optional as well.

  • currency (str) – Three-letter ISO 4217 currency code, see more on currencies. Pass XTR for payments in Telegram Stars.

  • prices (Sequence[telegram.LabeledPrice) –

    Price breakdown, a sequence of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.

    Changed in version 20.0: Accepts any collections.abc.Sequence as input instead of just a list.

  • 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. Not supported for payments in Telegram Stars.

  • suggested_tip_amounts (Sequence[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.

    Changed in version 20.0: Accepts any collections.abc.Sequence as input instead of just a list.

  • 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. Ignored for payments in Telegram Stars.

  • need_phone_number (bool, optional) – Pass True, if you require the user’s phone number to complete the order. Ignored for payments in Telegram Stars.

  • need_email (bool, optional) – Pass True, if you require the user’s email address to complete the order. Ignored for payments in Telegram Stars.

  • need_shipping_address (bool, optional) – Pass True, if you require the user’s shipping address to complete the order. Ignored for payments in Telegram Stars.

  • send_phone_number_to_provider (bool, optional) – Pass True, if user’s phone number should be sent to provider. Ignored for payments in Telegram Stars.

  • send_email_to_provider (bool, optional) – Pass True, if user’s email address should be sent to provider. Ignored for payments in Telegram Stars.

  • is_flexible (bool, optional) – Pass True, if the final price depends on the shipping method. Ignored for payments in Telegram Stars.

Keyword Arguments:
Returns:

On success, the created invoice link is returned.

Return type:

str

async create_new_sticker_set(user_id, name, title, stickers, sticker_type=None, needs_repainting=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set thus created.

Changed in version 20.0: The parameter contains_masks has been removed. Use sticker_type instead.

Changed in version 20.2: Since Bot API 6.6, the parameters stickers and sticker_format replace the parameters png_sticker, tgs_sticker,``webm_sticker``, emojis, and mask_position.

Changed in version 20.5: Removed the deprecated parameters mentioned above and adjusted the order of the parameters.

Removed in version 21.2: Removed the deprecated parameter sticker_format.

Parameters:

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

  • stickers (Sequence[telegram.InputSticker]) –

    A sequence of 1- 50 initial stickers to be added to the sticker set.

    Added in version 20.2.

  • sticker_type (str, optional) –

    Type of stickers in the set, pass telegram.Sticker.REGULAR or telegram.Sticker.MASK, or telegram.Sticker.CUSTOM_EMOJI. By default, a regular sticker set is created

    Added in version 20.0.

  • needs_repainting (bool, optional) –

    Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only.

    Added in version 20.2.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async declineChatJoinRequest(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for decline_chat_join_request()

async decline_chat_join_request(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Shortcuts

Added in version 13.8.

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async deleteChatPhoto(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for delete_chat_photo()

async deleteChatStickerSet(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for delete_chat_sticker_set()

async deleteForumTopic(chat_id, message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for delete_forum_topic()

async deleteMessage(chat_id, message_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for delete_message()

async deleteMessages(chat_id, message_ids, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for delete_messages()

async deleteMyCommands(scope=None, language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for delete_my_commands()

async deleteStickerFromSet(sticker, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for delete_sticker_from_set()

async deleteStickerSet(name, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for delete_sticker_set()

async deleteWebhook(drop_pending_updates=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for delete_webhook()

async delete_chat_photo(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async delete_chat_sticker_set(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.ChatFullInfo.can_set_sticker_set optionally returned in get_chat() requests to check if the bot can use this method.

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

async delete_forum_topic(chat_id, message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Shortcuts

telegram.Message.delete_forum_topic()

Added in version 20.0.

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async delete_message(chat_id, message_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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 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 can_delete_messages permission in a supergroup or a channel, it can delete any message there.

Shortcuts

See also

telegram.CallbackQuery.delete_message() (calls delete_message() indirectly, via telegram.Message.delete())

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async delete_messages(chat_id, message_ids, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Shortcuts

telegram.User.delete_messages()

Added in version 20.8.

Parameters:

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

  • message_ids (Sequence[int]) – A list of 1- 100 identifiers of messages to delete. See delete_message() for limitations on which messages can be deleted.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async delete_my_commands(scope=None, language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Added in version 13.7.

See also

get_my_commands(), set_my_commands()

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async delete_sticker_from_set(sticker, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Parameters:

sticker (str) – File identifier of the sticker.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async delete_sticker_set(name, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Added in version 20.2.

Parameters:

name (str) – Sticker set name.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async delete_webhook(drop_pending_updates=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async do_api_request(endpoint, api_kwargs=None, return_type=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None)[source]

Do a request to the Telegram API.

This method is here to make it easier to use new API methods that are not yet supported by this library.

Hint

Since PTB does not know which arguments are passed to this method, some caution is necessary in terms of PTBs utility functionalities. In particular

Added in version 20.8.

Parameters:

  • endpoint (str) – The API endpoint to use, e.g. getMe or get_me.

  • api_kwargs (dict, optional) – The keyword arguments to pass to the API call. If not specified, no arguments are passed.

  • return_type (telegram.TelegramObject, optional) – If specified, the result of the API call will be deserialized into an instance of this class or tuple of instances of this class. If not specified, the raw result of the API call will be returned.

Returns:

The result of the API call. If return_type is not specified, this is a dict or bool, otherwise an instance of return_type or a tuple of return_type.

Raises:

telegram.error.TelegramError –

Alias for edit_chat_invite_link()

Alias for edit_chat_subscription_invite_link()

async editForumTopic(chat_id, message_thread_id, name=None, icon_custom_emoji_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for edit_forum_topic()

async editGeneralForumTopic(chat_id, name, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for edit_general_forum_topic()

async editMessageCaption(chat_id=None, message_id=None, inline_message_id=None, caption=None, reply_markup=None, parse_mode=None, caption_entities=None, show_caption_above_media=None, business_connection_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for edit_message_caption()

async editMessageLiveLocation(chat_id=None, message_id=None, inline_message_id=None, latitude=None, longitude=None, reply_markup=None, horizontal_accuracy=None, heading=None, proximity_alert_radius=None, live_period=None, business_connection_id=None, *, location=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for edit_message_live_location()

async editMessageMedia(media, chat_id=None, message_id=None, inline_message_id=None, reply_markup=None, business_connection_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for edit_message_media()

async editMessageReplyMarkup(chat_id=None, message_id=None, inline_message_id=None, reply_markup=None, business_connection_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for edit_message_reply_markup()

async editMessageText(text, chat_id=None, message_id=None, inline_message_id=None, parse_mode=None, reply_markup=None, entities=None, link_preview_options=None, business_connection_id=None, *, disable_web_page_preview=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for edit_message_text()

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.

Note

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.

Added in version 13.4.

Parameters:
Keyword Arguments:
Returns:

telegram.ChatInviteLink

Raises:

telegram.error.TelegramError –

Use this method to edit a subscription invite link created by the bot. The bot must have telegram.ChatPermissions.can_invite_users administrator right.

Added in version 21.5.

Parameters:

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

  • invite_link (str | telegram.ChatInviteLink) – The invite link to edit.

  • name (str, optional) –

    Invite link name; 0-32 characters.

    Tip

    Omitting this argument removes the name of the invite link.

Keyword Arguments:
Returns:

telegram.ChatInviteLink

Raises:

telegram.error.TelegramError –

async edit_forum_topic(chat_id, message_thread_id, name=None, icon_custom_emoji_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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 the can_manage_topics administrator rights, unless it is the creator of the topic.

Shortcuts

telegram.Message.edit_forum_topic()

Added in version 20.0.

Parameters:

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

  • name (str, optional) – New topic name, 1- 128 characters. If not specified or empty, the current name of the topic will be kept.

  • 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.Pass an empty string to remove the icon. If not specified, the current icon will be kept.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async edit_general_forum_topic(chat_id, name, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to edit the name of the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights.

Added in version 20.0.

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async edit_message_caption(chat_id=None, message_id=None, inline_message_id=None, caption=None, reply_markup=None, parse_mode=None, caption_entities=None, show_caption_above_media=None, business_connection_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to edit captions of messages.

Note

  • It is currently only possible to edit messages without telegram.Message.reply_markup or with inline keyboards.

  • Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Shortcuts

Parameters:
Keyword Arguments:
Returns:

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

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async edit_message_live_location(chat_id=None, message_id=None, inline_message_id=None, latitude=None, longitude=None, reply_markup=None, horizontal_accuracy=None, heading=None, proximity_alert_radius=None, live_period=None, business_connection_id=None, *, location=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Note

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

Shortcuts

Parameters:

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

  • 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) – An object for a new inline keyboard.

  • live_period (int, optional) –

    New period in seconds during which the location can be updated, starting from the message send date. If 2147483647 is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged

    Added in version 21.2..

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message to be edited was sent

    Added in version 21.4.

Keyword Arguments:
Returns:

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

Return type:

telegram.Message

async edit_message_media(media, chat_id=None, message_id=None, inline_message_id=None, reply_markup=None, business_connection_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Note

  • It is currently only possible to edit messages without telegram.Message.reply_markup or with inline keyboards.

  • Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Shortcuts

See also

Working with Files and Media

Parameters:

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

  • 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) – An object for an inline keyboard.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message to be edited was sent

    Added in version 21.4.

Keyword Arguments:
Returns:

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

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async edit_message_reply_markup(chat_id=None, message_id=None, inline_message_id=None, reply_markup=None, business_connection_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Note

  • It is currently only possible to edit messages without telegram.Message.reply_markup or with inline keyboards.

  • Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Shortcuts

Parameters:

  • 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) – An object for an inline keyboard.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message to be edited was sent

    Added in version 21.4.

Keyword Arguments:
Returns:

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

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async edit_message_text(text, chat_id=None, message_id=None, inline_message_id=None, parse_mode=None, reply_markup=None, entities=None, link_preview_options=None, business_connection_id=None, *, disable_web_page_preview=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to edit text and game messages.

Note

  • It is currently only possible to edit messages without telegram.Message.reply_markup or with inline keyboards.

  • Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Shortcuts

See also

telegram.Game.text

Parameters:
Keyword Arguments:
Returns:

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

Return type:

telegram.Message

Raises:

Alias for export_chat_invite_link()

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.

Note

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.

Parameters:

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

Keyword Arguments:
Returns:

New invite link on success.

Return type:

str

Raises:

telegram.error.TelegramError –

property first_name[source]

Bot’s first name. Shortcut for the corresponding attribute of bot.

Type:

str

async forwardMessage(chat_id, from_chat_id, message_id, disable_notification=None, protect_content=None, message_thread_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for forward_message()

async forwardMessages(chat_id, from_chat_id, message_ids, disable_notification=None, protect_content=None, message_thread_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for forward_messages()

async forward_message(chat_id, from_chat_id, message_id, disable_notification=None, protect_content=None, message_thread_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Note

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

Shortcuts

Parameters:

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

    Added in version 13.10.

  • message_thread_id (int, optional) –

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

    Added in version 20.0.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async forward_messages(chat_id, from_chat_id, message_ids, disable_notification=None, protect_content=None, message_thread_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Shortcuts

Added in version 20.8.

Parameters:

  • 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_ids (Sequence[int]) – A list of 1- 100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.

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

  • message_thread_id (int, optional) – Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

Keyword Arguments:
Returns:

On success, a tuple of MessageId of sent messages is returned.

Return type:

Tuple[telegram.Message]

Raises:

telegram.error.TelegramError –

async getBusinessConnection(business_connection_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_business_connection()

async getChat(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_chat()

async getChatAdministrators(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_chat_administrators()

async getChatMember(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_chat_member()

async getChatMemberCount(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_chat_member_count()

async getChatMenuButton(chat_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_chat_menu_button()

async getCustomEmojiStickers(custom_emoji_ids, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_custom_emoji_stickers()

async getFile(file_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_file()

async getForumTopicIconStickers(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_forum_topic_icon_stickers()

async getGameHighScores(user_id, chat_id=None, message_id=None, inline_message_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_game_high_scores()

async getMe(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_me()

async getMyCommands(scope=None, language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_my_commands()

async getMyDefaultAdministratorRights(for_channels=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_my_default_administrator_rights()

async getMyDescription(language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_my_description()

async getMyName(language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_my_name()

async getMyShortDescription(language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_my_short_description()

async getStarTransactions(offset=None, limit=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_star_transactions()

async getStickerSet(name, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_sticker_set()

async getUpdates(offset=None, limit=None, timeout=None, allowed_updates=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_updates()

async getUserChatBoosts(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_user_chat_boosts()

async getUserProfilePhotos(user_id, offset=None, limit=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_user_profile_photos()

async getWebhookInfo(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_webhook_info()

async get_business_connection(business_connection_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to get information about the connection of the bot with a business account.

Added in version 21.1.

Parameters:

business_connection_id (str) – Unique identifier of the business connection.

Keyword Arguments:
Returns:

On success, the object containing the business

connection information is returned.

Return type:

telegram.BusinessConnection

Raises:

telegram.error.TelegramError –

async get_chat(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Changed in version 21.2: In accordance to Bot API 7.3, this method now returns a telegram.ChatFullInfo.

Parameters:

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

Keyword Arguments:
Returns:

telegram.ChatFullInfo

Raises:

telegram.error.TelegramError –

async get_chat_administrators(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Changed in version 20.0: Returns a tuple instead of a list.

Parameters:

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

Keyword Arguments:
Returns:

On success, returns a tuple 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.

Return type:

Tuple[telegram.ChatMember]

Raises:

telegram.error.TelegramError –

async get_chat_member(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat.

Parameters:

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

Keyword Arguments:
Returns:

telegram.ChatMember

Raises:

telegram.error.TelegramError –

async get_chat_member_count(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Added in version 13.7.

Parameters:

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

Keyword Arguments:
Returns:

Number of members in the chat.

Return type:

int

Raises:

telegram.error.TelegramError –

async get_chat_menu_button(chat_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Shortcuts

telegram.User.get_menu_button()

See also

set_chat_menu_button(), telegram.Chat.set_menu_button(), telegram.User.set_menu_button()

Added in version 20.0.

Parameters:

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

Keyword Arguments:
Returns:

On success, the current menu button is returned.

Return type:

telegram.MenuButton

async get_custom_emoji_stickers(custom_emoji_ids, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Changed in version 20.0: Returns a tuple instead of a list.

Parameters:

custom_emoji_ids (Sequence[str]) –

Sequence of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.

Changed in version 20.0: Accepts any collections.abc.Sequence as input instead of just a list.

Keyword Arguments:
Returns:

Tuple[telegram.Sticker]

Raises:

telegram.error.TelegramError –

async get_file(file_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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 20 MB in size. The file can then be e.g. downloaded with telegram.File.download_to_drive(). 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.

Note

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.

Shortcuts

See also

Working with Files and Media

Parameters:

file_id (str | telegram.Animation | telegram.Audio | telegram.ChatPhoto | telegram.Document | telegram.PhotoSize | telegram.Sticker | telegram.Video | telegram.VideoNote | telegram.Voice) – Either the file identifier or an object that has a file_id attribute to get file information about.

Keyword Arguments:
Returns:

telegram.File

Raises:

telegram.error.TelegramError –

async get_forum_topic_icon_stickers(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters.

Added in version 20.0.

Keyword Arguments:
Returns:

Tuple[telegram.Sticker]

Raises:

telegram.error.TelegramError –

async get_game_high_scores(user_id, chat_id=None, message_id=None, inline_message_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Note

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.

Shortcuts

Changed in version 20.0: Returns a tuple instead of a list.

Parameters:
Keyword Arguments:
Returns:

Tuple[telegram.GameHighScore]

Raises:

telegram.error.TelegramError –

async get_me(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Keyword Arguments:
Returns:

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

Return type:

telegram.User

Raises:

telegram.error.TelegramError –

async get_my_commands(scope=None, language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

See also

set_my_commands(), delete_my_commands()

Changed in version 20.0: Returns a tuple instead of a list.

Parameters:
Keyword Arguments:
Returns:

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

Return type:

Tuple[telegram.BotCommand]

Raises:

telegram.error.TelegramError –

async get_my_default_administrator_rights(for_channels=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

See also

set_my_default_administrator_rights()

Added in version 20.0.

Parameters:

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.

Keyword Arguments:
Returns:

On success.

Return type:

telegram.ChatAdministratorRights

Raises: