telegram.Bot

class telegram.Bot(token, base_url=None, base_file_url=None, request=None, private_key=None, private_key_password=None)

Bases: telegram.base.TelegramObject

This object represents a Telegram Bot.

Parameters:
  • token (str) – Bot’s unique authentication.
  • base_url (str, optional) – Telegram Bot API service URL.
  • base_file_url (str, optional) – Telegram Bot API file URL.
  • request (telegram.utils.request.Request, optional) – Pre initialized telegram.utils.request.Request.
  • private_key (bytes, optional) – Private key for decryption of telegram passport data.
  • private_key_password (bytes, optional) – Password for above private key.
addStickerToSet(user_id, name, png_sticker, emojis, mask_position=None, timeout=20, **kwargs)

Alias for add_sticker_to_set

add_sticker_to_set(user_id, name, png_sticker, emojis, mask_position=None, timeout=20, **kwargs)

Use this method to add a new sticker to a set created by the bot.

Note

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

Parameters:
  • user_id (int) – User identifier of created sticker set owner.
  • name (str) – Sticker set name.
  • png_sticker (str | filelike object) – Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.
  • emojis (str) – One or more emoji corresponding to the sticker.
  • mask_position (telegram.MaskPosition, optional) – Position where the mask should beplaced on faces.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.TelegramError

answerCallbackQuery(callback_query_id, text=None, show_alert=False, url=None, cache_time=None, timeout=None, **kwargs)

Alias for answer_callback_query

answerInlineQuery(inline_query_id, results, cache_time=300, is_personal=None, next_offset=None, switch_pm_text=None, switch_pm_parameter=None, timeout=None, **kwargs)

Alias for answer_inline_query

answerPreCheckoutQuery(pre_checkout_query_id, ok, error_message=None, timeout=None, **kwargs)

Alias for answer_pre_checkout_query

answerShippingQuery(shipping_query_id, ok, shipping_options=None, error_message=None, timeout=None, **kwargs)

Alias for answer_shipping_query

answer_callback_query(callback_query_id, text=None, show_alert=False, url=None, cache_time=None, timeout=None, **kwargs)

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:
  • callback_query_id (str) – Unique identifier for the query to be answered.
  • text (str, optional) – Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters.
  • show_alert (bool, optional) – If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
  • url (str, optional) – URL that will be opened by the user’s client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game - note that this will only work if the query comes from a callback game button. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
  • cache_time (int, optional) – The maximum amount of time in seconds that the result of the callback query may be cached client-side. Defaults to 0.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

bool On success, True is returned.

Raises:

telegram.TelegramError

answer_inline_query(inline_query_id, results, cache_time=300, is_personal=None, next_offset=None, switch_pm_text=None, switch_pm_parameter=None, timeout=None, **kwargs)

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

Parameters:
  • inline_query_id (str) – Unique identifier for the answered query.
  • results (List[telegram.InlineQueryResult) – A list of results for the inline query.
  • cache_time (int, optional) – The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.
  • is_personal (bool, optional) – Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.
  • next_offset (str, optional) – Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don’t support pagination. Offset length can’t exceed 64 bytes.
  • switch_pm_text (str, optional) – If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter.
  • switch_pm_parameter (str, optional) – Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.
  • timeout (int | float, optional) – If this value is specified, use it as he read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.

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:bool On success, True is returned.
Raises:telegram.TelegramError
answer_pre_checkout_query(pre_checkout_query_id, ok, error_message=None, timeout=None, **kwargs)

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field 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:
  • pre_checkout_query_id (str) – Unique identifier for the query to be answered.
  • ok (bool) – Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.
  • error_message (str, optional) – Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. “Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!”). Telegram will display this message to the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.TelegramError

answer_shipping_query(shipping_query_id, ok, shipping_options=None, error_message=None, timeout=None, **kwargs)

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

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 (List[telegram.ShippingOption]) – Required if ok is True. A JSON-serialized array of available shipping options.
  • error_message (str, optional) – Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”). Telegram will display this message to the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

bool; On success, True is returned.

Raises:

telegram.TelegramError

createNewStickerSet(user_id, name, title, png_sticker, emojis, contains_masks=None, mask_position=None, timeout=20, **kwargs)

Alias for create_new_sticker_set

create_new_sticker_set(user_id, name, title, png_sticker, emojis, contains_masks=None, mask_position=None, timeout=20, **kwargs)

Use this method to create new sticker set owned by a user.

The bot will be able to edit the created sticker set.

Note

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

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.
  • png_sticker (str | filelike object) – Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.
  • emojis (str) – One or more emoji corresponding to the sticker.
  • contains_masks (bool, optional) – Pass True, if a set of mask stickers should be created.
  • mask_position (telegram.MaskPosition, optional) – Position where the mask should be placed on faces.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.TelegramError

deleteChatPhoto(chat_id, timeout=None, **kwargs)

Alias for delete_chat_photo

deleteChatStickerSet(chat_id, timeout=None, **kwargs)

Alias for delete_chat_sticker_set

deleteMessage(chat_id, message_id, timeout=None, **kwargs)

Alias for delete_message

deleteStickerFromSet(sticker, timeout=None, **kwargs)

Alias for delete_sticker_from_set

deleteWebhook(timeout=None, **kwargs)

Alias for delete_webhook

delete_chat_photo(chat_id, timeout=None, **kwargs)

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

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments

Note

In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group.

Returns:Returns True on success.
Return type:bool
Raises:telegram.TelegramError
delete_chat_sticker_set(chat_id, timeout=None, **kwargs)

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:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

True on success.

Return type:

bool

delete_message(chat_id, message_id, timeout=None, **kwargs)

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.
  • 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:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • message_id (int) – Identifier of the message to delete.
  • timeout (int | float, optional) – If this value is specified, use it as
  • read timeout (the) – from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.TelegramError

delete_sticker_from_set(sticker, timeout=None, **kwargs)

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

Parameters:
  • sticker (str) – File identifier of the sticker.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.TelegramError

delete_webhook(timeout=None, **kwargs)

Use this method to remove webhook integration if you decide to switch back to getUpdates. Requires no parameters.

Parameters:
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

bool On success, True is returned.

Raises:

telegram.TelegramError

editMessageCaption(chat_id=None, message_id=None, inline_message_id=None, caption=None, reply_markup=None, timeout=None, parse_mode=None, **kwargs)

Alias for edit_message_caption

editMessageLiveLocation(chat_id=None, message_id=None, inline_message_id=None, latitude=None, longitude=None, location=None, reply_markup=None, timeout=None, **kwargs)

Alias for edit_message_live_location

editMessageMedia(chat_id=None, message_id=None, inline_message_id=None, media=None, reply_markup=None, timeout=None, **kwargs)

Alias for edit_message_media

editMessageReplyMarkup(chat_id=None, message_id=None, inline_message_id=None, reply_markup=None, timeout=None, **kwargs)

Alias for edit_message_reply_markup

editMessageText(text, chat_id=None, message_id=None, inline_message_id=None, parse_mode=None, disable_web_page_preview=None, reply_markup=None, timeout=None, **kwargs)

Alias for edit_message_text

edit_message_caption(chat_id=None, message_id=None, inline_message_id=None, caption=None, reply_markup=None, timeout=None, parse_mode=None, **kwargs)

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

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) – Required if inline_message_id is not specified. Identifier of the sent message.
  • inline_message_id (str, optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.
  • caption (str, optional) – New caption of the message.
  • parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the constants in telegram.ParseMode for the available modes.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

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

Return type:

telegram.Message

Raises:

telegram.TelegramError

edit_message_live_location(chat_id=None, message_id=None, inline_message_id=None, latitude=None, longitude=None, location=None, reply_markup=None, timeout=None, **kwargs)

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 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:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • message_id (int, optional) – Required if inline_message_id is not specified. Identifier of the sent message.
  • inline_message_id (str, optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.
  • latitude (float, optional) – Latitude of location.
  • longitude (float, optional) – Longitude of location.
  • location (telegram.Location, optional) – The location to send.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
Returns:

On success the edited message.

Return type:

telegram.Message

edit_message_media(chat_id=None, message_id=None, inline_message_id=None, media=None, reply_markup=None, timeout=None, **kwargs)

Use this method to edit audio, document, photo, or video messages. If a message is a part of a message album, then it can be edited only to a photo or a video. Otherwise, message type can be changed arbitrarily. When inline message is edited, new file can’t be uploaded. Use previously uploaded file via its file_id or specify a URL. On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned.

Parameters:
  • chat_id (int | str, optional) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • message_id (int, optional) – Required if inline_message_id is not specified. Identifier of the sent message.
  • inline_message_id (str, optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.
  • media (telegram.InputMedia) – An object for a new media content of the message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
edit_message_reply_markup(chat_id=None, message_id=None, inline_message_id=None, reply_markup=None, timeout=None, **kwargs)

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

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) – Required if inline_message_id is not specified. Identifier of the sent message.
  • inline_message_id (str, optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

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

Return type:

telegram.Message

Raises:

telegram.TelegramError

edit_message_text(text, chat_id=None, message_id=None, inline_message_id=None, parse_mode=None, disable_web_page_preview=None, reply_markup=None, timeout=None, **kwargs)

Use this method to edit text and game messages sent by the bot or via the bot (for inline bots).

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) – Required if inline_message_id is not specified. Identifier of the sent message.
  • inline_message_id (str, optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.
  • text (str) – New text of the message.
  • parse_mode (str) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot’s message. See the constants in telegram.ParseMode for the available modes.
  • disable_web_page_preview (bool, optional) – Disables link previews for links in this message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

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

Return type:

telegram.Message

Raises:

telegram.TelegramError

Alias for export_chat_invite_link

Use this method to export an invite link to 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.

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments
Returns:

Exported invite link on success.

Return type:

str

Raises:

telegram.TelegramError

first_name

Bot’s first name.

Type:str
forwardMessage(chat_id, from_chat_id, message_id, disable_notification=False, timeout=None, **kwargs)

Alias for forward_message

forward_message(chat_id, from_chat_id, message_id, disable_notification=False, timeout=None, **kwargs)

Use this method to forward messages of any kind.

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).
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • message_id (int) – Message identifier in the chat specified in from_chat_id.
  • timeout (int | float, optional) – If this value is specified, use it as
  • read timeout (the) – from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

getChat(chat_id, timeout=None, **kwargs)

Alias for get_chat

getChatAdministrators(chat_id, timeout=None, **kwargs)

Alias for get_chat_administrators

getChatMember(chat_id, user_id, timeout=None, **kwargs)

Alias for get_chat_member

getChatMembersCount(chat_id, timeout=None, **kwargs)

Alias for get_chat_members_count

getFile(file_id, timeout=None, **kwargs)

Alias for get_file

getGameHighScores(user_id, chat_id=None, message_id=None, inline_message_id=None, timeout=None, **kwargs)

Alias for get_game_high_scores

getMe(timeout=None, **kwargs)

Alias for get_me

getStickerSet(name, timeout=None, **kwargs)

Alias for get_sticker_set

getUpdates(offset=None, limit=100, timeout=0, read_latency=2.0, allowed_updates=None, **kwargs)

Alias for get_updates

getUserProfilePhotos(user_id, offset=None, limit=100, timeout=None, **kwargs)

Alias for get_user_profile_photos

getWebhookInfo(timeout=None, **kwargs)

Alias for get_webhook_info

get_chat(chat_id, timeout=None, **kwargs)

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:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

telegram.Chat

Raises:

telegram.TelegramError

get_chat_administrators(chat_id, timeout=None, **kwargs)

Use this method to get a list of administrators in a chat. On success, returns an Array 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.

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

List[telegram.ChatMember]

Raises:

telegram.TelegramError

get_chat_member(chat_id, user_id, timeout=None, **kwargs)

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

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • user_id (int) – Unique identifier of the target user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

telegram.ChatMember

Raises:

telegram.TelegramError

get_chat_members_count(chat_id, timeout=None, **kwargs)

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

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

Number of members in the chat.

Return type:

int

Raises:

telegram.TelegramError

get_file(file_id, timeout=None, **kwargs)

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

Parameters:
Returns:

telegram.File

Raises:

telegram.TelegramError

get_game_high_scores(user_id, chat_id=None, message_id=None, inline_message_id=None, timeout=None, **kwargs)

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

Parameters:
  • user_id (int) – User identifier.
  • chat_id (int | str, optional) – Required if inline_message_id is not specified. Unique identifier for the target chat.
  • message_id (int, optional) – Required if inline_message_id is not specified. Identifier of the sent message.
  • inline_message_id (str, optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

List[telegram.GameHighScore]

Raises:

telegram.TelegramError

get_me(timeout=None, **kwargs)

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

Parameters:timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
Returns:A telegram.User instance representing that bot if the credentials are valid, None otherwise.
Return type:telegram.User
Raises:telegram.TelegramError
get_sticker_set(name, timeout=None, **kwargs)

Use this method to get a sticker set.

Parameters:
  • name (str) – Short name of the sticker set that is used in t.me/addstickers/ URLs (e.g., animals)
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

telegram.StickerSet

Raises:

telegram.TelegramError

get_updates(offset=None, limit=100, timeout=0, read_latency=2.0, allowed_updates=None, **kwargs)

Use this method to receive incoming updates using long polling.

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 getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.
  • limit (int, optional) – Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.
  • timeout (int, optional) – Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.
  • allowed_updates (List[str]), optional) – List the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See telegram.Update for a complete list of available update types. Specify an empty list to receive all updates regardless of type (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.
  • **kwargs (dict) – Arbitrary keyword arguments.

Notes

  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.TelegramError
get_user_profile_photos(user_id, offset=None, limit=100, timeout=None, **kwargs)

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

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.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

telegram.UserProfilePhotos

Raises:

telegram.TelegramError

get_webhook_info(timeout=None, **kwargs)

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

If the bot is using getUpdates, will return an object with the url field empty.

Parameters:
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

telegram.WebhookInfo

id

Unique identifier for this bot.

Type:int
kickChatMember(chat_id, user_id, timeout=None, until_date=None, **kwargs)

Alias for kick_chat_member

kick_chat_member(chat_id, user_id, timeout=None, until_date=None, **kwargs)

Use this method to kick a user from a group or a supergroup. In the case of supergroups, 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 group for this to work.

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.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • until_date (int | datetime.datetime, optional) – Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever.
  • **kwargs (dict) – Arbitrary keyword arguments.

Note

In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group. Otherwise members may only be removed by the group’s creator or by the member that added them.

Returns:bool On success, True is returned.
Raises:telegram.TelegramError
last_name

Optional. Bot’s last name.

Type:str
leaveChat(chat_id, timeout=None, **kwargs)

Alias for leave_chat

leave_chat(chat_id, timeout=None, **kwargs)

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

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

bool On success, True is returned.

Raises:

telegram.TelegramError

name

Bot’s @username.

Type:str
pinChatMessage(chat_id, message_id, disable_notification=None, timeout=None, **kwargs)

Alias for pin_chat_message

pin_chat_message(chat_id, message_id, disable_notification=None, timeout=None, **kwargs)

Use this method to pin a message in a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • 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 group members about the new pinned message.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments
Returns:

Returns True on success.

Return type:

bool

Raises:

telegram.TelegramError

promoteChatMember(chat_id, user_id, can_change_info=None, can_post_messages=None, can_edit_messages=None, can_delete_messages=None, can_invite_users=None, can_restrict_members=None, can_pin_messages=None, can_promote_members=None, timeout=None, **kwargs)

Alias for promote_chat_member

promote_chat_member(chat_id, user_id, can_change_info=None, can_post_messages=None, can_edit_messages=None, can_delete_messages=None, can_invite_users=None, can_restrict_members=None, can_pin_messages=None, can_promote_members=None, timeout=None, **kwargs)

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

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 user.
  • can_change_info (bool, optional) – Pass True, if the administrator can change chat title, photo and other settings.
  • can_post_messages (bool, optional) – Pass True, if the administrator can create channel posts, channels only.
  • can_edit_messages (bool, optional) – Pass True, if the administrator can edit messages of other users, channels only.
  • can_delete_messages (bool, optional) – Pass True, if the administrator can delete messages of other users.
  • can_invite_users (bool, optional) – Pass True, if the administrator can invite new users to the chat.
  • can_restrict_members (bool, optional) – Pass True, if the administrator can restrict, ban or unban chat members.
  • can_pin_messages (bool, optional) – Pass True, if the administrator can pin messages, supergroups only.
  • can_promote_members (bool, optional) – Pass True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him).
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments
Returns:

Returns True on success.

Return type:

bool

Raises:

telegram.TelegramError

restrictChatMember(chat_id, user_id, permissions, until_date=None, timeout=None, **kwargs)

Alias for restrict_chat_member

restrict_chat_member(chat_id, user_id, permissions, until_date=None, timeout=None, **kwargs)

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.

Note

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

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 user.
  • until_date (int | datetime.datetime, optional) – Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever.
  • permissions (telegram.ChatPermissions) – New user permissions.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments
Returns:

Returns True on success.

Return type:

bool

Raises:

telegram.TelegramError

sendAnimation(chat_id, animation, duration=None, width=None, height=None, thumb=None, caption=None, parse_mode=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, **kwargs)

Alias for send_animation

sendAudio(chat_id, audio, duration=None, performer=None, title=None, caption=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, parse_mode=None, thumb=None, **kwargs)

Alias for send_audio

sendChatAction(chat_id, action, timeout=None, **kwargs)

Alias for send_chat_action

sendContact(chat_id, phone_number=None, first_name=None, last_name=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=None, contact=None, vcard=None, **kwargs)

Alias for send_contact

sendDocument(chat_id, document, filename=None, caption=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, parse_mode=None, thumb=None, **kwargs)

Alias for send_document

sendGame(chat_id, game_short_name, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=None, **kwargs)

Alias for send_game

sendInvoice(chat_id, title, description, payload, provider_token, start_parameter, currency, prices, 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=False, reply_to_message_id=None, reply_markup=None, provider_data=None, send_phone_number_to_provider=None, send_email_to_provider=None, timeout=None, **kwargs)

Alias for send_invoice

sendLocation(chat_id, latitude=None, longitude=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=None, location=None, live_period=None, **kwargs)

Alias for send_location

sendMediaGroup(chat_id, media, disable_notification=None, reply_to_message_id=None, timeout=20, **kwargs)

Alias for send_media_group

sendMessage(chat_id, text, parse_mode=None, disable_web_page_preview=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=None, **kwargs)

Alias for send_message

sendPhoto(chat_id, photo, caption=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, parse_mode=None, **kwargs)

Alias for send_photo

sendPoll(chat_id, question, options, disable_notification=None, reply_to_message_id=None, reply_markup=None, timeout=None, **kwargs)

Alias for send_poll

sendSticker(chat_id, sticker, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, **kwargs)

Alias for send_sticker

sendVenue(chat_id, latitude=None, longitude=None, title=None, address=None, foursquare_id=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=None, venue=None, foursquare_type=None, **kwargs)

Alias for send_venue

sendVideo(chat_id, video, duration=None, caption=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, width=None, height=None, parse_mode=None, supports_streaming=None, thumb=None, **kwargs)

Alias for send_video

sendVideoNote(chat_id, video_note, duration=None, length=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, thumb=None, **kwargs)

Alias for send_video_note

sendVoice(chat_id, voice, duration=None, caption=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, parse_mode=None, **kwargs)

Alias for send_voice

send_animation(chat_id, animation, duration=None, width=None, height=None, thumb=None, caption=None, parse_mode=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, **kwargs)

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound).

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • animation (str | filelike object | telegram.Animation) – Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. Lastly you can pass an existing telegram.Animation object to send.
  • duration (int, optional) – Duration of sent animation in seconds.
  • width (int, optional) – Animation width.
  • height (int, optional) – Animation height.
  • thumb (filelike object, optional) – Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 90. Ignored if the file is not is passed as a string or file_id.
  • caption (str, optional) – Animation caption (may also be used when resending animations by file_id), 0-1024 characters.
  • parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the constants in telegram.ParseMode for the available modes.
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – Send file timeout (default: 20 seconds).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_audio(chat_id, audio, duration=None, performer=None, title=None, caption=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, parse_mode=None, thumb=None, **kwargs)

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 format. On success, the sent Message is returned. 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 sendVoice method instead.

Note

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

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • audio (str | filelike object | telegram.Audio) – Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. Lastly you can pass an existing telegram.Audio object to send.
  • caption (str, optional) – Audio caption, 0-1024 characters.
  • parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the constants in telegram.ParseMode for the available modes.
  • duration (int, optional) – Duration of sent audio in seconds.
  • performer (str, optional) – Performer.
  • title (str, optional) – Track name.
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • thumb (filelike object, optional) – Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 90. Ignored if the file is not is passed as a string or file_id.
  • timeout (int | float, optional) – Send file timeout (default: 20 seconds).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_chat_action(chat_id, action, timeout=None, **kwargs)

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

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • action (telegram.ChatAction | str) – Type of action to broadcast. Choose one, depending on what the user is about to receive. For convenience look at the constants in telegram.ChatAction
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

True on success.

Return type:

bool

Raises:

telegram.TelegramError

send_contact(chat_id, phone_number=None, first_name=None, last_name=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=None, contact=None, vcard=None, **kwargs)

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:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • phone_number (str, optional) – Contact’s phone number.
  • first_name (str, optional) – Contact’s first name.
  • last_name (str, optional) – Contact’s last name.
  • vcard (str, optional) – Additional data about the contact in the form of a vCard, 0-2048 bytes.
  • contact (telegram.Contact, optional) – The contact to send.
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_document(chat_id, document, filename=None, caption=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, parse_mode=None, thumb=None, **kwargs)

Use this method to send general files.

Note

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

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • document (str | filelike object | telegram.Document) – File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. Lastly you can pass an existing telegram.Document object to send.
  • filename (str, optional) – File name that shows in telegram message (it is useful when you send file generated by temp module, for example). Undocumented.
  • caption (str, optional) – Document caption (may also be used when resending documents by file_id), 0-1024 characters.
  • parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the constants in telegram.ParseMode for the available modes.
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • thumb (filelike object, optional) – Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 90. Ignored if the file is not is passed as a string or file_id.
  • timeout (int | float, optional) – Send file timeout (default: 20 seconds).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_game(chat_id, game_short_name, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=None, **kwargs)

Use this method to send a game.

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • 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.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_invoice(chat_id, title, description, payload, provider_token, start_parameter, currency, prices, 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=False, reply_to_message_id=None, reply_markup=None, provider_data=None, send_phone_number_to_provider=None, send_email_to_provider=None, timeout=None, **kwargs)

Use this method to send invoices.

Parameters:
  • chat_id (int | str) – Unique identifier for the target private chat.
  • title (str) – Product name.
  • description (str) – Product description.
  • payload (str) – Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
  • provider_token (str) – Payments provider token, obtained via Botfather.
  • start_parameter (str) – Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter.
  • currency (str) – Three-letter ISO 4217 currency code.
  • prices (List[telegram.LabeledPrice) – Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).
  • provider_data (str | object, optional) – JSON-encoded data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. When an object is passed, it will be encoded as JSON.
  • photo_url (str, optional) – URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.
  • photo_size (str, optional) – Photo size.
  • photo_width (int, optional) – Photo width.
  • photo_height (int, optional) – Photo height.
  • need_name (bool, optional) – Pass True, if you require the user’s full name to complete the order.
  • need_phone_number (bool, optional) – Pass True, if you require the user’s phone number to complete the order.
  • need_email (bool, optional) – Pass True, if you require the user’s email to complete the order.
  • need_shipping_address (bool, optional) – Pass True, if you require the user’s shipping address to complete the order.
  • send_phone_number_to_provider (bool, optional) – Pass True, if user’s phone number should be sent to provider.
  • send_email_to_provider (bool, optional) – Pass True, if user’s email address should be sent to provider.
  • is_flexible (bool, optional) – Pass True, if the final price depends on the shipping method.
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. An inlinekeyboard. If empty, one ‘Pay total price’ button will be shown. If not empty, the first button must be a Pay button.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_location(chat_id, latitude=None, longitude=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=None, location=None, live_period=None, **kwargs)

Use this method to send point on the map.

Note

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

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.
  • location (telegram.Location, optional) – The location to send.
  • live_period (int, optional) – Period in seconds for which the location will be updated, should be between 60 and 86400.
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_media_group(chat_id, media, disable_notification=None, reply_to_message_id=None, timeout=20, **kwargs)

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

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • media (List[telegram.InputMedia]) – An array describing photos and videos to be sent, must include 2–10 items.
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • timeout (int | float, optional) – Send file timeout (default: 20 seconds).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

An array of the sent Messages.

Return type:

List[telegram.Message]

Raises:

telegram.TelegramError

send_message(chat_id, text, parse_mode=None, disable_web_page_preview=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=None, **kwargs)

Use this method to send text messages.

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • text (str) – Text of the message to be sent. Max 4096 characters. Also found as telegram.constants.MAX_MESSAGE_LENGTH.
  • parse_mode (str) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot’s message. See the constants in telegram.ParseMode for the available modes.
  • disable_web_page_preview (bool, optional) – Disables link previews for links in this message.
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_photo(chat_id, photo, caption=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, parse_mode=None, **kwargs)

Use this method to send photos.

Note

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

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • photo (str | filelike object | telegram.PhotoSize) – Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. Lastly you can pass an existing telegram.PhotoSize object to send.
  • caption (str, optional) – Photo caption (may also be used when resending photos by file_id), 0-1024 characters.
  • parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the constants in telegram.ParseMode for the available modes.
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – Send file timeout (default: 20 seconds).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_poll(chat_id, question, options, disable_notification=None, reply_to_message_id=None, reply_markup=None, timeout=None, **kwargs)

Use this method to send a native poll. A native poll can’t be sent to a private chat.

Parameters:
  • chat_id (int | str) – Unique identifier for the target private chat.
  • question (str) – Poll question, 1-255 characters.
  • options (List[str]) – List of answer options, 2-10 strings 1-100 characters each.
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_sticker(chat_id, sticker, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, **kwargs)

Use this method to send .webp stickers.

Note

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

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • sticker (str | filelike object telegram.Sticker) – Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .webp file from the Internet, or upload a new one using multipart/form-data. Lastly you can pass an existing telegram.Sticker object to send.
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – Send file timeout (default: 20 seconds).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_venue(chat_id, latitude=None, longitude=None, title=None, address=None, foursquare_id=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=None, venue=None, foursquare_type=None, **kwargs)

Use this method to send information about a venue.

Note

you can either supply venue, or latitude, longitude, title and address and optionally foursquare_id and optionally foursquare_type.

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”.)
  • venue (telegram.Venue, optional) – The venue to send.
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_video(chat_id, video, duration=None, caption=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, width=None, height=None, parse_mode=None, supports_streaming=None, thumb=None, **kwargs)

Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document).

Note

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

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • video (str | filelike object | telegram.Video) – Video file to send. Pass a file_id as String to send an video file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an video file from the Internet, or upload a new one using multipart/form-data. Lastly you can pass an existing telegram.Video object to send.
  • duration (int, optional) – Duration of sent video in seconds.
  • width (int, optional) – Video width.
  • height (int, optional) – Video height.
  • caption (str, optional) – Video caption (may also be used when resending videos by file_id), 0-1024 characters.
  • parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the constants in telegram.ParseMode for the available modes.
  • 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.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • thumb (filelike object, optional) – Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 90. Ignored if the file is not is passed as a string or file_id.
  • timeout (int | float, optional) – Send file timeout (default: 20 seconds).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_video_note(chat_id, video_note, duration=None, length=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, thumb=None, **kwargs)

Use this method to send video messages.

Note

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

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • video_note (str | filelike object | telegram.VideoNote) – Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. Or you can pass an existing telegram.VideoNote object to send. Sending video notes by a URL is currently unsupported.
  • duration (int, optional) – Duration of sent video in seconds.
  • length (int, optional) – Video width and height
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • thumb (filelike object, optional) – Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 90. Ignored if the file is not is passed as a string or file_id.
  • timeout (int | float, optional) – Send file timeout (default: 20 seconds).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

send_voice(chat_id, voice, duration=None, caption=None, disable_notification=False, reply_to_message_id=None, reply_markup=None, timeout=20, parse_mode=None, **kwargs)

Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Audio or Document).

Note

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

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • voice (str | filelike object | telegram.Voice) – Voice file to send. Pass a file_id as String to send an voice file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an voice file from the Internet, or upload a new one using multipart/form-data. Lastly you can pass an existing telegram.Voice object to send.
  • caption (str, optional) – Voice message caption, 0-1024 characters.
  • parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the constants in telegram.ParseMode for the available modes.
  • duration (int, optional) – Duration of the voice message in seconds.
  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.
  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – Send file timeout (default: 20 seconds).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the sent Message is returned.

Return type:

telegram.Message

Raises:

telegram.TelegramError

setChatDescription(chat_id, description, timeout=None, **kwargs)

Alias for set_chat_description

setChatPermissions(chat_id, permissions, timeout=None, **kwargs)

Alias for set_chat_permissions

setChatPhoto(chat_id, photo, timeout=20, **kwargs)

Alias for set_chat_photo

setChatStickerSet(chat_id, sticker_set_name, timeout=None, **kwargs)

Alias for set_chat_sticker_set

setChatTitle(chat_id, title, timeout=None, **kwargs)

Alias for set_chat_title

setGameScore(user_id, score, chat_id=None, message_id=None, inline_message_id=None, force=None, disable_edit_message=None, timeout=None, **kwargs)

Alias for set_game_score

setPassportDataErrors(user_id, errors, timeout=None, **kwargs)

Alias for set_passport_data_errors

setStickerPositionInSet(sticker, position, timeout=None, **kwargs)

Alias for set_sticker_position_in_set

setWebhook(url=None, certificate=None, timeout=None, max_connections=40, allowed_updates=None, **kwargs)

Alias for set_webhook

set_chat_description(chat_id, description, timeout=None, **kwargs)

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.

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • description (str) – New chat description, 1-255 characters.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments
Returns:

Returns True on success.

Return type:

bool

Raises:

telegram.TelegramError

set_chat_permissions(chat_id, permissions, timeout=None, **kwargs)

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 can_restrict_members admin rights. Returns True on success.

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).
  • permissions (telegram.ChatPermissions) – New default chat permissions.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments
Returns:

Returns True on success.

Return type:

bool

Raises:

telegram.TelegramError

set_chat_photo(chat_id, photo, timeout=20, **kwargs)

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.

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • photo (filelike object) – New chat photo.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments

Note

In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group.

Returns:Returns True on success.
Return type:bool
Raises:telegram.TelegramError
set_chat_sticker_set(chat_id, sticker_set_name, timeout=None, **kwargs)

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

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.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

True on success.

Return type:

bool

set_chat_title(chat_id, title, timeout=None, **kwargs)

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.

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-255 characters.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments

Note

In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group.

Returns:Returns True on success.
Return type:bool
Raises:telegram.TelegramError
set_game_score(user_id, score, chat_id=None, message_id=None, inline_message_id=None, force=None, disable_edit_message=None, timeout=None, **kwargs)

Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user’s current score in the chat and force is False.

Parameters:
  • user_id (int) – User identifier.
  • score (int) – New score, must be non-negative.
  • force (bool, optional) – Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters
  • disable_edit_message (bool, optional) – Pass True, if the game message should not be automatically edited to include the current scoreboard.
  • chat_id (int|str, optional) – Required if inline_message_id is not specified. Unique identifier for the target chat.
  • message_id (int, optional) – Required if inline_message_id is not specified. Identifier of the sent message.
  • inline_message_id (str, optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

The edited message, or if the message wasn’t sent by the bot , True.

Return type:

telegram.Message

Raises:
  • telegram.TelegramError – If the new score is not greater than the user’s
  • current score in the chat and force is False.
set_passport_data_errors(user_id, errors, timeout=None, **kwargs)

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). Returns True on success.

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:
  • user_id (int) – User identifier
  • errors (List[PassportElementError]) – A JSON-serialized array describing the errors.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.TelegramError

set_sticker_position_in_set(sticker, position, timeout=None, **kwargs)

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

Parameters:
  • sticker (str) – File identifier of the sticker.
  • position (int) – New sticker position in the set, zero-based.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, True is returned.

Return type:

bool

Raises:

telegram.TelegramError

set_webhook(url=None, certificate=None, timeout=None, max_connections=40, allowed_updates=None, **kwargs)

Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts.

If you’d like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bot’s token, you can be pretty sure it’s us.

Note

The certificate argument should be a file from disk open(filename, 'rb').

Parameters:
  • url (str) – HTTPS url to send updates to. Use an empty string to remove webhook integration.
  • certificate (filelike) – Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. (https://goo.gl/rw7w6Y)
  • max_connections (int, optional) – Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot’s server, and higher values to increase your bot’s throughput.
  • allowed_updates (List[str], optional) – List the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See telegram.Update for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used. Please note that this parameter doesn’t affect updates created before the call to the set_webhook, so unwanted updates may be received for a short period of time.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.

Note

  1. You will not be able to receive updates using get_updates for as 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: 443, 80, 88, 8443.
Returns:bool On success, True is returned.
Raises:telegram.TelegramError
stopMessageLiveLocation(chat_id=None, message_id=None, inline_message_id=None, reply_markup=None, timeout=None, **kwargs)

Alias for stop_message_live_location

stopPoll(chat_id, message_id, reply_markup=None, timeout=None, **kwargs)

Alias for stop_poll

stop_message_live_location(chat_id=None, message_id=None, inline_message_id=None, reply_markup=None, timeout=None, **kwargs)

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.

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) – Required if inline_message_id is not specified. Identifier of the sent message.
  • inline_message_id (str, optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.
  • reply_markup (telegram.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
Returns:

On success the edited message.

Return type:

telegram.Message

stop_poll(chat_id, message_id, reply_markup=None, timeout=None, **kwargs)

Use this method to stop a poll which was sent by the bot.

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.ReplyMarkup, optional) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

On success, the stopped Poll with the

final results is returned.

Return type:

telegram.Poll

Raises:

telegram.TelegramError

unbanChatMember(chat_id, user_id, timeout=None, **kwargs)

Alias for unban_chat_member

unban_chat_member(chat_id, user_id, timeout=None, **kwargs)

Use this method to unban a previously kicked user in a supergroup.

The user will not return to the group automatically, but will be able to join via link, etc. The bot must be an administrator in the group for this to work.

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.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

bool On success, True is returned.

Raises:

telegram.TelegramError

unpinChatMessage(chat_id, timeout=None, **kwargs)

Alias for unpin_chat_message

unpin_chat_message(chat_id, timeout=None, **kwargs)

Use this method to unpin a message in a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.

Parameters:
  • chat_id (int | str) – Unique identifier for the target chat or username of the target channel (in the format @channelusername).
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments
Returns:

Returns True on success.

Return type:

bool

Raises:

telegram.TelegramError

uploadStickerFile(user_id, png_sticker, timeout=20, **kwargs)

Alias for upload_sticker_file

upload_sticker_file(user_id, png_sticker, timeout=20, **kwargs)

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

Note

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

Parameters:
  • user_id (int) – User identifier of sticker file owner.
  • png_sticker (str | filelike object) – Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px.
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

The uploaded File

Return type:

telegram.File

Raises:

telegram.TelegramError

username

Bot’s username.

Type:str