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, contextlib.AbstractAsyncContextManager

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

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

Use In

telegram.ext.ApplicationBuilder.bot()

Available In

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

Used for sending a gift

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

set_user_emoji_status()

Used for setting the users status emoji

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

Verification on behalf of an organization

verify_chat()

Used for verifying a chat

verify_user()

Used for verifying a user

remove_chat_verification()

Used for removing the verification from a chat

remove_user_verification()

Used for removing the verification from a user

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

Payments and Stars

create_invoice_link()

Used to generate an HTTP link for an invoice

edit_user_star_subscription()

Used for editing a user’s star subscription

get_star_transactions()

Used for obtaining the bot’s Telegram Stars transactions

refund_star_payment()

Used for refunding a payment in Telegram Stars

gift_premium_subscription()

Used for gifting Telegram Premium to another user.

Business Related Methods

get_business_connection()

Used for getting information about the business account.

get_business_account_gifts()

Used for getting gifts owned by the business account.

get_business_account_star_balance()

Used for getting the amount of Stars owned by the business account.

read_business_message()

Used for marking a message as read.

delete_story()

Used for deleting business stories posted by the bot.

delete_business_messages()

Used for deleting business messages.

remove_business_account_profile_photo()

Used for removing the business accounts profile photo

set_business_account_name()

Used for setting the business account name.

set_business_account_username()

Used for setting the business account username.

set_business_account_bio()

Used for setting the business account bio.

set_business_account_gift_settings()

Used for setting the business account gift settings.

set_business_account_profile_photo()

Used for setting the business accounts profile photo

post_story()

Used for posting a story on behalf of business account.

edit_story()

Used for editing business stories posted by the bot.

convert_gift_to_stars()

Used for converting owned reqular gifts to stars.

upgrade_gift()

Used for upgrading owned regular gifts to unique ones.

transfer_gift()

Used for transferring owned unique gifts to another user.

transfer_business_account_stars()

Used for transfering Stars from the business account balance to the bot’s balance.

Miscellaneous

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

Used for getting information about gifts available for sending

get_me()

Used for getting basic information about the bot

save_prepared_inline_message()

Used for storing a message to be sent by a user of a Mini App

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 | datetime.timedelta, optional) –

    The maximum amount of time in seconds that the result of the callback query may be cached client-side. Defaults to 0.

    Changed in version 21.11: datetime.timedelta objects are accepted in addition to plain int values.

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.

See also

Working with Files and Media

Shortcuts

telegram.InlineQuery.answer()

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 | datetime.timedelta, optional) –

    The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.

    Changed in version 21.11: datetime.timedelta objects are accepted in addition to plain int values.

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

Shortcuts

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.

Shortcuts

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

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.

Shortcuts

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 convertGiftToStars(business_connection_id, owned_gift_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for convert_gift_to_stars()

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

Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right.

Added in version 22.1.

Parameters:
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_paid_broadcast=None, video_start_timestamp=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_paid_broadcast=None, video_start_timestamp=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.

Shortcuts

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

Shortcuts

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 | datetime.timedelta) –

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

    Changed in version 21.11: datetime.timedelta objects are accepted in addition to plain int values.

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

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

Shortcuts

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:

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent. For payments in Telegram Stars only.

    Added in version 21.8.

  • 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, optional) –

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

    Changed in version 21.11: Bot API 7.4 made this parameter is optional and this is now reflected in the function signature.

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

  • subscription_period (int | datetime.timedelta, optional) –

    The time the subscription will be active for before the next payment, either as number of seconds or as datetime.timedelta object. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must not exceed 10000 Telegram Stars.

    Added in version 21.8.

  • 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 deleteBusinessMessages(business_connection_id, message_ids, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for delete_business_messages()

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 deleteStory(business_connection_id, story_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for delete_story()

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_business_messages(business_connection_id, message_ids, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Added in version 22.1.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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.

Shortcuts

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

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.

See also

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

Shortcuts

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

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 | telegram.Sticker) –

File identifier of the sticker or the sticker object.

Changed in version 21.10: Accepts also telegram.Sticker instances.

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_story(business_connection_id, story_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Added in version 22.1.

Parameters:
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()

async editStory(business_connection_id, story_id, content, caption=None, parse_mode=None, caption_entities=None, areas=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for edit_story()

async editUserStarSubscription(user_id, telegram_payment_charge_id, is_canceled, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for edit_user_star_subscription()

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.

Shortcuts

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.

Shortcuts

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

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.

Shortcuts

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 | datetime.timedelta, 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..

    Changed in version 21.11: datetime.timedelta objects are accepted in addition to plain int values.

  • 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, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can’t be uploaded; use a previously uploaded file via its file_id or specify a URL.

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.

See also

Working with Files and Media

Shortcuts

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.

See also

telegram.Game.text

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:
async edit_story(business_connection_id, story_id, content, caption=None, parse_mode=None, caption_entities=None, areas=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Added in version 22.1.

Parameters:
Keyword Arguments:
Returns:

Story

Raises:

telegram.error.TelegramError –

async edit_user_star_subscription(user_id, telegram_payment_charge_id, is_canceled, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Added in version 21.8.

Parameters:

  • user_id (int) – Identifier of the user whose subscription will be edited.

  • telegram_payment_charge_id (str) – Telegram payment identifier for the subscription.

  • is_canceled (bool) – Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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.

Shortcuts

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, video_start_timestamp=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, video_start_timestamp=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.

  • video_start_timestamp (int, optional) –

    New start timestamp for the forwarded video in the message

    Added in version 21.11.

  • 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 getAvailableGifts(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_available_gifts()

async getBusinessAccountGifts(business_connection_id, exclude_unsaved=None, exclude_saved=None, exclude_unlimited=None, exclude_limited=None, exclude_unique=None, sort_by_price=None, offset=None, limit=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for get_business_account_gifts()

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

Alias for get_business_account_star_balance()

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_available_gifts(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters.

Added in version 21.8.

Keyword Arguments:
Returns:

telegram.Gifts

Raises:

telegram.error.TelegramError –

async get_business_account_gifts(business_connection_id, exclude_unsaved=None, exclude_saved=None, exclude_unlimited=None, exclude_limited=None, exclude_unique=None, sort_by_price=None, offset=None, limit=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Added in version 22.1.

Parameters:

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

  • exclude_unsaved (bool, optional) – Pass True to exclude gifts that aren’t saved to the account’s profile page.

  • exclude_saved (bool, optional) – Pass True to exclude gifts that are saved to the account’s profile page.

  • exclude_unlimited (bool, optional) – Pass True to exclude gifts that can be purchased an unlimited number of times.

  • exclude_limited (bool, optional) – Pass True to exclude gifts that can be purchased a limited number of times.

  • exclude_unique (bool, optional) – Pass True to exclude unique gifts.

  • sort_by_price (bool, optional) – Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.

  • offset (str, optional) – Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.

  • limit (int, optional) – The maximum number of gifts to be returned; 1- 100. Defaults to 100.

Keyword Arguments:
Returns:

telegram.OwnedGifts

Raises:

telegram.error.TelegramError –

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

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

Added in version 22.1.

Parameters:

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

Keyword Arguments:
Returns:

telegram.StarAmount

Raises:

telegram.error.TelegramError –

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.

Shortcuts

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.

Shortcuts

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.

Shortcuts

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.

See also

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

Shortcuts

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.

See also

Working with Files and Media

Shortcuts

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:

telegram.error.TelegramError –

async get_my_description(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 bot description for the given user language.

Parameters:

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

Keyword Arguments:
Returns:

On success, the bot description is returned.

Return type:

telegram.BotDescription

Raises:

telegram.error.TelegramError –

async get_my_name(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 bot name for the given user language.

Parameters:

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

Keyword Arguments:
Returns:

On success, the bot name is returned.

Return type:

telegram.BotName

Raises:

telegram.error.TelegramError –

async get_my_short_description(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 bot short description for the given user language.

Parameters:

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

Keyword Arguments:
Returns:

On success, the bot short description is

returned.

Return type:

telegram.BotShortDescription

Raises:

telegram.error.TelegramError –

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

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

Added in version 21.4.

Parameters:

  • offset (int, optional) – Number of transactions to skip in the response.

  • limit (int, optional) – The maximum number of transactions to be retrieved. Values between 1- 100 are accepted. Defaults to 100.

Keyword Arguments:
Returns:

On success.

Return type:

telegram.StarTransactions

Raises:

telegram.error.TelegramError –

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

Use this method to get a sticker set.

Parameters:

name (str) – Name of the sticker set.

Keyword Arguments:
Returns:

telegram.StickerSet

Raises:

telegram.error.TelegramError –

async get_updates(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]

Use this method to receive incoming updates using long polling.

Note

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

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

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

See also

telegram.ext.Application.run_polling(), telegram.ext.Updater.start_polling()

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

Parameters:

  • 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 this method 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 be 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.

  • allowed_updates (Sequence[str]), optional) –

    A sequence 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 sequence to receive all updates except telegram.Update.chat_member, telegram.Update.message_reaction and telegram.Update.message_reaction_count (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.

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

Keyword Arguments:
Returns:

tuple[telegram.Update]

Raises:

telegram.error.TelegramError –

async get_user_chat_boosts(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 the list of boosts added to a chat by a user. Requires administrator rights in the chat.

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

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

Keyword Arguments:
Returns:

On success, the object containing the list of boosts

is returned.

Return type:

telegram.UserChatBoosts

Raises:

telegram.error.TelegramError –

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

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

Shortcuts

telegram.User.get_profile_photos()

Parameters:

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

Keyword Arguments:
Returns:

telegram.UserProfilePhotos

Raises:

telegram.error.TelegramError –

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

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.

Keyword Arguments:
Returns:

telegram.WebhookInfo

async giftPremiumSubscription(user_id, month_count, star_count, text=None, text_parse_mode=None, text_entities=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for gift_premium_subscription()

async gift_premium_subscription(user_id, month_count, star_count, text=None, text_parse_mode=None, text_entities=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Gifts a Telegram Premium subscription to the given user.

Shortcuts

telegram.User.gift_premium_subscription()

Added in version 22.1.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Alias for hide_general_forum_topic()

async hide_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 hide the ‘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. The topic will be automatically closed if it was open.

Shortcuts

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 –

property id[source]

Unique identifier for this bot. Shortcut for the corresponding attribute of bot.

Type:

int

async initialize()[source]

Initialize resources used by this class. Currently calls get_me() to cache bot and calls telegram.request.BaseRequest.initialize() for the request objects used by this bot.

See also

shutdown()

Added in version 20.0.

property last_name[source]

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

Type:

str

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

Alias for leave_chat()

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

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

Shortcuts

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 –

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

Type:

str

property local_mode[source]

Whether this bot is running in local mode.

Added in version 20.0.

Type:

bool

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

Alias for log_out()

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

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.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

True

Raises:

telegram.error.TelegramError –

property name[source]

Bot’s @username. Shortcut for the corresponding attribute of bot.

Type:

str

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

Alias for pin_chat_message()

async pin_chat_message(chat_id, message_id, disable_notification=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 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 can_pin_messages admin right in a supergroup or can_edit_messages admin right in a channel.

Shortcuts

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

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be pinned.

    Added in version 21.5.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async postStory(business_connection_id, content, active_period, caption=None, parse_mode=None, caption_entities=None, areas=None, post_to_chat_page=None, protect_content=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for post_story()

async post_story(business_connection_id, content, active_period, caption=None, parse_mode=None, caption_entities=None, areas=None, post_to_chat_page=None, protect_content=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Added in version 22.1.

Parameters:
Keyword Arguments:
Returns:

Story

Raises:

telegram.error.TelegramError –

property private_key[source]

Deserialized private key for decryption of telegram passport data.

Added in version 20.0.

async 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, is_anonymous=None, can_manage_chat=None, can_manage_video_chats=None, can_manage_topics=None, can_post_stories=None, can_edit_stories=None, can_delete_stories=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for promote_chat_member()

async 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, is_anonymous=None, can_manage_chat=None, can_manage_video_chats=None, can_manage_topics=None, can_post_stories=None, can_edit_stories=None, can_delete_stories=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Shortcuts

Changed in version 20.0: The argument can_manage_voice_chats was renamed to can_manage_video_chats in accordance to Bot API 6.0.

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.

  • 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, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.

    Added in version 13.4.

  • can_manage_video_chats (bool, optional) –

    Pass True, if the administrator can manage video chats.

    Added in version 20.0.

  • 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 post messages in the channel, or access channel statistics; for channels only.

  • can_edit_messages (bool, optional) – Pass True, if the administrator can edit messages of other users and can pin messages, for 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, or access supergroup statistics.

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

  • can_promote_members (bool, optional) – Pass True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user).

  • can_manage_topics (bool, optional) –

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

    Added in version 20.0.

  • can_post_stories (bool, optional) –

    Pass True, if the administrator can post stories to the chat.

    Added in version 20.6.

  • can_edit_stories (bool, optional) –

    Pass True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat’s story archive

    Added in version 20.6.

  • can_delete_stories (bool, optional) –

    Pass True, if the administrator can delete stories posted by other users.

    Added in version 20.6.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Alias for read_business_message()

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

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

Shortcuts

Added in version 22.1.

Parameters:

  • business_connection_id (str) – Unique identifier of the business connection on behalf of which to read the message.

  • chat_id (int) – Unique identifier of the chat in which the message was received. The chat must have been active in the last 86400 seconds.

  • message_id (int) – Unique identifier of the message to mark as read.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Alias for refund_star_payment()

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

Refunds a successful payment in Telegram Stars.

Shortcuts

telegram.User.refund_star_payment()

Added in version 21.3.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Alias for remove_business_account_profile_photo()

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

Alias for remove_chat_verification()

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

Alias for remove_user_verification()

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

Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right.

Added in version 22.1.

Parameters:

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

  • is_public (bool, optional) – Pass True to remove the public photo, which will be visible even if the main photo is hidden by the business account’s privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

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

Shortcuts

Added in version 21.10.

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 remove_user_verification(user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Shortcuts

telegram.User.remove_verification()

Added in version 21.10.

Parameters:

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 reopenForumTopic(chat_id, message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for reopen_forum_topic()

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

Alias for reopen_general_forum_topic()

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

Shortcuts

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 reopen_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 reopen a closed ‘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. The topic will be automatically unhidden if it was hidden.

Shortcuts

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 replaceStickerInSet(user_id, name, old_sticker, sticker, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for replace_sticker_in_set()

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

Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling delete_sticker_from_set(), then add_sticker_to_set(), then set_sticker_position_in_set().

Added in version 21.1.

Parameters:

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

  • name (str) – Sticker set name.

  • old_sticker (str | Sticker) –

    File identifier of the replaced sticker or the sticker object itself.

    Changed in version 21.10: Accepts also telegram.Sticker instances.

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

property request[source]

The BaseRequest object used by this bot.

Warning

Requests to the Bot API are made by the various methods of this class. This attribute should not be used manually.

async restrictChatMember(chat_id, user_id, permissions, until_date=None, use_independent_chat_permissions=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for restrict_chat_member()

async restrict_chat_member(chat_id, user_id, permissions, until_date=None, use_independent_chat_permissions=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

See also

telegram.ChatPermissions.all_permissions()

Shortcuts

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

Alias for revoke_chat_invite_link()

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.

Shortcuts

Added in version 13.4.

Parameters:
Keyword Arguments:
Returns:

telegram.ChatInviteLink

Raises:

telegram.error.TelegramError –

async savePreparedInlineMessage(user_id, result, allow_user_chats=None, allow_bot_chats=None, allow_group_chats=None, allow_channel_chats=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for save_prepared_inline_message()

async save_prepared_inline_message(user_id, result, allow_user_chats=None, allow_bot_chats=None, allow_group_chats=None, allow_channel_chats=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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

Added in version 21.8.

Parameters:
Keyword Arguments:
Returns:

On success, the prepared message is returned.

Return type:

telegram.PreparedInlineMessage

Raises:

telegram.error.TelegramError –

async sendAnimation(chat_id, animation, duration=None, width=None, height=None, caption=None, parse_mode=None, disable_notification=None, reply_markup=None, caption_entities=None, protect_content=None, message_thread_id=None, has_spoiler=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, show_caption_above_media=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for send_animation()

async sendAudio(chat_id, audio, duration=None, performer=None, title=None, caption=None, disable_notification=None, reply_markup=None, parse_mode=None, caption_entities=None, protect_content=None, message_thread_id=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for send_audio()

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

Alias for send_chat_action()

async sendContact(chat_id, phone_number=None, first_name=None, last_name=None, disable_notification=None, reply_markup=None, vcard=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, contact=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for send_contact()

async sendDice(chat_id, disable_notification=None, reply_markup=None, emoji=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=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 send_dice()

async sendDocument(chat_id, document, caption=None, disable_notification=None, reply_markup=None, parse_mode=None, disable_content_type_detection=None, caption_entities=None, protect_content=None, message_thread_id=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for send_document()

async sendGame(chat_id, game_short_name, disable_notification=None, reply_markup=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=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 send_game()

async sendGift(gift_id, text=None, text_parse_mode=None, text_entities=None, pay_for_upgrade=None, chat_id=None, user_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for send_gift()

async sendInvoice(chat_id, title, description, payload, currency, prices, provider_token=None, 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_markup=None, provider_data=None, send_phone_number_to_provider=None, send_email_to_provider=None, max_tip_amount=None, suggested_tip_amounts=None, protect_content=None, message_thread_id=None, reply_parameters=None, message_effect_id=None, allow_paid_broadcast=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 send_invoice()

async sendLocation(chat_id, latitude=None, longitude=None, disable_notification=None, reply_markup=None, live_period=None, horizontal_accuracy=None, heading=None, proximity_alert_radius=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, location=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for send_location()

async sendMediaGroup(chat_id, media, disable_notification=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=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, caption=None, parse_mode=None, caption_entities=None)[source]

Alias for send_media_group()

async sendMessage(chat_id, text, parse_mode=None, entities=None, disable_notification=None, protect_content=None, reply_markup=None, message_thread_id=None, link_preview_options=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_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 send_message()

async sendPaidMedia(chat_id, star_count, media, caption=None, parse_mode=None, caption_entities=None, show_caption_above_media=None, disable_notification=None, protect_content=None, reply_parameters=None, reply_markup=None, business_connection_id=None, payload=None, allow_paid_broadcast=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 send_paid_media()

async sendPhoto(chat_id, photo, caption=None, disable_notification=None, reply_markup=None, parse_mode=None, caption_entities=None, protect_content=None, message_thread_id=None, has_spoiler=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, show_caption_above_media=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for send_photo()

async sendPoll(chat_id, question, options, is_anonymous=None, type=None, allows_multiple_answers=None, correct_option_id=None, is_closed=None, disable_notification=None, reply_markup=None, explanation=None, explanation_parse_mode=None, open_period=None, close_date=None, explanation_entities=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, question_parse_mode=None, question_entities=None, message_effect_id=None, allow_paid_broadcast=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 send_poll()

async sendSticker(chat_id, sticker, disable_notification=None, reply_markup=None, protect_content=None, message_thread_id=None, emoji=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=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 send_sticker()

async sendVenue(chat_id, latitude=None, longitude=None, title=None, address=None, foursquare_id=None, disable_notification=None, reply_markup=None, foursquare_type=None, google_place_id=None, google_place_type=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, venue=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for send_venue()

async sendVideo(chat_id, video, duration=None, caption=None, disable_notification=None, reply_markup=None, width=None, height=None, parse_mode=None, supports_streaming=None, caption_entities=None, protect_content=None, message_thread_id=None, has_spoiler=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, show_caption_above_media=None, cover=None, start_timestamp=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for send_video()

async sendVideoNote(chat_id, video_note, duration=None, length=None, disable_notification=None, reply_markup=None, protect_content=None, message_thread_id=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for send_video_note()

async sendVoice(chat_id, voice, duration=None, caption=None, disable_notification=None, reply_markup=None, parse_mode=None, caption_entities=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for send_voice()

async send_animation(chat_id, animation, duration=None, width=None, height=None, caption=None, parse_mode=None, disable_notification=None, reply_markup=None, caption_entities=None, protect_content=None, message_thread_id=None, has_spoiler=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, show_caption_above_media=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Note

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

See also

Working with Files and Media

Shortcuts

Changed in version 20.5: Removed deprecated argument thumb. Use thumbnail instead.

Parameters:

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

  • animation (str | file object | InputFile | bytes | pathlib.Path | telegram.Animation) –

    Animation 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting. Lastly you can pass an existing telegram.Animation object to send.

    Changed in version 13.2: Accept bytes as input.

  • duration (int | datetime.timedelta, optional) –

    Duration of sent animation in seconds.

    Changed in version 21.11: datetime.timedelta objects are accepted in addition to plain int values.

  • width (int, optional) – Animation width.

  • height (int, optional) – Animation height.

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

  • parse_mode (str, optional) – Mode for parsing entities. See telegram.constants.ParseMode and formatting options for more details.

  • caption_entities (Sequence[telegram.MessageEntity], optional) –

    Sequence of special entities that appear in the caption, which can be specified instead of parse_mode.

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

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

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • has_spoiler (bool, optional) –

    Pass True if the animation needs to be covered with a spoiler animation.

    Added in version 20.0.

  • thumbnail (file object | bytes | pathlib.Path | str, 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting.

    Added in version 20.2.

  • reply_parameters (telegram.ReplyParameters, optional) –

    Description of the message to reply to.

    Added in version 20.8.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent.

    Added in version 21.1.

  • message_effect_id (str, optional) –

    Unique identifier of the message effect to be added to the message; for private chats only.

    Added in version 21.3.

  • allow_paid_broadcast (bool, optional) –

    Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.

    Added in version 21.7.

  • show_caption_above_media (bool, optional) –

    Pass True, if the caption must be shown above the message media.

    Added in version 21.3.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_audio(chat_id, audio, duration=None, performer=None, title=None, caption=None, disable_notification=None, reply_markup=None, parse_mode=None, caption_entities=None, protect_content=None, message_thread_id=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

See also

Working with Files and Media

Shortcuts

Changed in version 20.5: Removed deprecated argument thumb. Use thumbnail instead.

Parameters:

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

  • audio (str | file object | InputFile | bytes | pathlib.Path | telegram.Audio) –

    Audio 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting. Lastly you can pass an existing telegram.Audio object to send.

    Changed in version 13.2: Accept bytes as input.

    Changed in version 20.0: File paths as input is also accepted for bots not running in local_mode.

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

  • parse_mode (str, optional) – Mode for parsing entities. See telegram.constants.ParseMode and formatting options for more details.

  • caption_entities (Sequence[telegram.MessageEntity], optional) –

    Sequence of special entities that appear in the caption, which can be specified instead of parse_mode.

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

  • duration (int | datetime.timedelta, optional) –

    Duration of sent audio in seconds.

    Changed in version 21.11: datetime.timedelta objects are accepted in addition to plain int values.

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

    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.

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • thumbnail (file object | bytes | pathlib.Path | str, 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting.

    Added in version 20.2.

  • reply_parameters (ReplyParameters, optional) –

    Description of the message to reply to.

    Added in version 20.8.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent.

    Added in version 21.1.

  • message_effect_id (str, optional) –

    Unique identifier of the message effect to be added to the message; for private chats only.

    Added in version 21.3.

  • allow_paid_broadcast (bool, optional) –

    Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.

    Added in version 21.7.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

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

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.

Shortcuts

Parameters:

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

  • action (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.constants.ChatAction.

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

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent.

    Added in version 21.1.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async send_contact(chat_id, phone_number=None, first_name=None, last_name=None, disable_notification=None, reply_markup=None, vcard=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, contact=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to send phone contacts.

Note

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

Shortcuts

Parameters:

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

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

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • reply_parameters (telegram.ReplyParameters, optional) –

    Description of the message to reply to.

    Added in version 20.8.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent.

    Added in version 21.1.

  • message_effect_id (str, optional) –

    Unique identifier of the message effect to be added to the message; for private chats only.

    Added in version 21.3.

  • allow_paid_broadcast (bool, optional) –

    Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.

    Added in version 21.7.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_dice(chat_id, disable_notification=None, reply_markup=None, emoji=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=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 send an animated emoji that will display a random value.

Shortcuts

Parameters:
Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_document(chat_id, document, caption=None, disable_notification=None, reply_markup=None, parse_mode=None, disable_content_type_detection=None, caption_entities=None, protect_content=None, message_thread_id=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

See also

Working with Files and Media

Shortcuts

Changed in version 20.5: Removed deprecated argument thumb. Use thumbnail instead.

Parameters:

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

  • document (str | file object | InputFile | 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting. Lastly you can pass an existing telegram.Document object to send.

    Note

    Sending by URL will currently only work GIF, PDF & ZIP files.

    Changed in version 13.2: Accept bytes as input.

    Changed in version 20.0: File paths as input is also accepted for bots not running in local_mode.

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

  • parse_mode (str, optional) – Mode for parsing entities. See telegram.constants.ParseMode and formatting options for more details.

  • caption_entities (Sequence[telegram.MessageEntity], optional) –

    Sequence of special entities that appear in the caption, which can be specified instead of parse_mode.

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

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

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • thumbnail (file object | bytes | pathlib.Path | str, 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting.

    Added in version 20.2.

  • reply_parameters (telegram.ReplyParameters, optional) –

    Description of the message to reply to.

    Added in version 20.8.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent.

    Added in version 21.1.

  • message_effect_id (str, optional) –

    Unique identifier of the message effect to be added to the message; for private chats only.

    Added in version 21.3.

  • allow_paid_broadcast (bool, optional) –

    Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.

    Added in version 21.7.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_game(chat_id, game_short_name, disable_notification=None, reply_markup=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=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 send a game.

Shortcuts

Parameters:

  • chat_id (int) – 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.

    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.

  • reply_markup (telegram.InlineKeyboardMarkup, optional) – An 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.

  • reply_parameters (telegram.ReplyParameters, optional) –

    Description of the message to reply to.

    Added in version 20.8.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent.

    Added in version 21.1.

  • message_effect_id (str, optional) –

    Unique identifier of the message effect to be added to the message; for private chats only.

    Added in version 21.3.

  • allow_paid_broadcast (bool, optional) –

    Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.

    Added in version 21.7.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_gift(gift_id, text=None, text_parse_mode=None, text_entities=None, pay_for_upgrade=None, chat_id=None, user_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Sends a gift to the given user or channel chat. The gift can’t be converted to Telegram Stars by the receiver.

Shortcuts

Added in version 21.8.

Changed in version 22.1: Bot API 8.3 made user_id optional. In version 22.1, the methods signature was changed accordingly.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async send_invoice(chat_id, title, description, payload, currency, prices, provider_token=None, 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_markup=None, provider_data=None, send_phone_number_to_provider=None, send_email_to_provider=None, max_tip_amount=None, suggested_tip_amounts=None, protect_content=None, message_thread_id=None, reply_parameters=None, message_effect_id=None, allow_paid_broadcast=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 send invoices.

Warning

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.

Shortcuts

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

Parameters:

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

  • provider_token (str, optional) –

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

    Changed in version 21.11: Bot API 7.4 made this parameter is optional and this is now reflected in the function signature.

  • currency (str) –

    Three-letter ISO 4217 currency code, see more on currencies. Pass XTR for payment 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 payment 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 payment in Telegram Stars.

    Added in version 13.5.

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

    Added in version 13.5.

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

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

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

  • reply_markup (telegram.InlineKeyboardMarkup, optional) – An object for an inline keyboard. If empty, one ‘Pay total price’ button will be shown. If not empty, the first button must be a Pay button.

  • reply_parameters (telegram.ReplyParameters, optional) –

    Description of the message to reply to.

    Added in version 20.8.

  • message_effect_id (str, optional) –

    Unique identifier of the message effect to be added to the message; for private chats only.

    Added in version 21.3.

  • allow_paid_broadcast (bool, optional) –

    Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.

    Added in version 21.7.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_location(chat_id, latitude=None, longitude=None, disable_notification=None, reply_markup=None, live_period=None, horizontal_accuracy=None, heading=None, proximity_alert_radius=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, location=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to send point on the map.

Note

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

Shortcuts

Parameters:

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

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

  • live_period (int | datetime.timedelta, optional) –

    Period in seconds for which the location will be updated, should be between 60 and 86400, or 2147483647 for live locations that can be edited indefinitely.

    Changed in version 21.11: datetime.timedelta objects are accepted in addition to plain int values.

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

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • reply_parameters (telegram.ReplyParameters, optional) –

    Description of the message to reply to.

    Added in version 20.8.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent.

    Added in version 21.1.

  • message_effect_id (str, optional) –

    Unique identifier of the message effect to be added to the message; for private chats only.

    Added in version 21.3.

  • allow_paid_broadcast (bool, optional) –

    Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.

    Added in version 21.7.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_media_group(chat_id, media, disable_notification=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=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, caption=None, parse_mode=None, caption_entities=None)[source]

Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type.

Note

If you supply a caption (along with either parse_mode or caption_entities), then items in media must have no captions, and vice versa.

See also

Working with Files and Media

Shortcuts

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

Parameters:
Keyword Arguments:
Returns:

An array of the sent Messages.

Return type:

tuple[telegram.Message]

Raises:

telegram.error.TelegramError –

async send_message(chat_id, text, parse_mode=None, entities=None, disable_notification=None, protect_content=None, reply_markup=None, message_thread_id=None, link_preview_options=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_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 send text messages.

Shortcuts

Parameters:
Keyword Arguments:
Returns:

On success, the sent message is returned.

Return type:

telegram.Message

Raises:
async send_paid_media(chat_id, star_count, media, caption=None, parse_mode=None, caption_entities=None, show_caption_above_media=None, disable_notification=None, protect_content=None, reply_parameters=None, reply_markup=None, business_connection_id=None, payload=None, allow_paid_broadcast=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 send paid media.

Shortcuts

Added in version 21.4.

Parameters:
Keyword Arguments:
Returns:

On success, the sent message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_photo(chat_id, photo, caption=None, disable_notification=None, reply_markup=None, parse_mode=None, caption_entities=None, protect_content=None, message_thread_id=None, has_spoiler=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, show_caption_above_media=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to send photos.

See also

Working with Files and Media

Shortcuts

Parameters:

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

  • photo (str | file object | InputFile | bytes | pathlib.Path | telegram.PhotoSize) –

    Photo 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting. Lastly you can pass an existing telegram.PhotoSize object to send.

    Caution

    • The photo must be at most 10MB in size.

    • The photo’s width and height must not exceed 10000 in total.

    • Width and height ratio must be at most 20.

    Changed in version 13.2: Accept bytes as input.

    Changed in version 20.0: File paths as input is also accepted for bots not running in local_mode.

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

  • parse_mode (str, optional) – Mode for parsing entities. See telegram.constants.ParseMode and formatting options for more details.

  • caption_entities (Sequence[telegram.MessageEntity], optional) –

    Sequence of special entities that appear in the caption, which can be specified instead of parse_mode.

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

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

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • has_spoiler (bool, optional) –

    Pass True if the photo needs to be covered with a spoiler animation.

    Added in version 20.0.

  • reply_parameters (telegram.ReplyParameters, optional) –

    Description of the message to reply to.

    Added in version 20.8.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent.

    Added in version 21.1.

  • message_effect_id (str, optional) –

    Unique identifier of the message effect to be added to the message; for private chats only.

    Added in version 21.3.

  • allow_paid_broadcast (bool, optional) –

    Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.

    Added in version 21.7.

  • show_caption_above_media (bool, optional) –

    Pass True, if the caption must be shown above the message media.

    Added in version 21.3.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_poll(chat_id, question, options, is_anonymous=None, type=None, allows_multiple_answers=None, correct_option_id=None, is_closed=None, disable_notification=None, reply_markup=None, explanation=None, explanation_parse_mode=None, open_period=None, close_date=None, explanation_entities=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, question_parse_mode=None, question_entities=None, message_effect_id=None, allow_paid_broadcast=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 send a native poll.

Shortcuts

Parameters:
Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_sticker(chat_id, sticker, disable_notification=None, reply_markup=None, protect_content=None, message_thread_id=None, emoji=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=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 send static .WEBP, animated .TGS, or video .WEBM stickers.

See also

Working with Files and Media

Shortcuts

Parameters:

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

  • sticker (str | file object | InputFile | 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 file from the Internet, or upload a new one. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting. Video stickers can only be sent by a file_id. Video and animated stickers can’t be sent via an HTTP URL.

    Lastly you can pass an existing telegram.Sticker object to send.

    Changed in version 13.2: Accept bytes as input.

    Changed in version 20.0: File paths as input is also accepted for bots not running in local_mode.

  • emoji (str, optional) –

    Emoji associated with the sticker; only for just uploaded stickers

    Added in version 20.2.

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

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • reply_parameters (telegram.ReplyParameters, optional) –

    Description of the message to reply to.

    Added in version 20.8.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent.

    Added in version 21.1.

  • message_effect_id (str, optional) –

    Unique identifier of the message effect to be added to the message; for private chats only.

    Added in version 21.3.

  • allow_paid_broadcast (bool, optional) –

    Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.

    Added in version 21.7.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_venue(chat_id, latitude=None, longitude=None, title=None, address=None, foursquare_id=None, disable_notification=None, reply_markup=None, foursquare_type=None, google_place_id=None, google_place_type=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, venue=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to send information about a venue.

Note

Shortcuts

Parameters:

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

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

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • reply_parameters (telegram.ReplyParameters, optional) –

    Description of the message to reply to.

    Added in version 20.8.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent.

    Added in version 21.1.

  • message_effect_id (str, optional) –

    Unique identifier of the message effect to be added to the message; for private chats only.

    Added in version 21.3.

  • allow_paid_broadcast (bool, optional) –

    Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.

    Added in version 21.7.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_video(chat_id, video, duration=None, caption=None, disable_notification=None, reply_markup=None, width=None, height=None, parse_mode=None, supports_streaming=None, caption_entities=None, protect_content=None, message_thread_id=None, has_spoiler=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, show_caption_above_media=None, cover=None, start_timestamp=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Note

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

See also

Working with Files and Media

Shortcuts

Changed in version 20.5: Removed deprecated argument thumb. Use thumbnail instead.

Parameters:

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

  • video (str | file object | InputFile | bytes | pathlib.Path | telegram.Video) –

    Video 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting. Lastly you can pass an existing telegram.Video object to send.

    Changed in version 13.2: Accept bytes as input.

    Changed in version 20.0: File paths as input is also accepted for bots not running in local_mode.

  • duration (int | datetime.timedelta, optional) –

    Duration of sent video in seconds.

    Changed in version 21.11: datetime.timedelta objects are accepted in addition to plain int values.

  • width (int, optional) – Video width.

  • height (int, optional) – Video height.

  • cover (file object | bytes | pathlib.Path | str, optional) –

    Cover for the video in the message. 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")) or the file contents as bytes. If the bot is running in local_mode, passing the path of the file (as string or pathlib.Path object) is supported as well.

    Added in version 21.11.

  • start_timestamp (int, optional) –

    Start timestamp for the video in the message.

    Added in version 21.11.

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

  • parse_mode (str, optional) – Mode for parsing entities. See telegram.constants.ParseMode and formatting options for more details.

  • caption_entities (Sequence[telegram.MessageEntity], optional) –

    Sequence of special entities that appear in the caption, which can be specified instead of parse_mode.

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

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

    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.

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • has_spoiler (bool, optional) –

    Pass True if the video needs to be covered with a spoiler animation.

    Added in version 20.0.

  • thumbnail (file object | bytes | pathlib.Path | str, 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting.

    Added in version 20.2.

  • reply_parameters (telegram.ReplyParameters, optional) –

    Description of the message to reply to.

    Added in version 20.8.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent.

    Added in version 21.1.

  • message_effect_id (str, optional) –

    Unique identifier of the message effect to be added to the message; for private chats only.

    Added in version 21.3.

  • allow_paid_broadcast (bool, optional) –

    Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.

    Added in version 21.7.

  • show_caption_above_media (bool, optional) –

    Pass True, if the caption must be shown above the message media.

    Added in version 21.3.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_video_note(chat_id, video_note, duration=None, length=None, disable_notification=None, reply_markup=None, protect_content=None, message_thread_id=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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.

Note

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

See also

Working with Files and Media

Shortcuts

Changed in version 20.5: Removed deprecated argument thumb. Use thumbnail instead.

Parameters:

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

  • video_note (str | file object | InputFile | 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting. Lastly 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.

    Changed in version 20.0: File paths as input is also accepted for bots not running in local_mode.

  • duration (int | datetime.timedelta, optional) –

    Duration of sent video in seconds.

    Changed in version 21.11: datetime.timedelta objects are accepted in addition to plain int values.

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

    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.

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • thumbnail (file object | bytes | pathlib.Path | str, 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting.

    Added in version 20.2.

  • reply_parameters (telegram.ReplyParameters, optional) –

    Description of the message to reply to.

    Added in version 20.8.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent.

    Added in version 21.1.

  • message_effect_id (str, optional) –

    Unique identifier of the message effect to be added to the message; for private chats only.

    Added in version 21.3.

  • allow_paid_broadcast (bool, optional) –

    Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.

    Added in version 21.7.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

async send_voice(chat_id, voice, duration=None, caption=None, disable_notification=None, reply_markup=None, parse_mode=None, caption_entities=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS , or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

Note

To use this method, the file must have the type audio/ogg and be no more than 1 MB in size. 1 MB- 20 MB voice notes will be sent as files.

See also

Working with Files and Media

Shortcuts

Parameters:

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

  • voice (str | file object | InputFile | bytes | pathlib.Path | telegram.Voice) –

    Voice 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting. Lastly you can pass an existing telegram.Voice object to send.

    Changed in version 13.2: Accept bytes as input.

    Changed in version 20.0: File paths as input is also accepted for bots not running in local_mode.

  • caption (str, optional) – Voice message caption, 0-1024 characters after entities parsing.

  • parse_mode (str, optional) – Mode for parsing entities. See telegram.constants.ParseMode and formatting options for more details.

  • caption_entities (Sequence[telegram.MessageEntity], optional) –

    Sequence of special entities that appear in the caption, which can be specified instead of parse_mode.

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

  • duration (int | datetime.timedelta, optional) –

    Duration of the voice message in seconds.

    Changed in version 21.11: datetime.timedelta objects are accepted in addition to plain int values.

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

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • reply_parameters (telegram.ReplyParameters, optional) –

    Description of the message to reply to.

    Added in version 20.8.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be sent.

    Added in version 21.1.

  • message_effect_id (str, optional) –

    Unique identifier of the message effect to be added to the message; for private chats only.

    Added in version 21.3.

  • allow_paid_broadcast (bool, optional) –

    Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.

    Added in version 21.7.

Keyword Arguments:
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError –

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

Alias for set_business_account_bio()

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

Alias for set_business_account_gift_settings()

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

Alias for set_business_account_name()

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

Alias for set_business_account_profile_photo()

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

Alias for set_business_account_username()

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

Alias for set_chat_administrator_custom_title()

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

Alias for set_chat_description()

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

Alias for set_chat_menu_button()

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

Alias for set_chat_permissions()

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

Alias for set_chat_photo()

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

Alias for set_chat_sticker_set()

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

Alias for set_chat_title()

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

Alias for set_custom_emoji_sticker_set_thumbnail()

async setGameScore(user_id, score, chat_id=None, message_id=None, inline_message_id=None, force=None, disable_edit_message=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for set_game_score()

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

Alias for set_message_reaction()

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

Alias for set_my_commands()

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

Alias for set_my_default_administrator_rights()

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

Alias for set_my_description()

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

Alias for set_my_name()

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

Alias for set_my_short_description()

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

Alias for set_passport_data_errors()

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

Alias for set_sticker_emoji_list()

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

Alias for set_sticker_keywords()

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

Alias for set_sticker_mask_position()

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

Alias for set_sticker_position_in_set()

async setStickerSetThumbnail(name, user_id, format, thumbnail=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for set_sticker_set_thumbnail()

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

Alias for set_sticker_set_title()

async setUserEmojiStatus(user_id, emoji_status_custom_emoji_id=None, emoji_status_expiration_date=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for set_user_emoji_status()

async setWebhook(url, certificate=None, max_connections=None, allowed_updates=None, ip_address=None, drop_pending_updates=None, secret_token=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for set_webhook()

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

Changes the bio of a managed business account. Requires the can_edit_bio business bot right.

Added in version 22.1.

Parameters:

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

  • bio (str, optional) – The new value of the bio for the business account; 0-140 characters.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right.

Added in version 22.1.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Changes the first and last name of a managed business account. Requires the can_edit_name business bot right.

Added in version 22.1.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right.

Added in version 22.1.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Changes the username of a managed business account. Requires the can_edit_username business bot right.

Added in version 22.1.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

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.

Shortcuts

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

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.

Shortcuts

Parameters:

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

  • description (str, optional) – New chat description, 0-255 characters.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Use this method to change the bot’s menu button in a private chat, or the default menu button.

See also

get_chat_menu_button(), telegram.Chat.get_menu_button() telegram.User.get_menu_button()

Shortcuts

Added in version 20.0.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

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

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.ChatMemberAdministrator.can_restrict_members admin rights.

Shortcuts

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

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.

Shortcuts

Parameters:

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

  • photo (file object | bytes | pathlib.Path) –

    New chat photo. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting.

    Changed in version 13.2: Accept bytes as input.

    Changed in version 20.0: File paths as input is also accepted for bots not running in local_mode.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

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

  • sticker_set_name (str) – Name of the sticker set to be set as the group sticker set.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

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

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.

Shortcuts

Parameters:

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

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Use this method to set the thumbnail of a custom emoji sticker set.

Added in version 20.2.

Parameters:

  • name (str) – Sticker set name.

  • custom_emoji_id (str, optional) – Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async set_game_score(user_id, score, chat_id=None, message_id=None, inline_message_id=None, force=None, disable_edit_message=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to set the score of the specified user in a game message.

See also

telegram.Game.text

Shortcuts

Parameters:
Keyword Arguments:
Returns:

The edited message. If the message is not an inline message , True.

Return type:

telegram.Message

Raises:

telegram.error.TelegramError – If the new score is not greater than the user’s current score in the chat and force is False.

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

Use this method to change the chosen reactions on a message. Service messages of some types can’t be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can’t use paid reactions.

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

  • message_id (int) – Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead.

  • reaction (Sequence[telegram.ReactionType | str] | telegram.ReactionType | str, optional) –

    A list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can’t be used by bots.

    Tip

    Passed str values will be converted to either telegram.ReactionTypeEmoji or telegram.ReactionTypeCustomEmoji depending on whether they are listed in ReactionEmoji.

  • is_big (bool, optional) – Pass True to set the reaction with a big animation.

Keyword Arguments:
Returns:

bool On success, True is returned.

Raises:

telegram.error.TelegramError –

async set_my_commands(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 change the list of the bot’s commands. See the Telegram docs for more details about bot commands.

See also

get_my_commands(), delete_my_commands()

Parameters:

  • commands (Sequence[BotCommand | (str, str)]) –

    A sequence of bot commands to be set as the list of the bot’s commands. At most 100 commands can be specified.

    Note

    If you pass in a sequence of tuple, the order of elements in each tuple must correspond to the order of positional arguments to create a BotCommand instance.

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

  • scope (telegram.BotCommandScope, optional) –

    An object, describing scope of users for which the commands are relevant. Defaults to telegram.BotCommandScopeDefault.

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

    Added in version 13.7.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

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 free to modify the list before adding the bot.

See also

get_my_default_administrator_rights()

Added in version 20.0.

Parameters:
Keyword Arguments:
Returns:

Returns True on success.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Use this method to change the bot’s description, which is shown in the chat with the bot if the chat is empty.

Added in version 20.2.

Parameters:

  • description (str, optional) – New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.

  • language_code (str, optional) – A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Use this method to change the bot’s name.

Added in version 20.3.

Parameters:

  • name (str, optional) –

    New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language.

    Caution

    If language_code is not specified, a name must be specified.

  • language_code (str, optional) – A two-letter ISO 639-1 language code. If empty, the name will be applied to all users for whose language there is no dedicated name.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Use this method to change the bot’s short description, which is shown on the bot’s profile page and is sent together with the link when users share the bot.

Added in version 20.2.

Parameters:

  • short_description (str, optional) – New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated description for the given language.

  • language_code (str, optional) – A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

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.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot.

Added in version 20.2.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot.

Added in version 20.2.

Parameters:

  • sticker (str | Sticker) –

    File identifier of the sticker or the sticker object.

    Changed in version 21.10: Accepts also telegram.Sticker instances.

  • keywords (Sequence[str]) – A sequence of 0-20 search keywords for the sticker with total length up to 64 characters.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot.

Added in version 20.2.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Use this method to move a sticker in a set created by the bot to a specific position.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async set_sticker_set_thumbnail(name, user_id, format, thumbnail=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set.

Added in version 20.2.

Changed in version 21.1: As per Bot API 7.2, the new argument format will be required, and thus the order of the arguments had to be changed.

Parameters:

  • name (str) – Sticker set name

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

  • format (str) –

    Format of the added sticker, must be one of 'static' for a .WEBP or .PNG image, 'animated' for a .TGS animation, 'video' for a .WEBM video.

    Added in version 21.1.

  • thumbnail (str | file object | InputFile | bytes | pathlib.Path, optional) –

    A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height of exactly 100 px, or a .TGS animation with the thumbnail up to 32 kilobytes in size; see the docs for animated sticker technical requirements, or a .WEBM video with the thumbnail up to 32 kilobytes in size; see this for video sticker technical requirements.

    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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")), the file contents as bytes or the path of the file (as string or pathlib.Path object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on the local_mode setting.

    Animated and video sticker set thumbnails can’t be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Use this method to set the title of a created sticker set.

Added in version 20.2.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async set_user_emoji_status(user_id, emoji_status_custom_emoji_id=None, emoji_status_expiration_date=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess .

Added in version 21.8.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async set_webhook(url, certificate=None, max_connections=None, allowed_updates=None, ip_address=None, drop_pending_updates=None, secret_token=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

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 An Update. In case of an unsuccessful request (a request with response HTTP status code <https://en.wikipedia.org/wiki/List_of_HTTP_status_codes>`_different from ``2XY`), Telegram will repeat the request and 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.

Note

  1. You will not be able to receive updates using get_updates() for long as an outgoing webhook is set up.

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

  3. Ports currently supported for Webhooks: telegram.constants.SUPPORTED_WEBHOOK_PORTS.

If you’re having any trouble setting up webhooks, please check out this guide to Webhooks.

See also

telegram.ext.Application.run_webhook(), telegram.ext.Updater.start_webhook()

Examples

Custom Webhook Bot

Parameters:

  • url (str) – HTTPS url to send updates to. Use an empty string to remove webhook integration.

  • certificate (file object | bytes | pathlib.Path | str) – Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. To upload a file, you can either pass a file object (e.g. open("filename", "rb")) or the file contents as bytes. If the bot is running in local_mode, passing the path of the file (as string or pathlib.Path object) is supported as well.

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

    A sequence of 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 sequence to receive all updates except telegram.Update.chat_member, telegram.Update.message_reaction and telegram.Update.message_reaction_count (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 update may be received for a short period of time.

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

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

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

    Added in version 20.0.

Keyword Arguments:
Returns:

bool On success, True is returned.

Raises:

telegram.error.TelegramError –

async shutdown()[source]

Stop & clear resources used by this class. Currently just calls telegram.request.BaseRequest.shutdown() for the request objects used by this bot.

See also

initialize()

Added in version 20.0.

async stopMessageLiveLocation(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 stop_message_live_location()

async stopPoll(chat_id, message_id, 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 stop_poll()

async stop_message_live_location(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 stop updating a live location message sent by the bot or via the bot (for inline bots) before live_period expires.

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

async stop_poll(chat_id, message_id, 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 stop a poll which was sent by the bot.

Shortcuts

telegram.Message.stop_poll()

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 original message with the poll.

  • reply_markup (telegram.InlineKeyboardMarkup, optional) – An object for a new message 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, the stopped Poll is returned.

Return type:

telegram.Poll

Raises:

telegram.error.TelegramError –

property supports_inline_queries[source]

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

Type:

bool

to_dict(recursive=True)[source]

See telegram.TelegramObject.to_dict().

property token[source]

Bot’s unique authentication token.

Added in version 20.0.

Type:

str

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

Alias for transfer_business_account_stars()

async transferGift(business_connection_id, owned_gift_id, new_owner_chat_id, star_count=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for transfer_gift()

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

Transfers Telegram Stars from the business account balance to the bot’s balance. Requires the can_transfer_stars business bot right.

Added in version 22.1.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async transfer_gift(business_connection_id, owned_gift_id, new_owner_chat_id, star_count=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid.

Shortcuts

Added in version 22.1.

Parameters:

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

  • owned_gift_id (str) – Unique identifier of the regular gift that should be transferred.

  • new_owner_chat_id (int) – Unique identifier of the chat which will own the gift. The chat must be active in the last 86400 seconds.

  • star_count (int, optional) – The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Alias for unban_chat_member()

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

Alias for unban_chat_sender_chat()

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

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.

Shortcuts

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.

  • only_if_banned (bool, optional) – Do nothing if the user is not banned.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Shortcuts

Added in version 13.9.

Parameters:

  • chat_id (int | str) – Unique identifier for the target chat or username of the target 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 –

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

Alias for unhide_general_forum_topic()

async unhide_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 unhide the ‘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.

Shortcuts

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 unpinAllChatMessages(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for unpin_all_chat_messages()

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

Alias for unpin_all_forum_topic_messages()

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

Alias for unpin_all_general_forum_topic_messages()

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

Alias for unpin_chat_message()

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

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 can_pin_messages admin right in a supergroup or can_edit_messages admin right in a channel.

Shortcuts

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

Shortcuts

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 unpin_all_general_forum_topic_messages(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have can_pin_messages administrator rights in the supergroup.

Shortcuts

Added in version 20.5.

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 unpin_chat_message(chat_id, message_id=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 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 can_pin_messages admin right in a supergroup or can_edit_messages admin right in a channel.

Shortcuts

Parameters:

  • 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 the message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be unpinned.

  • business_connection_id (str, optional) –

    Unique identifier of the business connection on behalf of which the message will be unpinned.

    Added in version 21.5.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

async upgradeGift(business_connection_id, owned_gift_id, keep_original_details=None, star_count=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Alias for upgrade_gift()

async upgrade_gift(business_connection_id, owned_gift_id, keep_original_details=None, star_count=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid.

Added in version 22.1.

Parameters:
Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Alias for upload_sticker_file()

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

Use this method to upload a file with a sticker for later use in the create_new_sticker_set() and add_sticker_to_set() methods (can be used multiple times).

Changed in version 20.5: Removed deprecated parameter png_sticker.

Parameters:
Keyword Arguments:
Returns:

On success, the uploaded File is returned.

Return type:

telegram.File

Raises:

telegram.error.TelegramError –

property username[source]

Bot’s username. Shortcut for the corresponding attribute of bot.

Type:

str

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

Alias for verify_chat()

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

Alias for verify_user()

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

Verifies a chat on behalf of the organization which is represented by the bot.

Shortcuts

Added in version 21.10.

Parameters:

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

  • custom_description (str, optional) – Custom description for the verification; 0- 70 characters. Must be empty if the organization isn’t allowed to provide a custom verification description.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –

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

Verifies a user on behalf of the organization which is represented by the bot.

Shortcuts

telegram.User.verify()

Added in version 21.10.

Parameters:

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

  • custom_description (str, optional) – Custom description for the verification; 0- 70 characters. Must be empty if the organization isn’t allowed to provide a custom verification description.

Keyword Arguments:
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.error.TelegramError –