telegram.Bot#

class telegram.Bot(*args, **kwargs)[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 request_object.shutdown()

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. However, this is not guaranteed to work, i.e. it will fail for passing files.

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

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

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.

Parameters

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

Sending Messages

send_animation()

Used for sending animations

send_audio()

Used for sending audio files

send_chat_action()

Used for sending chat actions

send_contact()

Used for sending contacts

send_dice()

Used for sending dice messages

send_document()

Used for sending documents

send_game()

Used for sending a game

send_invoice()

Used for sending an invoice

send_location()

Used for sending location

send_media_group()

Used for sending media grouped together

send_message()

Used for sending text messages

send_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

forward_message()

Used for forwarding messages


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

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

delete_message()

Used for deleting messages.


Chat Moderation and information

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

approve_chat_join_request()

Used for approving a chat join request

decline_chat_join_request()

Used for declining a chat join request

set_chat_photo()

Used for setting a photo to a chat

delete_chat_photo()

Used for deleting a chat photo

set_chat_title()

Used for setting a chat title

set_chat_description()

Used for setting the description of a chat

pin_chat_message()

Used for pinning a message

unpin_chat_message()

Used for unpinning a message

unpin_all_chat_messages()

Used for unpinning all pinned chat messages

get_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

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

leave_chat()

Used for leaving a chat


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

set_chat_sticker_set()

Used for setting a sticker set

delete_chat_sticker_set()

Used for deleting the set sticker set

set_sticker_position_in_set()

Used for moving a sticker’s position in the set

set_sticker_set_thumb()

Used for setting the thumbnail of a sticker set

get_sticker_set()

Used for getting a sticker set

upload_sticker_file()

Used for uploading a sticker file


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


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

Used for getting basic information about the bot


Properties

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

username

The username of the bot, without leading @

link

The t.me link of the bot

supports_inline_queries

Whether the bot supports inline queries



async addStickerToSet(user_id, name, emojis, png_sticker=None, mask_position=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, tgs_sticker=None, api_kwargs=None, webm_sticker=None)[source]#

Alias for add_sticker_to_set()

async add_sticker_to_set(user_id, name, emojis, png_sticker=None, mask_position=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, tgs_sticker=None, api_kwargs=None, webm_sticker=None)[source]#

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

Warning

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

Note

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

Parameters
Returns

On success, True is returned.

Return type

bool

Raises

telegram.error.TelegramError

async answerCallbackQuery(callback_query_id, text=None, show_alert=False, 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=300, is_personal=None, next_offset=None, switch_pm_text=None, switch_pm_parameter=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, current_offset=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=False, 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.

Parameters
Returns

bool On success, True is returned.

Raises

telegram.error.TelegramError

async answer_inline_query(inline_query_id, results, cache_time=300, is_personal=None, next_offset=None, switch_pm_text=None, switch_pm_parameter=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, current_offset=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.

Parameters

Example

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

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.

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

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

New in version 20.0.

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

New in version 13.8.

Parameters
Returns

On success, True is returned.

Return type

bool

Raises

telegram.error.TelegramError

async banChatMember(chat_id, user_id, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, until_date=None, api_kwargs=None, revoke_messages=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, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, until_date=None, api_kwargs=None, revoke_messages=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.

New in version 13.7.

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

New in version 13.9.

Parameters
Returns

On success, True is returned.

Return type

bool

Raises

telegram.error.TelegramError

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

Parameters
Returns

On success

Return type

True

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_to_message_id=None, allow_sending_without_reply=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, protect_content=None)[source]#

Alias for copy_message()

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

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

Parameters
Returns

On success

Return type

telegram.MessageId

Raises

telegram.error.TelegramError

Alias for create_chat_invite_link()

async createNewStickerSet(user_id, name, title, emojis, png_sticker=None, contains_masks=None, mask_position=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, tgs_sticker=None, api_kwargs=None, webm_sticker=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().

New in version 13.4.

Parameters
Returns

telegram.ChatInviteLink

Raises

telegram.error.TelegramError

async create_new_sticker_set(user_id, name, title, emojis, png_sticker=None, contains_masks=None, mask_position=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, tgs_sticker=None, api_kwargs=None, webm_sticker=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. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker.

Warning

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

Note

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

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

New in version 13.8.

Parameters
Returns

On success, True is returned.

Return type

bool

Raises

telegram.error.TelegramError

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

Alias for delete_chat_photo()

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

Alias for delete_chat_sticker_set()

async 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 deleteMyCommands(scope=None, language_code=None, api_kwargs=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=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 deleteWebhook(read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, drop_pending_updates=None)[source]#

Alias for delete_webhook()

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

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

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

Parameters
Returns

On success, True is returned.

Return type

bool

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.

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

Parameters
Returns

On success, True is returned.

Return type

bool

Raises

telegram.error.TelegramError

async delete_my_commands(scope=None, language_code=None, api_kwargs=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=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.

New in version 13.7.

Parameters
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
Returns

On success, True is returned.

Return type

bool

Raises

telegram.error.TelegramError

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

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

Parameters
Returns

On success, True is returned.

Return type

bool

Raises

telegram.error.TelegramError

Alias for edit_chat_invite_link()

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

Alias for edit_message_caption()

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

Alias for edit_message_live_location()

async editMessageMedia(media, chat_id=None, message_id=None, inline_message_id=None, reply_markup=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, 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, disable_web_page_preview=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, entities=None)[source]#

Alias for edit_message_text()

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

Note

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

New in version 13.4.

Parameters
Returns

telegram.ChatInviteLink

Raises

telegram.error.TelegramError

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

Use this method to edit captions of messages.

Parameters
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, location=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, horizontal_accuracy=None, heading=None, proximity_alert_radius=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.

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

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

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

Parameters
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, disable_web_page_preview=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, entities=None)[source]#

Use this method to edit text and game messages.

Parameters
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

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.

Parameters

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.

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

Alias for forward_message()

async forward_message(chat_id, from_chat_id, message_id, disable_notification=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, protect_content=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.Chat.has_protected_content to check this.

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

Parameters
Returns

On success, the sent Message is returned.

Return type

telegram.Message

Raises

telegram.error.TelegramError

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

Alias for get_file()

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(read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, scope=None, language_code=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 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=100, timeout=0, read_timeout=2, write_timeout=None, connect_timeout=None, pool_timeout=None, allowed_updates=None, api_kwargs=None)[source]#

Alias for get_updates()

async getUserProfilePhotos(user_id, offset=None, limit=100, 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_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.).

Parameters
Returns

telegram.Chat

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.

Parameters
Returns

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

Return type

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

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

New in version 13.7.

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

New in version 20.0.

Parameters
Returns

On success, the current menu button is returned.

Return type

telegram.MenuButton

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 downloaded with telegram.File.download(). It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling get_file again.

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.

Parameters
Returns

telegram.File

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.

Parameters
Returns

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

Parameters
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(read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, scope=None, language_code=None)[source]#

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

Parameters
Returns

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

Return type

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

New in version 20.0.

Parameters
Returns

On success.

Return type

telegram.ChatAdministratorRights

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
Returns

telegram.StickerSet

Raises

telegram.error.TelegramError

async get_updates(offset=None, limit=100, timeout=0, read_timeout=2, write_timeout=None, connect_timeout=None, pool_timeout=None, allowed_updates=None, api_kwargs=None)[source]#

Use this method to receive incoming updates using long polling.

Parameters

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

Returns

List[telegram.Update]

Raises

telegram.error.TelegramError

async get_user_profile_photos(user_id, offset=None, limit=100, 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.

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

Parameters
Returns

telegram.WebhookInfo

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

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

Parameters
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

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

Alias for log_out()

async log_out(read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=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.

Parameters
Returns

On success

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, 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, 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 telegram.ChatMemberAdministrator.can_edit_messages admin right in a channel.

Parameters
Returns

On success, True is returned.

Return type

bool

Raises

telegram.error.TelegramError

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, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, is_anonymous=None, can_manage_chat=None, can_manage_video_chats=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, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, is_anonymous=None, can_manage_chat=None, can_manage_video_chats=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.

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

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

New in version 13.4.

Parameters
Returns

telegram.ChatInviteLink

Raises

telegram.error.TelegramError

async sendAnimation(chat_id, animation, duration=None, width=None, height=None, thumb=None, caption=None, parse_mode=None, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, api_kwargs=None, allow_sending_without_reply=None, caption_entities=None, filename=None, protect_content=None)[source]#

Alias for send_animation()

async sendAudio(chat_id, audio, duration=None, performer=None, title=None, caption=None, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, parse_mode=None, thumb=None, api_kwargs=None, allow_sending_without_reply=None, caption_entities=None, filename=None, protect_content=None)[source]#

Alias for send_audio()

async sendChatAction(chat_id, action, 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_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, contact=None, vcard=None, api_kwargs=None, allow_sending_without_reply=None, protect_content=None)[source]#

Alias for send_contact()

async sendDice(chat_id, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, emoji=None, api_kwargs=None, allow_sending_without_reply=None, protect_content=None)[source]#

Alias for send_dice()

async sendDocument(chat_id, document, filename=None, caption=None, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, parse_mode=None, thumb=None, api_kwargs=None, disable_content_type_detection=None, allow_sending_without_reply=None, caption_entities=None, protect_content=None)[source]#

Alias for send_document()

async sendGame(chat_id, game_short_name, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, allow_sending_without_reply=None, protect_content=None)[source]#

Alias for send_game()

async sendInvoice(chat_id, title, description, payload, provider_token, currency, prices, start_parameter=None, photo_url=None, photo_size=None, photo_width=None, photo_height=None, need_name=None, need_phone_number=None, need_email=None, need_shipping_address=None, is_flexible=None, disable_notification=None, reply_to_message_id=None, reply_markup=None, provider_data=None, send_phone_number_to_provider=None, send_email_to_provider=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, allow_sending_without_reply=None, max_tip_amount=None, suggested_tip_amounts=None, protect_content=None)[source]#

Alias for send_invoice()

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

Alias for send_location()

async sendMediaGroup(chat_id, media, disable_notification=None, reply_to_message_id=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, api_kwargs=None, allow_sending_without_reply=None, protect_content=None)[source]#

Alias for send_media_group()

async sendMessage(chat_id, text, parse_mode=None, disable_web_page_preview=None, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, allow_sending_without_reply=None, entities=None, protect_content=None)[source]#

Alias for send_message()

async sendPhoto(chat_id, photo, caption=None, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, parse_mode=None, api_kwargs=None, allow_sending_without_reply=None, caption_entities=None, filename=None, protect_content=None)[source]#

Alias for send_photo()

async sendPoll(chat_id, question, options, is_anonymous=True, type=PollType.REGULAR, allows_multiple_answers=False, correct_option_id=None, is_closed=None, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, explanation=None, explanation_parse_mode=None, open_period=None, close_date=None, api_kwargs=None, allow_sending_without_reply=None, explanation_entities=None, protect_content=None)[source]#

Alias for send_poll()

async sendSticker(chat_id, sticker, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, api_kwargs=None, allow_sending_without_reply=None, protect_content=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_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, venue=None, foursquare_type=None, api_kwargs=None, google_place_id=None, google_place_type=None, allow_sending_without_reply=None, protect_content=None)[source]#

Alias for send_venue()

async sendVideo(chat_id, video, duration=None, caption=None, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, width=None, height=None, parse_mode=None, supports_streaming=None, thumb=None, api_kwargs=None, allow_sending_without_reply=None, caption_entities=None, filename=None, protect_content=None)[source]#

Alias for send_video()

async sendVideoNote(chat_id, video_note, duration=None, length=None, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, thumb=None, api_kwargs=None, allow_sending_without_reply=None, filename=None, protect_content=None)[source]#

Alias for send_video_note()

async sendVoice(chat_id, voice, duration=None, caption=None, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, parse_mode=None, api_kwargs=None, allow_sending_without_reply=None, caption_entities=None, filename=None, protect_content=None)[source]#

Alias for send_voice()

async send_animation(chat_id, animation, duration=None, width=None, height=None, thumb=None, caption=None, parse_mode=None, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, api_kwargs=None, allow_sending_without_reply=None, caption_entities=None, filename=None, protect_content=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

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

Parameters
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_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, parse_mode=None, thumb=None, api_kwargs=None, allow_sending_without_reply=None, caption_entities=None, filename=None, protect_content=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.

Note

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

Parameters
Returns

On success, the sent Message is returned.

Return type

telegram.Message

Raises

telegram.error.TelegramError

async send_chat_action(chat_id, action, 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.

Parameters
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_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, contact=None, vcard=None, api_kwargs=None, allow_sending_without_reply=None, protect_content=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.

Parameters
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_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, emoji=None, api_kwargs=None, allow_sending_without_reply=None, protect_content=None)[source]#

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

Parameters
Returns

On success, the sent Message is returned.

Return type

telegram.Message

Raises

telegram.error.TelegramError

async send_document(chat_id, document, filename=None, caption=None, disable_notification=None, reply_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, parse_mode=None, thumb=None, api_kwargs=None, disable_content_type_detection=None, allow_sending_without_reply=None, caption_entities=None, protect_content=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.

Note

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

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

Parameters
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_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, allow_sending_without_reply=None, protect_content=None)[source]#

Use this method to send a game.

Parameters
Returns

On success, the sent Message is returned.

Return type

telegram.Message

Raises

telegram.error.TelegramError

async send_invoice(chat_id, title, description, payload, provider_token, currency, prices, start_parameter=None, photo_url=None, photo_size=None, photo_width=None, photo_height=None, need_name=None, need_phone_number=None, need_email=None, need_shipping_address=None, is_flexible=None, disable_notification=None, reply_to_message_id=None, reply_markup=None, provider_data=None, send_phone_number_to_provider=None, send_email_to_provider=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, allow_sending_without_reply=None, max_tip_amount=None, suggested_tip_amounts=None, protect_content=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.

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

Parameters
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_to_message_id=None, reply_markup=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, location=None, live_period=None, api_kwargs=None, horizontal_accuracy=None, heading=None, proximity_alert_radius=None, allow_sending_without_reply=None, protect_content=None)[source]#

Use this method to send point on the map.

Note

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

Parameters