Python Telegram Bot Documentation

Release 12.8

Leandro Toledo

Jun 22, 2020

 Contents

1 Guides and tutorials 1

2 Examples 3

3 Reference 5
3.1 telegram.ext package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.1.1 telegram.ext.Updater . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.1.2 telegram.ext.Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
3.1.3 telegram.ext.DispatcherHandlerStop . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.1.4 telegram.ext.filters Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.1.5 telegram.ext.Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
3.1.6 telegram.ext.JobQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.1.7 telegram.ext.MessageQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.1.8 telegram.ext.DelayQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.1.9 telegram.ext.CallbackContext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
3.1.10 telegram.ext.Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
3.1.11 Handlers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3.1.12 Persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
3.2 telegram package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
3.2.1 telegram.Animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
3.2.2 telegram.Audio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
3.2.3 telegram.Bot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
3.2.4 telegram.BotCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
3.2.5 telegram.CallbackQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
3.2.6 telegram.Chat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
3.2.7 telegram.ChatAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
3.2.8 telegram.ChatMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
3.2.9 telegram.ChatPermissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
3.2.10 telegram.ChatPhoto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
3.2.11 telegram.constants Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
3.2.12 telegram.Contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
3.2.13 telegram.Dice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
3.2.14 telegram.Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
3.2.15 telegram.error module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
3.2.16 telegram.File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
3.2.17 telegram.ForceReply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
3.2.18 telegram.InlineKeyboardButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
3.2.19 telegram.InlineKeyboardMarkup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
3.2.20 telegram.InputFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
3.2.21 telegram.InputMedia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
3.2.22 telegram.InputMediaAnimation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

i
 3.2.23 telegram.InputMediaAudio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
3.2.24 telegram.InputMediaDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
3.2.25 telegram.InputMediaPhoto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
3.2.26 telegram.InputMediaVideo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
3.2.27 telegram.KeyboardButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
3.2.28 telegram.KeyboardButtonPollType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
3.2.29 telegram.Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
3.2.30 telegram.LoginUrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
3.2.31 telegram.Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
3.2.32 telegram.MessageEntity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
3.2.33 telegram.ParseMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
3.2.34 telegram.PhotoSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
3.2.35 telegram.Poll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
3.2.36 telegram.PollAnswer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
3.2.37 telegram.PollOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
3.2.38 telegram.ReplyKeyboardRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
3.2.39 telegram.ReplyKeyboardMarkup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
3.2.40 telegram.ReplyMarkup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
3.2.41 telegram.TelegramObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
3.2.42 telegram.Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
3.2.43 telegram.User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
3.2.44 telegram.UserProfilePhotos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
3.2.45 telegram.Venue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
3.2.46 telegram.Video . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
3.2.47 telegram.VideoNote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
3.2.48 telegram.Voice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
3.2.49 telegram.WebhookInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
3.2.50 Stickers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
3.2.51 Inline Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
3.2.52 Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
3.2.53 Games . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
3.2.54 Passport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
3.3 telegram.utils package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
3.3.1 telegram.utils.helpers Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
3.3.2 telegram.utils.promise.Promise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
3.3.3 telegram.utils.request.Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
3.4 Changelog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
3.4.1 Changelog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

Python Module Index 257

Index 259

ii
 CHAPTER 1

Guides and tutorials

If you’re just starting out with the library, we recommend following our “Your first Bot” tutorial that you can find
on our wiki. On our wiki you will also find guides like how to use handlers, webhooks, emoji, proxies and much
more.

1
Python Telegram Bot Documentation, Release 12.8

2 Chapter 1. Guides and tutorials

 CHAPTER 2

Examples

A great way to learn is by looking at examples. Ours can be found at our github in the examples folder.

3
Python Telegram Bot Documentation, Release 12.8

4 Chapter 2. Examples
 CHAPTER 3

Reference

Below you can find a reference of all the classes and methods in python-telegram-bot. Apart from the telegram.ext
package the objects should reflect the types defined in the official telegram bot api documentation.

3.1 telegram.ext package

3.1.1 telegram.ext.Updater

class telegram.ext.Updater(token=None, base_url=None, workers=4, bot=None,

private_key=None, private_key_password=None,
user_sig_handler=None, request_kwargs=None, persis-
tence=None, defaults=None, use_context=False, dis-
patcher=None, base_file_url=None)
Bases: object
This class, which employs the telegram.ext.Dispatcher, provides a frontend to telegram.Bot
to the programmer, so they can focus on coding the bot. Its purpose is to receive the updates from Telegram
and to deliver them to said dispatcher. It also runs in a separate thread, so the user can interact with the bot,
for example on the command line. The dispatcher supports handlers for different kinds of data: Updates
from Telegram, basic text commands and even arbitrary types. The updater can be started as a polling
service or, for production, use a webhook to receive updates. This is achieved using the WebhookServer
and WebhookHandler classes.
bot
The bot used with this Updater.
Type telegram.Bot
user_sig_handler
Optional. Function to be called when a signal is received.
Type function
update_queue
Queue for the updates.
Type Queue
job_queue
Jobqueue for the updater.

5
Python Telegram Bot Documentation, Release 12.8

Type telegram.ext.JobQueue
dispatcher
Dispatcher that handles the updates and dispatches them to the handlers.
Type telegram.ext.Dispatcher
running
Indicates if the updater is running.
Type bool
persistence
Optional. The persistence class to store data that should be persistent over restarts.
Type telegram.ext.BasePersistence
use_context
Optional. True if using context based callbacks.
Type bool

Parameters
• token (str, optional) – The bot’s token given by the @BotFather.
• base_url (str, optional) – Base_url for the bot.
• base_file_url (str, optional) – Base_file_url for the bot.
• workers (int, optional) – Amount of threads in the thread pool for functions deco-
rated with @run_async (ignored if dispatcher argument is used).
• bot (telegram.Bot, optional) – A pre-initialized bot instance (ignored if dispatcher
argument is used). If a pre-initialized bot is used, it is the user’s responsibility to create
it using a Request instance with a large enough connection pool.
• dispatcher (telegram.ext.Dispatcher, optional) – A pre-initialized dis-
patcher instance. If a pre-initialized dispatcher is used, it is the user’s responsibility
to create it with proper arguments.
• private_key (bytes, optional) – Private key for decryption of telegram passport
data.
• private_key_password (bytes, optional) – Password for above private key.
• user_sig_handler (function, optional) – Takes signum, frame as posi-
tional arguments. This will be called when a signal is received, defaults are (SIGINT,
SIGTERM, SIGABRT) setable with idle.
• request_kwargs (dict, optional) – Keyword args to control the creation of a tele-
gram.utils.request.Request object (ignored if bot or dispatcher argument is used). The
request_kwargs are very useful for the advanced users who would like to control the
default timeouts and/or control the proxy used for http communication.
• use_context (bool, optional) – If set to True Use the context based callback API
(ignored if dispatcher argument is used). During the deprecation period of the old API
the default is False. New users: set this to True.
• persistence (telegram.ext.BasePersistence, optional) – The persis-
tence class to store data that should be persistent over restarts (ignored if dispatcher
argument is used).
• defaults (telegram.ext.Defaults, optional) – An object containing default
values to be used if not set explicitly in the bot methods.

Note:

6 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• You must supply either a bot or a token argument.

• If you supply a bot, you will need to pass defaults to both the bot and the telegram.ext.
Updater.

Raises ValueError – If both token and bot are passed or none of them.

idle(stop_signals=(<Signals.SIGINT: 2>, <Signals.SIGTERM: 15>, <Signals.SIGABRT: 6>))

Blocks until one of the signals are received and stops the updater.
Parameters stop_signals (list | tuple) – List containing signals from the signal
module that should be subscribed to. Updater.stop() will be called on receiving one of
those signals. Defaults to (SIGINT, SIGTERM, SIGABRT).
start_polling(poll_interval=0.0, timeout=10, clean=False, bootstrap_retries=-1,
read_latency=2.0, allowed_updates=None)
Starts polling updates from Telegram.
Parameters
• poll_interval (float, optional) – Time to wait between polling updates from
Telegram in seconds. Default is 0.0.
• timeout (float, optional) – Passed to telegram.Bot.get_updates.
• clean (bool, optional) – Whether to clean any pending updates on Telegram servers
before actually starting to poll. Default is False.
• bootstrap_retries (int, optional) – Whether the bootstrapping phase of the
Updater will retry on failures on the Telegram server.
– < 0 - retry indefinitely (default)
– 0 - no retries
– > 0 - retry up to X times
• allowed_updates (List[str], optional) – Passed to telegram.Bot.
get_updates.
• read_latency (float | int, optional) – Grace time in seconds for receiving the
reply from server. Will be added to the timeout value and used as the read timeout
from server (Default: 2).
Returns The update queue that can be filled from the main thread.
Return type Queue
start_webhook(listen=’127.0.0.1’, port=80, url_path=”, cert=None, key=None, clean=False,
bootstrap_retries=0, webhook_url=None, allowed_updates=None)
Starts a small http server to listen for updates via webhook. If cert and key are not provided, the
webhook will be started directly on http://listen:port/url_path, so SSL can be handled by another ap-
plication. Else, the webhook will be started on https://listen:port/url_path
Parameters
• listen (str, optional) – IP-Address to listen on. Default 127.0.0.1.
• port (int, optional) – Port the bot should be listening on. Default 80.
• url_path (str, optional) – Path inside url.
• cert (str, optional) – Path to the SSL certificate file.
• key (str, optional) – Path to the SSL key file.
• clean (bool, optional) – Whether to clean any pending updates on Telegram servers
before actually starting the webhook. Default is False.

3.1. telegram.ext package 7

Python Telegram Bot Documentation, Release 12.8

• bootstrap_retries (int, optional) – Whether the bootstrapping phase of the

Updater will retry on failures on the Telegram server.
– < 0 - retry indefinitely (default)
– 0 - no retries
– > 0 - retry up to X times
• webhook_url (str, optional) – Explicitly specify the webhook url. Useful behind
NAT, reverse proxy, etc. Default is derived from listen, port & url_path.
• allowed_updates (List[str], optional) – Passed to telegram.Bot.
set_webhook.
Returns The update queue that can be filled from the main thread.
Return type Queue
stop()
Stops the polling/webhook thread, the dispatcher and the job queue.

3.1.2 telegram.ext.Dispatcher

class telegram.ext.Dispatcher(bot, update_queue, workers=4, exception_event=None,

job_queue=None, persistence=None, use_context=False)
Bases: object
This class dispatches all kinds of updates to its registered handlers.
bot
The bot object that should be passed to the handlers.
Type telegram.Bot
update_queue
The synchronized queue that will contain the updates.
Type Queue
job_queue
Optional. The telegram.ext.JobQueue instance to pass onto handler callbacks.
Type telegram.ext.JobQueue
workers
Number of maximum concurrent worker threads for the @run_async decorator.
Type int
user_data
A dictionary handlers can use to store data for the user.
Type defaultdict
chat_data
A dictionary handlers can use to store data for the chat.
Type defaultdict
bot_data
A dictionary handlers can use to store data for the bot.
Type dict
persistence
Optional. The persistence class to store data that should be persistent over restarts
Type telegram.ext.BasePersistence

8 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

Parameters
• bot (telegram.Bot) – The bot object that should be passed to the handlers.
• update_queue (Queue) – The synchronized queue that will contain the updates.
• job_queue (telegram.ext.JobQueue, optional) – The telegram.ext.
JobQueue instance to pass onto handler callbacks.
• workers (int, optional) – Number of maximum concurrent worker threads for the
@run_async decorator. defaults to 4.
• persistence (telegram.ext.BasePersistence, optional) – The persis-
tence class to store data that should be persistent over restarts
• use_context (bool, optional) – If set to True Use the context based callback API.
During the deprecation period of the old API the default is False. New users: set this
to True.

add_error_handler(callback)
Registers an error handler in the Dispatcher. This handler will receive every error which happens in
your bot.
Warning: The errors handled within these handlers won’t show up in the logger, so you need to make
sure that you reraise the error.
Parameters callback (callable) – The callback function for this error handler. Will
be called when an error is raised. Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The error that happened will be present in context.error.

Note: See https://git.io/fxJuV for more info about switching to context based API.

add_handler(handler, group=0)
Register a handler.
TL;DR: Order and priority counts. 0 or 1 handlers per group will be used. End handling of update
with telegram.ext.DispatcherHandlerStop.
A handler must be an instance of a subclass of telegram.ext.Handler. All handlers are or-
ganized in groups with a numeric value. The default group is 0. All groups will be evaluated
for handling an update, but only 0 or 1 handler per group will be used. If telegram.ext.
DispatcherHandlerStop is raised from one of the handlers, no further handlers (regardless
of the group) will be called.
The priority/order of handlers is determined as follows:
• Priority of the group (lower group number == higher priority)
• The first handler in a group which should handle an update (see telegram.ext.Handler.
check_update) will be used. Other handlers from the group will not be used. The order in
which handlers were added to the group defines the priority.

Parameters
• handler (telegram.ext.Handler) – A Handler instance.
• group (int, optional) – The group identifier. Default is 0.

dispatch_error(update, error)
Dispatches an error.
Parameters
• update (str | telegram.Update | None) – The update that caused the error

3.1. telegram.ext package 9

Python Telegram Bot Documentation, Release 12.8

• error (Exception) – The error that was raised.

error_handlers = None
A list of errorHandlers.
Type List[callable]
classmethod get_instance()
Get the singleton instance of this class.
Returns telegram.ext.Dispatcher
Raises RuntimeError
groups = None
A list with all groups.
Type List[int]
handlers = None
Holds the handlers per group.
Type Dict[int, List[telegram.ext.Handler]]
process_update(update)
Processes a single update.
Parameters update (str | telegram.Update | telegram.TelegramError) –
The update to process.
remove_error_handler(callback)
Removes an error handler.
Parameters callback (callable) – The error handler to remove.
remove_handler(handler, group=0)
Remove a handler from the specified group.
Parameters
• handler (telegram.ext.Handler) – A Handler instance.
• group (object, optional) – The group identifier. Default is 0.
run_async(func, *args, **kwargs)
Queue a function (with given args/kwargs) to be run asynchronously.

Warning: If you’re using @run_async you cannot rely on adding custom attributes to
telegram.ext.CallbackContext. See its docs for more info.

Parameters
• func (callable) – The function to run in the thread.
• *args (tuple, optional) – Arguments to func.
• **kwargs (dict, optional) – Keyword arguments to func.
Returns Promise

running = None
Indicates if this dispatcher is running.
Type bool
start(ready=None)
Thread target of thread ‘dispatcher’.
Runs in background and processes the update queue.

10 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

Parameters ready (threading.Event, optional) – If specified, the event will be set

once the dispatcher is ready.
stop()
Stops the thread.
update_persistence(update=None)
Update user_data, chat_data and bot_data in persistence.
Parameters
• update (telegram.Update, optional) – The update to process. If passed, only
the
• user_data and chat_data will be updated. (corresponding) –

3.1.3 telegram.ext.DispatcherHandlerStop

class telegram.ext.DispatcherHandlerStop
Bases: Exception
Raise this in handler to prevent execution any other handler (even in different group).

3.1.4 telegram.ext.filters Module

This module contains the Filters for use with the MessageHandler class.
class telegram.ext.filters.Filters
Bases: object
Predefined filters for use as the filter argument of telegram.ext.MessageHandler.

Examples
Use MessageHandler(Filters.video, callback_method) to filter all video messages. Use
MessageHandler(Filters.contact, callback_method) for all contacts. etc.

all = Filters.all
All Messages.
animation = Filters.animation
Messages that contain telegram.Animation.
audio = Filters.audio
Messages that contain telegram.Audio.
caption = Filters.caption
Messages with a caption. If a list of strings is passed, it filters messages to only allow those whose
caption is appearing in the given list.

Examples
MessageHandler(Filters.caption, callback_method)

Parameters update (List[str] | Tuple[str], optional) – Which captions to allow. Only

exact matches are allowed. If not specified, will allow any message with a caption.

class caption_entity(entity_type)
Bases: telegram.ext.filters.BaseFilter

3.1. telegram.ext package 11

Python Telegram Bot Documentation, Release 12.8

Filters media messages to only allow those which have a telegram.MessageEntity where their
type matches entity_type.

Examples
Example MessageHandler(Filters.caption_entity("hashtag"),
callback_method)

Parameters entity_type – Caption Entity type to check for. All types can be found as
constants in telegram.MessageEntity.

class chat(chat_id=None, username=None, allow_empty=False)

Bases: telegram.ext.filters.BaseFilter
Filters messages to allow only those which are from specified chat ID.

Examples
MessageHandler(Filters.chat(-1234), callback_method)

Warning: chat_ids will give a copy of the saved chat ids as frozenset. This is to ensure
thread safety. To add/remove a chat, you should use add_usernames(), add_chat_ids(),
remove_usernames() and remove_chat_ids(). Only update the entire set by filter.
chat_ids/usernames = new_set, if you are entirely sure that it is not causing race condi-
tions, as this will complete replace the current set of allowed chats.

chat_ids
Which chat ID(s) to allow through.
Type set(int), optional
usernames
Which username(s) (without leading ‘@’) to allow through.
Type set(str), optional
allow_empty
Whether updates should be processed, if no chat is specified in chat_ids and usernames.
Type bool, optional

Parameters
• chat_id (int | List[int], optional) – Which chat ID(s) to allow through.
• username (str | List[str], optional) – Which username(s) to allow through. Lead-
ing ‘@’s in usernames will be discarded.
• allow_empty (bool, optional) – Whether updates should be processed, if no chat
is specified in chat_ids and usernames. Defaults to False
Raises RuntimeError – If chat_id and username are both present.

add_chat_ids(chat_id)
Add one or more chats to the allowed chat ids.
Parameters chat_id (int | List[int], optional) – Which chat ID(s) to allow through.
add_usernames(username)
Add one or more chats to the allowed usernames.
Parameters username (str | List[str], optional) – Which username(s) to allow
through. Leading ‘@’s in usernames will be discarded.

12 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

remove_chat_ids(chat_id)
Remove one or more chats from allowed chat ids.
Parameters chat_id (int | List[int], optional) – Which chat ID(s) to disallow
through.
remove_usernames(username)
Remove one or more chats from allowed usernames.
Parameters username (str | List[str], optional) – Which username(s) to disallow
through. Leading ‘@’s in usernames will be discarded.
command = Filters.command
Messages with a telegram.MessageEntity.BOT_COMMAND. By default only allows messages
starting with a bot command. Pass False to also allow messages that contain a bot command any-
where in the text.
Examples:

MessageHandler(Filters.command, command_at_start_callback)
MessageHandler(Filters.command(False), command_anywhere_callback)

Note: Filters.text also accepts messages containing a command.

Parameters update (bool, optional) – Whether to only allow messages that start with a
bot command. Defaults to True.

contact = Filters.contact
Messages that contain telegram.Contact.
dice = Filters.dice
Dice Messages. If an integer or a list of integers is passed, it filters messages to only allow those whose
dice value is appearing in the given list.

Examples
To allow any dice message, simply use MessageHandler(Filters.dice,
callback_method). To allow only dice with value 6, use MessageHandler(Filters.
dice(6), callback_method). To allow only dice with value 5 or 6, use
MessageHandler(Filters.dice([5, 6]), callback_method).

Parameters update (int | List[int], optional) – Which values to allow. If not specified,
will allow any dice message.

Note: Dice messages don’t have text. If you want to filter either text or dice messages, use Filters.
text | Filters.dice.

dice
Dice messages with the emoji . Passing a list of integers is supported just as for Filters.dice.
darts
Dice messages with the emoji . Passing a list of integers is supported just as for Filters.dice.
basketball
Dice messages with the emoji . Passing a list of integers is supported just as for Filters.dice.
document = Filters.document
Subset for messages containing a document/file.

3.1. telegram.ext package 13

Python Telegram Bot Documentation, Release 12.8

Examples
Use these filters like: Filters.document.mp3, Filters.document.
mime_type("text/plain") etc. Or use just Filters.document for all document
messages.

category
This Filter filters documents by their category in the mime-type attribute

Note: This Filter only filters by the mime_type of the document, it doesn’t check the validity of
the document. The user can manipulate the mime-type of a message and send media with wrong
types that don’t fit to this handler.

Example
Filters.documents.category('audio/') filters all types of audio sent as file, for
example ‘audio/mpeg’ or ‘audio/x-wav’

application
Same as Filters.document.category("application").
audio
Same as Filters.document.category("audio").
image
Same as Filters.document.category("image").
video
Same as Filters.document.category("video").
text
Same as Filters.document.category("text").
mime_type
This Filter filters documents by their mime-type attribute

Note: This Filter only filters by the mime_type of the document, it doesn’t check the validity of
document.
The user can manipulate the mime-type of a message and send media with wrong types that don’t
fit to this handler.

Example
Filters.documents.mime_type('audio/mpeg') filters all audio in mp3 format.

apk
Same as Filters.document.mime_type("application/vnd.android.
package-archive")-
doc
Same as Filters.document.mime_type("application/msword")-
docx
Same as Filters.document.mime_type("application/vnd.
openxmlformats-officedocument.wordprocessingml.document")-

14 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

exe
Same as Filters.document.mime_type("application/
x-ms-dos-executable")-
gif
Same as Filters.document.mime_type("video/mp4")-
jpg
Same as Filters.document.mime_type("image/jpeg")-
mp3
Same as Filters.document.mime_type("audio/mpeg")-
pdf
Same as Filters.document.mime_type("application/pdf")-
py
Same as Filters.document.mime_type("text/x-python")-
svg
Same as Filters.document.mime_type("image/svg+xml")-
txt
Same as Filters.document.mime_type("text/plain")-
targz
Same as Filters.document.mime_type("application/x-compressed-tar")-
wav
Same as Filters.document.mime_type("audio/x-wav")-
xml
Same as Filters.document.mime_type("application/xml")-
zip
Same as Filters.document.mime_type("application/zip")-
class entity(entity_type)
Bases: telegram.ext.filters.BaseFilter
Filters messages to only allow those which have a telegram.MessageEntity where their type
matches entity_type.

Examples
Example MessageHandler(Filters.entity("hashtag"), callback_method)

Parameters entity_type – Entity type to check for. All types can be found as constants
in telegram.MessageEntity.

forwarded = Filters.forwarded
Messages that are forwarded.
game = Filters.game
Messages that contain telegram.Game.
group = Filters.group
Messages sent in a group chat.
invoice = Filters.invoice
Messages that contain telegram.Invoice.
class language(lang)
Bases: telegram.ext.filters.BaseFilter
Filters messages to only allow those which are from users with a certain language code.

3.1. telegram.ext package 15

Python Telegram Bot Documentation, Release 12.8

Note: According to official telegram api documentation, not every single user has the language_code
attribute. Do not count on this filter working on all users.

Examples
MessageHandler(Filters.language("en"), callback_method)

Parameters lang (str | List[str]) – Which language code(s) to allow through. This
will be matched using .startswith meaning that ‘en’ will match both ‘en_US’ and
‘en_GB’.

location = Filters.location
Messages that contain telegram.Location.
passport_data = Filters.passport_data
Messages that contain a telegram.PassportData
photo = Filters.photo
Messages that contain telegram.PhotoSize.
poll = Filters.poll
Messages that contain a telegram.Poll.
private = Filters.private
Messages sent in a private chat.
class regex(pattern)
Bases: telegram.ext.filters.BaseFilter
Filters updates by searching for an occurrence of pattern in the message text. The re.search
function is used to determine whether an update should be filtered.
Refer to the documentation of the re module for more information.
To get the groups and groupdict matched, see telegram.ext.CallbackContext.matches.

Examples
Use MessageHandler(Filters.regex(r'help'), callback) to capture all messages
that contain the word help. You can also use MessageHandler(Filters.regex(re.
compile(r'help', re.IGNORECASE), callback) if you want your pattern to be case in-
sensitive. This approach is recommended if you need to specify flags on your pattern.

Note: Filters use the same short circuiting logic as python’s and, or and not. This means that for
example:

>>> Filters.regex(r'(a?x)') | Filters.regex(r'(b?x)')

With a message.text of x, will only ever return the matches for the first filter, since the second one is
never evaluated.

Parameters pattern (str | Pattern) – The regex pattern.

reply = Filters.reply
Messages that are a reply to another message.

16 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

status_update = Filters.status_update
Subset for messages containing a status update.

Examples
Use these filters like: Filters.status_update.new_chat_members etc. Or use just
Filters.status_update for all status update messages.

chat_created
Messages that contain telegram.Message.group_chat_created,
telegram.Message.supergroup_chat_created or telegram.Message.
channel_chat_created.
delete_chat_photo
Messages that contain telegram.Message.delete_chat_photo.
left_chat_member
Messages that contain telegram.Message.left_chat_member.
migrate
Messages that contain telegram.Message.migrate_from_chat_id or :attr: tele-
gram.Message.migrate_from_chat_id.
new_chat_members
Messages that contain telegram.Message.new_chat_members.
new_chat_photo
Messages that contain telegram.Message.new_chat_photo.
new_chat_title
Messages that contain telegram.Message.new_chat_title.
pinned_message
Messages that contain telegram.Message.pinned_message.
sticker = Filters.sticker
Messages that contain telegram.Sticker.
successful_payment = Filters.successful_payment
Messages that confirm a telegram.SuccessfulPayment.
text = Filters.text
Text Messages. If a list of strings is passed, it filters messages to only allow those whose text is
appearing in the given list.

Examples
To allow any text message, simply use MessageHandler(Filters.text,
callback_method).
A simple usecase for passing a list is to allow only messages that were send by a custom telegram.
ReplyKeyboardMarkup:

buttons = ['Start', 'Settings', 'Back']

markup = ReplyKeyboardMarkup.from_column(buttons)
...
MessageHandler(Filters.text(buttons), callback_method)

Note:
• Dice messages don’t have text. If you want to filter either text or dice messages, use Filters.
text | Filters.dice.

3.1. telegram.ext package 17

Python Telegram Bot Documentation, Release 12.8

• Messages containing a command are accepted by this filter. Use Filters.text &
(~Filters.command), if you want to filter only text messages without commands.

Parameters update (List[str] | Tuple[str], optional) – Which messages to allow. Only

exact matches are allowed. If not specified, will allow any text message.

update = Filters.update
Subset for filtering the type of update.

Examples
Use these filters like: Filters.update.message or Filters.update.channel_posts
etc. Or use just Filters.update for all types.

message
Updates with telegram.Update.message
edited_message
Updates with telegram.Update.edited_message
messages
Updates with either telegram.Update.message or telegram.Update.
edited_message
channel_post
Updates with telegram.Update.channel_post
edited_channel_post
Updates with telegram.Update.edited_channel_post
channel_posts
Updates with either telegram.Update.channel_post or telegram.Update.
edited_channel_post
class user(user_id=None, username=None, allow_empty=False)
Bases: telegram.ext.filters.BaseFilter
Filters messages to allow only those which are from specified user ID.

Examples
MessageHandler(Filters.user(1234), callback_method)

Warning: user_ids will give a copy of the saved user ids as frozenset. This is to ensure
thread safety. To add/remove a user, you should use add_usernames(), add_user_ids(),
remove_usernames() and remove_user_ids(). Only update the entire set by filter.
user_ids/usernames = new_set, if you are entirely sure that it is not causing race condi-
tions, as this will complete replace the current set of allowed users.

user_ids
Which user ID(s) to allow through.
Type set(int), optional
usernames
Which username(s) (without leading ‘@’) to allow through.
Type set(str), optional
allow_empty
Whether updates should be processed, if no user is specified in user_ids and usernames.

18 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

Type bool, optional

Parameters
• user_id (int | List[int], optional) – Which user ID(s) to allow through.
• username (str | List[str], optional) – Which username(s) to allow through. Lead-
ing ‘@’s in usernames will be discarded.
• allow_empty (bool, optional) – Whether updates should be processed, if no user
is specified in user_ids and usernames. Defaults to False
Raises RuntimeError – If user_id and username are both present.

add_user_ids(user_id)
Add one or more users to the allowed user ids.
Parameters user_id (int | List[int], optional) – Which user ID(s) to allow through.
add_usernames(username)
Add one or more users to the allowed usernames.
Parameters username (str | List[str], optional) – Which username(s) to allow
through. Leading ‘@’s in usernames will be discarded.
remove_user_ids(user_id)
Remove one or more users from allowed user ids.
Parameters user_id (int | List[int], optional) – Which user ID(s) to disallow
through.
remove_usernames(username)
Remove one or more users from allowed usernames.
Parameters username (str | List[str], optional) – Which username(s) to disallow
through. Leading ‘@’s in usernames will be discarded.
venue = Filters.venue
Messages that contain telegram.Venue.
video = Filters.video
Messages that contain telegram.Video.
video_note = Filters.video_note
Messages that contain telegram.VideoNote.
voice = Filters.voice
Messages that contain telegram.Voice.
class telegram.ext.filters.BaseFilter
Bases: abc.ABC
Base class for all Message Filters.
Subclassing from this class filters to be combined using bitwise operators:
And:

>>> (Filters.text & Filters.entity(MENTION))

Or:

>>> (Filters.audio | Filters.video)

Not:

>>> ~ Filters.command

Also works with more than two filters:

3.1. telegram.ext package 19

Python Telegram Bot Documentation, Release 12.8

>>> (Filters.text & (Filters.entity(URL) | Filters.entity(TEXT_LINK)))

>>> Filters.text & (~ Filters.forwarded)

Note: Filters use the same short circuiting logic as python’s and, or and not. This means that for example:

>>> Filters.regex(r'(a?x)') | Filters.regex(r'(b?x)')

With a message.text of x, will only ever return the matches for the first filter, since the second one is never
evaluated.

If you want to create your own filters create a class inheriting from this class and implement a filter method
that returns a boolean: True if the message should be handled, False otherwise. Note that the filters work
only as class instances, not actual class objects (so remember to initialize your filter classes).
By default the filters name (what will get printed when converted to a string for display) will be the class
name. If you want to overwrite this assign a better name to the name class variable.
name
Name for this filter. Defaults to the type of filter.
Type str
update_filter
Whether this filter should work on update. If False it will run the filter on update.
effective_message`. Default is False.
Type bool
data_filter
Whether this filter is a data filter. A data filter should return a dict with lists. The dict will be merged
with telegram.ext.CallbackContext’s internal dict in most cases (depends on the handler).
Type bool
filter(update)
This method must be overwritten.

Note: If update_filter is false then the first argument is message and of type telegram.
Message.

Parameters update (telegram.Update) – The update that is tested.

Returns dict or bool

class telegram.ext.filters.InvertedFilter(f )
Bases: telegram.ext.filters.BaseFilter
Represents a filter that has been inverted.
Parameters f – The filter to invert.
filter(update)
This method must be overwritten.

Note: If update_filter is false then the first argument is message and of type telegram.
Message.

Parameters update (telegram.Update) – The update that is tested.

Returns dict or bool

20 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

class telegram.ext.filters.MergedFilter(base_filter, and_filter=None, or_filter=None)

Bases: telegram.ext.filters.BaseFilter
Represents a filter consisting of two other filters.
Parameters
• base_filter – Filter 1 of the merged filter
• and_filter – Optional filter to “and” with base_filter. Mutually exclusive with
or_filter.
• or_filter – Optional filter to “or” with base_filter. Mutually exclusive with
and_filter.
filter(update)
This method must be overwritten.

Note: If update_filter is false then the first argument is message and of type telegram.
Message.

Parameters update (telegram.Update) – The update that is tested.

Returns dict or bool

3.1.5 telegram.ext.Job

class telegram.ext.Job(callback, interval=None, repeat=True, context=None, days=(0, 1, 2, 3,

4, 5, 6), name=None, job_queue=None, tzinfo=None, is_monthly=False,
day_is_strict=True)
Bases: object
This class encapsulates a Job.
callback
The callback function that should be executed by the new job.
Type callable
context
Optional. Additional data needed for the callback function.
Type object
name
Optional. The name of the new job.
Type str
is_monthly (
obj: bool): Optional. Indicates whether it is a monthly job.
day_is_strict (
obj: bool): Optional. Indicates whether the monthly jobs day is strict.

Parameters
• callback (callable) – The callback function that should be executed by the new
job. Callback signature for context based API:
def callback(CallbackContext)
a context.job is the telegram.ext.Job instance. It can be used to access its
job.context or change it to a repeating job.

3.1. telegram.ext package 21

Python Telegram Bot Documentation, Release 12.8

• interval (int | float | datetime.timedelta, optional) – The time interval

between executions of the job. If it is an int or a float, it will be interpreted as
seconds. If you don’t set this value, you must set repeat to False and specify
time_spec when you put the job into the job queue.
• repeat (bool, optional) – If this job should be periodically execute its callback func-
tion (True) or only once (False). Defaults to True.
• context (object, optional) – Additional data needed for the callback function. Can
be accessed through job.context in the callback. Defaults to None.
• name (str, optional) – The name of the new job. Defaults to callback.__name__.
• days (Tuple[int], optional) – Defines on which days of the week the job should run.
Defaults to Days.EVERY_DAY
• job_queue (telegram.ext.JobQueue, optional) – The JobQueue this job be-
longs to. Only optional for backward compatibility with JobQueue.put().
• tzinfo (datetime.tzinfo, optional) – timezone associated to this job. Used
when checking the day of the week to determine whether a job should run (only relevant
when days is not Days.EVERY_DAY). Defaults to UTC.
• is_monthly (bool, optional) – If this job is supposed to be a monthly scheduled
job. Defaults to False.
• day_is_strict (bool, optional) – If False and day > month.days, will pick the
last day in the month. Defaults to True. Only relevant when is_monthly is True.

days
Optional. Defines on which days of the week the job should run.
Type Tuple[int]
enabled
Whether this job is enabled.
Type bool
interval
Optional. The interval in which the job will run.
Type int | float | datetime.timedelta
interval_seconds
The interval for this job in seconds.
Type int
job_queue
Optional. The JobQueue this job belongs to.
Type telegram.ext.JobQueue
next_t
Datetime for the next job execution. Datetime is localized according to tzinfo. If job is removed or
already ran it equals to None.
Type datetime.datetime
removed
Whether this job is due to be removed.
Type bool
repeat
Optional. If this job should periodically execute its callback function.
Type bool

22 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

run(dispatcher)
Executes the callback function.
schedule_removal()
Schedules this job for removal from the JobQueue. It will be removed without executing its callback
function again.

3.1.6 telegram.ext.JobQueue

class telegram.ext.JobQueue(bot=None)
Bases: object
This class allows you to periodically perform tasks with the bot.
_queue
The queue that holds the Jobs.
Type PriorityQueue
bot
The bot instance that should be passed to the jobs. DEPRECATED: Use set_dispatcher instead.
Type telegram.Bot
get_jobs_by_name(name)
Returns a tuple of jobs with the given name that are currently in the JobQueue
jobs()
Returns a tuple of all jobs that are currently in the JobQueue.
run_daily(callback, time, days=(0, 1, 2, 3, 4, 5, 6), context=None, name=None)
Creates a new Job that runs on a daily basis and adds it to the queue.
Parameters
• callback (callable) – The callback function that should be executed by the new
job. Callback signature for context based API:
def callback(CallbackContext)
context.job is the telegram.ext.Job instance. It can be used to access its
job.context or change it to a repeating job.
• time (datetime.time) – Time of day at which the job should run. If the timezone
(time.tzinfo) is None, UTC will be assumed. time.tzinfo will implicitly
define Job.tzinfo.
• days (Tuple[int], optional) – Defines on which days of the week the job should run.
Defaults to EVERY_DAY
• context (object, optional) – Additional data needed for the callback function.
Can be accessed through job.context in the callback. Defaults to None.
• name (str, optional) – The name of the new job. Defaults to callback.
__name__.
Returns The new Job instance that has been added to the job queue.
Return type telegram.ext.Job

Note: Daily is just an alias for “24 Hours”. That means that if DST changes during that interval, the
job might not run at the time one would expect. It is always recommended to pin servers to UTC time,
then time related behaviour can always be expected.

run_monthly(callback, when, day, context=None, name=None, day_is_strict=True)

Creates a new Job that runs on a monthly basis and adds it to the queue.

3.1. telegram.ext package 23

Python Telegram Bot Documentation, Release 12.8

Parameters
• callback (callable) – The callback function that should be executed by the new
job. Callback signature for context based API:
def callback(CallbackContext)
context.job is the telegram.ext.Job instance. It can be used to access its
job.context or change it to a repeating job.
• when (datetime.time) – Time of day at which the job should run. If the timezone
(when.tzinfo) is None, UTC will be assumed. This will also implicitly define
Job.tzinfo.
• day (int) – Defines the day of the month whereby the job would run. It should be
within the range of 1 and 31, inclusive.
• context (object, optional) – Additional data needed for the callback function.
Can be accessed through job.context in the callback. Defaults to None.
• name (str, optional) – The name of the new job. Defaults to callback.
__name__.
• day_is_strict (bool, optional) – If False and day > month.days, will pick the
last day in the month. Defaults to True.
Returns The new Job instance that has been added to the job queue.
Return type telegram.ext.Job
run_once(callback, when, context=None, name=None)
Creates a new Job that runs once and adds it to the queue.
Parameters
• callback (callable) – The callback function that should be executed by the new
job. Callback signature for context based API:
def callback(CallbackContext)
context.job is the telegram.ext.Job instance. It can be used to access its
job.context or change it to a repeating job.
• when (int | float | datetime.timedelta | datetime.datetime |
datetime.time) – Time in or at which the job should run. This parameter will
be interpreted depending on its type.
– int or float will be interpreted as “seconds from now” in which the job should
run.
– datetime.timedelta will be interpreted as “time from now” in which the job
should run.
– datetime.datetime will be interpreted as a specific date and time at which
the job should run. If the timezone (datetime.tzinfo) is None, UTC will be
assumed.
– datetime.time will be interpreted as a specific time of day at which the job
should run. This could be either today or, if the time has already passed, tomorrow.
If the timezone (time.tzinfo) is None, UTC will be assumed.
If when is datetime.datetime or datetime.time type then when.tzinfo
will define Job.tzinfo. Otherwise UTC will be assumed.
• context (object, optional) – Additional data needed for the callback function.
Can be accessed through job.context in the callback. Defaults to None.
• name (str, optional) – The name of the new job. Defaults to callback.
__name__.

24 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

Returns The new Job instance that has been added to the job queue.
Return type telegram.ext.Job
run_repeating(callback, interval, first=None, context=None, name=None)
Creates a new Job that runs at specified intervals and adds it to the queue.
Parameters
• callback (callable) – The callback function that should be executed by the new
job. Callback signature for context based API:
def callback(CallbackContext)
context.job is the telegram.ext.Job instance. It can be used to access its
job.context or change it to a repeating job.
• interval (int | float | datetime.timedelta) – The interval in which the
job will run. If it is an int or a float, it will be interpreted as seconds.
• first (int | float | datetime.timedelta | datetime.datetime |
datetime.time, optional) – Time in or at which the job should run. This pa-
rameter will be interpreted depending on its type.
– int or float will be interpreted as “seconds from now” in which the job should
run.
– datetime.timedelta will be interpreted as “time from now” in which the job
should run.
– datetime.datetime will be interpreted as a specific date and time at which
the job should run. If the timezone (datetime.tzinfo) is None, UTC will be
assumed.
– datetime.time will be interpreted as a specific time of day at which the job
should run. This could be either today or, if the time has already passed, tomorrow.
If the timezone (time.tzinfo) is None, UTC will be assumed.
If first is datetime.datetime or datetime.time type then first.
tzinfo will define Job.tzinfo. Otherwise UTC will be assumed.
Defaults to interval
• context (object, optional) – Additional data needed for the callback function.
Can be accessed through job.context in the callback. Defaults to None.
• name (str, optional) – The name of the new job. Defaults to callback.
__name__.
Returns The new Job instance that has been added to the job queue.
Return type telegram.ext.Job

Note: interval is always respected “as-is”. That means that if DST changes during that interval, the
job might not run at the time one would expect. It is always recommended to pin servers to UTC time,
then time related behaviour can always be expected.

set_dispatcher(dispatcher)
Set the dispatcher to be used by this JobQueue. Use this instead of passing a telegram.Bot to the
JobQueue, which is deprecated.
Parameters dispatcher (telegram.ext.Dispatcher) – The dispatcher.
start()
Starts the job_queue thread.
stop()
Stops the thread.

3.1. telegram.ext package 25

Python Telegram Bot Documentation, Release 12.8

tick()
Run all jobs that are due and re-enqueue them with their interval.

3.1.7 telegram.ext.MessageQueue

class telegram.ext.MessageQueue(all_burst_limit=30, all_time_limit_ms=1000,

group_burst_limit=20, group_time_limit_ms=60000,
exc_route=None, autostart=True)
Bases: object
Implements callback processing with proper delays to avoid hitting Telegram’s message limits. Contains
two DelayQueue, for group and for all messages, interconnected in delay chain. Callables are processed
through group DelayQueue, then through all DelayQueue for group-type messages. For non-group
messages, only the all DelayQueue is used.
Parameters
• all_burst_limit (int, optional) – Number of maximum all-type callbacks to
process per time-window defined by all_time_limit_ms. Defaults to 30.
• all_time_limit_ms (int, optional) – Defines width of all-type time-window used
when each processing limit is calculated. Defaults to 1000 ms.
• group_burst_limit (int, optional) – Number of maximum group-type callbacks
to process per time-window defined by group_time_limit_ms. Defaults to 20.
• group_time_limit_ms (int, optional) – Defines width of group-type time-
window used when each processing limit is calculated. Defaults to 60000 ms.
• exc_route (callable, optional) – A callable, accepting one positional argu-
ment; used to route exceptions from processor threads to main thread; is called on
Exception subclass exceptions. If not provided, exceptions are routed through
dummy handler, which re-raises them.
• autostart (bool, optional) – If True, processors are started immediately after ob-
ject’s creation; if False, should be started manually by start method. Defaults to
True.
__call__(promise, is_group_msg=False)
Processes callables in troughput-limiting queues to avoid hitting limits (specified with burst_limit
and time_limit.
Parameters
• promise (callable) – Mainly the telegram.utils.promise.Promise
(see Notes for other callables), that is processed in delay queues.
• is_group_msg (bool, optional) – Defines whether promise would be processed
in group*+*all* DelayQueue``s (if set to ``True), or only through all
DelayQueue (if set to False), resulting in needed delays to avoid hitting specified
limits. Defaults to False.

Note: Method is designed to accept telegram.utils.promise.Promise as promise argu-

ment, but other callables could be used too. For example, lambdas or simple functions could be used
to wrap original func to be called with needed args. In that case, be sure that either wrapper func does
not raise outside exceptions or the proper exc_route handler is provided.

Returns Used as promise argument.

Return type callable

26 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

__init__(all_burst_limit=30, all_time_limit_ms=1000, group_burst_limit=20,

group_time_limit_ms=60000, exc_route=None, autostart=True)
Initialize self. See help(type(self)) for accurate signature.
__weakref__
list of weak references to the object (if defined)
start()
Method is used to manually start the MessageQueue processing.
stop(timeout=None)
Used to gently stop processor and shutdown its thread.
Parameters timeout (float) – Indicates maximum time to wait for processor to stop
and its thread to exit. If timeout exceeds and processor has not stopped, method silently
returns. is_alive could be used afterwards to check the actual status. timeout set
to None, blocks until processor is shut down. Defaults to None.

3.1.8 telegram.ext.DelayQueue

class telegram.ext.DelayQueue(queue=None, burst_limit=30, time_limit_ms=1000,

exc_route=None, autostart=True, name=None)
Bases: threading.Thread
Processes callbacks from queue with specified throughput limits. Creates a separate thread to process call-
backs with delays.
burst_limit
Number of maximum callbacks to process per time-window.
Type int
time_limit
Defines width of time-window used when each processing limit is calculated.
Type int
exc_route
A callable, accepting 1 positional argument; used to route exceptions from processor thread to main
thread;
Type callable
name
Thread’s name.
Type str

Parameters
• queue (Queue, optional) – Used to pass callbacks to thread. Creates Queue implicitly
if not provided.
• burst_limit (int, optional) – Number of maximum callbacks to process per time-
window defined by time_limit_ms. Defaults to 30.
• time_limit_ms (int, optional) – Defines width of time-window used when each
processing limit is calculated. Defaults to 1000.
• exc_route (callable, optional) – A callable, accepting 1 positional argument;
used to route exceptions from processor thread to main thread; is called on Exception
subclass exceptions. If not provided, exceptions are routed through dummy handler,
which re-raises them.
• autostart (bool, optional) – If True, processor is started immediately after object’s
creation; if False, should be started manually by start method. Defaults to True.

3.1. telegram.ext package 27

Python Telegram Bot Documentation, Release 12.8

• name (str, optional) – Thread’s name. Defaults to 'DelayQueue-N', where N is

sequential number of object created.

__call__(func, *args, **kwargs)

Used to process callbacks in throughput-limiting thread through queue.
Parameters
• func (callable) – The actual function (or any callable) that is processed through
queue.
• *args (list) – Variable-length func arguments.
• **kwargs (dict) – Arbitrary keyword-arguments to func.
__init__(queue=None, burst_limit=30, time_limit_ms=1000, exc_route=None, autostart=True,
name=None)
This constructor should always be called with keyword arguments. Arguments are:
group should be None; reserved for future extension when a ThreadGroup class is implemented.
target is the callable object to be invoked by the run() method. Defaults to None, meaning nothing is
called.
name is the thread name. By default, a unique name is constructed of the form “Thread-N” where N
is a small decimal number.
args is the argument tuple for the target invocation. Defaults to ().
kwargs is a dictionary of keyword arguments for the target invocation. Defaults to {}.
If a subclass overrides the constructor, it must make sure to invoke the base class constructor
(Thread.__init__()) before doing anything else to the thread.
run()
Do not use the method except for unthreaded testing purposes, the method normally is automatically
called by autostart argument.
stop(timeout=None)
Used to gently stop processor and shutdown its thread.
Parameters timeout (float) – Indicates maximum time to wait for processor to stop
and its thread to exit. If timeout exceeds and processor has not stopped, method silently
returns. is_alive could be used afterwards to check the actual status. timeout set
to None, blocks until processor is shut down. Defaults to None.

3.1.9 telegram.ext.CallbackContext

class telegram.ext.CallbackContext(dispatcher)
This is a context object passed to the callback called by telegram.ext.Handler or by the
telegram.ext.Dispatcher in an error handler added by telegram.ext.Dispatcher.
add_error_handler or to the callback of a telegram.ext.Job.

Note: telegram.ext.Dispatcher will create a single context for an entire update. This means that
if you got 2 handlers in different groups and they both get called, they will get passed the same Callback-
Context object (of course with proper attributes like .matches differing). This allows you to add custom
attributes in a lower handler group callback, and then subsequently access those attributes in a higher han-
dler group callback. Note that the attributes on CallbackContext might change in the future, so make sure
to use a fairly unique name for the attributes.

28 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

Warning: Do not combine custom attributes and @run_async. Due to how @run_async works, it will
almost certainly execute the callbacks for an update out of order, and the attributes that you think you
added will not be present.

bot_data
Optional. A dict that can be used to keep any data in. For each update it will be the same dict.
Type dict
chat_data
Optional. A dict that can be used to keep any data in. For each update from the same chat id it will be
the same dict.

Warning: When a group chat migrates to a supergroup, its chat id will change and the
chat_data needs to be transferred. For details see our wiki page.

Type dict

user_data
Optional. A dict that can be used to keep any data in. For each update from the same user it will be
the same dict.
Type dict
matches
Optional. If the associated update originated from a regex-supported handler or had a Filters.
regex, this will contain a list of match objects for every pattern where re.search(pattern,
string) returned a match. Note that filters short circuit, so combined regex filters will not always
be evaluated.
Type List[re match object]
args
Optional. Arguments passed to a command if the associated update is handled by
telegram.ext.CommandHandler, telegram.ext.PrefixHandler or telegram.
ext.StringCommandHandler. It contains a list of the words in the text after the command,
using any whitespace string as a delimiter.
Type List[str]
error
Optional. The Telegram error that was raised. Only present when passed to a error handler registered
with telegram.ext.Dispatcher.add_error_handler.
Type telegram.TelegramError
job
The job that that originated this callback. Only present when passed to the callback of telegram.
ext.Job.
Type telegram.ext.Job
bot
The bot associated with this context.
Type telegram.Bot
dispatcher
The dispatcher associated with this context.
Type telegram.ext.Dispatcher

3.1. telegram.ext package 29

Python Telegram Bot Documentation, Release 12.8

job_queue
The JobQueue used by the telegram.ext.Dispatcher and (usually) the telegram.ext.
Updater associated with this context.
Type telegram.ext.JobQueue
match
The first match from matches. Useful if you are only filtering using a single regex filter. Returns
None if matches is empty.
Type Regex match type
update_queue
The Queue instance used by the telegram.ext.Dispatcher and (usually) the telegram.
ext.Updater associated with this context.
Type queue.Queue

3.1.10 telegram.ext.Defaults

class telegram.ext.Defaults(parse_mode=None, disable_notification=None,

disable_web_page_preview=None, time-
out=<telegram.utils.helpers.DefaultValue object>,
quote=None)
Bases: object
Convenience Class to gather all parameters with a (user defined) default value
parse_mode
Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width toxt
or URLs in your bot’s message.
Type str
disable_notification
Optional. Sends the message silently. Users will receive a notification with no sound.
Type bool
disable_web_page_preview
Optional. Disables link previews for links in this message.
Type bool
timeout
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).
Type int | float
quote
Optional. If set to True, the reply is sent as an actual reply to the message. If
reply_to_message_id is passed in kwargs, this parameter will be ignored. Default: True
in group chats and False in private chats.
Type bool

Parameters
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram apps
to show bold, italic, fixed-width toxt or URLs in your bot’s message.
• disable_notification (bool, optional) – Sends the message silently. Users
will receive a notification with no sound.
• disable_web_page_preview (bool, optional) – Disables link previews for links
in this message.

30 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• 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).
• quote (bool, opitonal) – If set to True, the reply is sent as an actual reply to the
message. If reply_to_message_id is passed in kwargs, this parameter will be
ignored. Default: True in group chats and False in private chats.

3.1.11 Handlers

telegram.ext.Handler

class telegram.ext.Handler(callback, pass_update_queue=False, pass_job_queue=False,

pass_user_data=False, pass_chat_data=False)
Bases: abc.ABC
The base class for all update handlers. Create custom handlers by inheriting from it.
callback
The callback function for this handler.
Type callable
pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool
pass_user_data
Determines whether user_data will be passed to the callback function.
Type bool
pass_chat_data
Determines whether chat_data will be passed to the callback function.
Type bool

Note: pass_user_data and pass_chat_data determine whether a dict you can use to keep any
data in will be sent to the callback function. Related to either the user or the chat that the update was
sent in. For each update from the same user or in the same chat, it will be the same dict.
Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for
more info.

Parameters
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that

3.1. telegram.ext package 31

Python Telegram Bot Documentation, Release 12.8

contains new updates which can be used to insert updates. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_job_queue (bool, optional) – If set to True, a keyword argument called
job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False. DEPRECATED: Please switch to context based
callbacks.
• pass_user_data (bool, optional) – If set to True, a keyword argument called
user_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_chat_data (bool, optional) – If set to True, a keyword argument called
chat_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.

check_update(update)
This method is called to determine if an update should be handled by this handler instance. It should
always be overridden.
Parameters update (str | telegram.Update) – The update to be tested.
Returns Either None or False if the update should not be handled. Otherwise an object
that will be passed to handle_update and collect_additional_context
when the update gets handled.
collect_additional_context(context, update, dispatcher, check_result)
Prepares additional arguments for the context. Override if needed.
Parameters
• context (telegram.ext.CallbackContext) – The context object.
• update (telegram.Update) – The update to gather chat/user id from.
• dispatcher (telegram.ext.Dispatcher) – The calling dispatcher.
• check_result – The result (return value) from check_update.
collect_optional_args(dispatcher, update=None, check_result=None)
Prepares the optional arguments. If the handler has additional optional args, it should subclass this
method, but remember to call this super method.
DEPRECATED: This method is being replaced by new context based callbacks. Please see https:
//git.io/fxJuV for more info.
Parameters
• dispatcher (telegram.ext.Dispatcher) – The dispatcher.
• update (telegram.Update) – The update to gather chat/user id from.
• check_result – The result from check_update
handle_update(update, dispatcher, check_result, context=None)
This method is called if it was determined that an update should indeed be handled by this instance.
Calls self.callback along with its respectful arguments. To work with the telegram.ext.
ConversationHandler, this method returns the value returned from self.callback. Note
that it can be overridden if needed by the subclassing handler.
Parameters
• update (str | telegram.Update) – The update to be handled.
• dispatcher (telegram.ext.Dispatcher) – The calling dispatcher.
• check_result – The result from check_update.

32 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

telegram.ext.CallbackQueryHandler

class telegram.ext.CallbackQueryHandler(callback, pass_update_queue=False,

pass_job_queue=False, pat-
tern=None, pass_groups=False,
pass_groupdict=False, pass_user_data=False,
pass_chat_data=False)
Bases: telegram.ext.handler.Handler
Handler class to handle Telegram callback queries. Optionally based on a regex.
Read the documentation of the re module for more information.
callback
The callback function for this handler.
Type callable
pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool
pattern
Optional. Regex pattern to test telegram.CallbackQuery.data against.
Type str | Pattern
pass_groups
Determines whether groups will be passed to the callback function.
Type bool
pass_groupdict
Determines whether groupdict. will be passed to the callback function.
Type bool
pass_user_data
Determines whether user_data will be passed to the callback function.
Type bool
pass_chat_data
Determines whether chat_data will be passed to the callback function.
Type bool

Note: pass_user_data and pass_chat_data determine whether a dict you can use to keep any
data in will be sent to the callback function. Related to either the user or the chat that the update was
sent in. For each update from the same user or in the same chat, it will be the same dict.
Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for
more info.

Parameters
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:

3.1. telegram.ext package 33

Python Telegram Bot Documentation, Release 12.8

def callback(update: Update, context:

CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that
contains new updates which can be used to insert updates. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_job_queue (bool, optional) – If set to True, a keyword argument called
job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False. DEPRECATED: Please switch to context based
callbacks.
• pattern (str | Pattern, optional) – Regex pattern. If not None, re.match is used
on telegram.CallbackQuery.data to determine if an update should be handled
by this handler.
• pass_groups (bool, optional) – If the callback should be passed the result of re.
match(pattern, data).groups() as a keyword argument called groups.
Default is False DEPRECATED: Please switch to context based callbacks.
• pass_groupdict (bool, optional) – If the callback should be passed the result
of re.match(pattern, data).groupdict() as a keyword argument called
groupdict. Default is False DEPRECATED: Please switch to context based call-
backs.
• pass_user_data (bool, optional) – If set to True, a keyword argument called
user_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_chat_data (bool, optional) – If set to True, a keyword argument called
chat_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (telegram.Update) – Incoming telegram update.
Returns bool
collect_additional_context(context, update, dispatcher, check_result)
Prepares additional arguments for the context. Override if needed.
Parameters
• context (telegram.ext.CallbackContext) – The context object.
• update (telegram.Update) – The update to gather chat/user id from.
• dispatcher (telegram.ext.Dispatcher) – The calling dispatcher.
• check_result – The result (return value) from check_update.
collect_optional_args(dispatcher, update=None, check_result=None)
Prepares the optional arguments. If the handler has additional optional args, it should subclass this
method, but remember to call this super method.
DEPRECATED: This method is being replaced by new context based callbacks. Please see https:
//git.io/fxJuV for more info.
Parameters

34 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• dispatcher (telegram.ext.Dispatcher) – The dispatcher.

• update (telegram.Update) – The update to gather chat/user id from.
• check_result – The result from check_update

telegram.ext.ChosenInlineResultHandler

class telegram.ext.ChosenInlineResultHandler(callback, pass_update_queue=False,

pass_job_queue=False,
pass_user_data=False,
pass_chat_data=False)
Bases: telegram.ext.handler.Handler
Handler class to handle Telegram updates that contain a chosen inline result.
callback
The callback function for this handler.
Type callable
pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool
pass_user_data
Determines whether user_data will be passed to the callback function.
Type bool
pass_chat_data
Determines whether chat_data will be passed to the callback function.
Type bool

Note: pass_user_data and pass_chat_data determine whether a dict you can use to keep any
data in will be sent to the callback function. Related to either the user or the chat that the update was
sent in. For each update from the same user or in the same chat, it will be the same dict.
Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for
more info.

Parameters
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that
contains new updates which can be used to insert updates. Default is False. DEPRE-
CATED: Please switch to context based callbacks.

3.1. telegram.ext package 35

Python Telegram Bot Documentation, Release 12.8

• pass_job_queue (bool, optional) – If set to True, a keyword argument called

job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False. DEPRECATED: Please switch to context based
callbacks.
• pass_user_data (bool, optional) – If set to True, a keyword argument called
user_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_chat_data (bool, optional) – If set to True, a keyword argument called
chat_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (telegram.Update) – Incoming telegram update.
Returns bool

telegram.ext.ConversationHandler

class telegram.ext.ConversationHandler(entry_points, states, fallbacks, al-

low_reentry=False, per_chat=True,
per_user=True, per_message=False, con-
versation_timeout=None, name=None, persis-
tent=False, map_to_parent=None)
Bases: telegram.ext.handler.Handler
A handler to hold a conversation with a single user by managing four collections of other handlers.
The first collection, a list named entry_points, is used to initiate the conversation, for example with
a telegram.ext.CommandHandler or telegram.ext.RegexHandler.
The second collection, a dict named states, contains the different conversation steps and one or more
associated handlers that should be used if the user sends a message when the conversation with them
is currently in that state. Here you can also define a state for TIMEOUT to define the behavior when
conversation_timeout is exceeded, and a state for WAITING to define behavior when a new update
is received while the previous @run_async decorated handler is not finished.
The third collection, a list named fallbacks, is used if the user is currently in a conversation but the
state has either no associated handler or the handler that is associated to the state is inappropriate for the
update, for example if the update contains a command, but a regular text message is expected. You could
use this for a /cancel command or to let the user know their message was not recognized.
To change the state of conversation, the callback function of a handler must return the new state after
responding to the user. If it does not return anything (returning None by default), the state will not change.
If an entry point callback function returns None, the conversation ends immediately after the execution of
this callback function. To end the conversation, the callback function must return END or -1. To handle the
conversation timeout, use handler TIMEOUT or -2.

Note: In each of the described collections of handlers, a handler may in turn be a

ConversationHandler. In that case, the nested ConversationHandler should have the attribute
map_to_parent which allows to return to the parent conversation at specified states within the nested
conversation.
Note that the keys in map_to_parent must not appear as keys in states attribute or else the latter will
be ignored. You may map END to one of the parents states to continue the parent conversation after this
has ended or even map a state to END to end the parent conversation from within the nested one. For an
example on nested ConversationHandler s, see our examples.

36 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

entry_points
A list of Handler objects that can trigger the start of the conversation.
Type List[telegram.ext.Handler]
states
A dict that defines the different states of conversation a user can be in and one or more associated
Handler objects that should be used in that state.
Type Dict[object, List[telegram.ext.Handler]]
fallbacks
A list of handlers that might be used if the user is in a conversation, but every handler for their current
state returned False on check_update.
Type List[telegram.ext.Handler]
allow_reentry
Determines if a user can restart a conversation with an entry point.
Type bool
per_chat
If the conversationkey should contain the Chat’s ID.
Type bool
per_user
If the conversationkey should contain the User’s ID.
Type bool
per_message
If the conversationkey should contain the Message’s ID.
Type bool
conversation_timeout
Optional. When this handler is inactive more than this timeout (in seconds), it will be automatically
ended. If this value is 0 (default), there will be no timeout. When it’s triggered, the last received update
and the corresponding context will be handled by ALL the handler’s who’s check_update method
returns True that are in the state ConversationHandler.TIMEOUT.
Type float | datetime.timedelta
name
Optional. The name for this conversationhandler. Required for persistence
Type str
persistent
Optional. If the conversations dict for this handler should be saved. Name is required and persistence
has to be set in telegram.ext.Updater
Type bool
map_to_parent
Optional. A dict that can be used to instruct a nested conversationhandler to transition into a mapped
state on its parent conversationhandler in place of a specified nested state.
Type Dict[object, object]

Parameters
• entry_points (List[telegram.ext.Handler]) – A list of Handler objects
that can trigger the start of the conversation. The first handler which check_update
method returns True will be used. If all return False, the update is not handled.

3.1. telegram.ext package 37

Python Telegram Bot Documentation, Release 12.8

• states (Dict[object, List[telegram.ext.Handler]]) – A dict that de-

fines the different states of conversation a user can be in and one or more associ-
ated Handler objects that should be used in that state. The first handler which
check_update method returns True will be used.
• fallbacks (List[telegram.ext.Handler]) – A list of handlers that might be
used if the user is in a conversation, but every handler for their current state returned
False on check_update. The first handler which check_update method returns
True will be used. If all return False, the update is not handled.
• allow_reentry (bool, optional) – If set to True, a user that is currently in a
conversation can restart the conversation by triggering one of the entry points.
• per_chat (bool, optional) – If the conversationkey should contain the Chat’s ID.
Default is True.
• per_user (bool, optional) – If the conversationkey should contain the User’s ID.
Default is True.
• per_message (bool, optional) – If the conversationkey should contain the Mes-
sage’s ID. Default is False.
• conversation_timeout (float | datetime.timedelta, optional) – When
this handler is inactive more than this timeout (in seconds), it will be automatically
ended. If this value is 0 or None (default), there will be no timeout. The last received
update and the corresponding context will be handled by ALL the handler’s who’s
check_update method returns True that are in the state ConversationHandler.
TIMEOUT.
• name (str, optional) – The name for this conversationhandler. Required for persis-
tence
• persistent (bool, optional) – If the conversations dict for this handler should be
saved. Name is required and persistence has to be set in telegram.ext.Updater
• map_to_parent (Dict[object, object], optional) – A dict that can be used
to instruct a nested conversationhandler to transition into a mapped state on its parent
conversationhandler in place of a specified nested state.
Raises ValueError

END = -1
Used as a constant to return when a conversation is ended.
Type int
TIMEOUT = -2
Used as a constant to handle state when a conversation is timed out.
Type int
WAITING = -3
Used as a constant to handle state when a conversation is still waiting on the previous @run_sync
decorated running handler to finish.
Type int
check_update(update)
Determines whether an update should be handled by this conversationhandler, and if so in which state
the conversation currently is.
Parameters update (telegram.Update) – Incoming telegram update.
Returns bool
handle_update(update, dispatcher, check_result, context=None)
Send the update to the callback for the current state and Handler

38 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

Parameters
• check_result – The result from check_update. For this handler it’s a tuple of key,
handler, and the handler’s check result.
• update (telegram.Update) – Incoming telegram update.
• dispatcher (telegram.ext.Dispatcher) – Dispatcher that originated the
Update.

telegram.ext.CommandHandler

class telegram.ext.CommandHandler(command, callback, filters=None, allow_edited=None,

pass_args=False, pass_update_queue=False,
pass_job_queue=False, pass_user_data=False,
pass_chat_data=False)
Bases: telegram.ext.handler.Handler
Handler class to handle Telegram commands.
Commands are Telegram messages that start with /, optionally followed by an @ and the bot’s name
and/or some additional text. The handler will add a list to the CallbackContext named
CallbackContext.args. It will contain a list of strings, which is the text following the command
split on single or consecutive whitespace characters.
By default the handler listens to messages as well as edited messages. To change this behavior use
~Filters.update.edited_message in the filter argument.
command
The command or list of commands this handler should listen for. Limitations are the same as described
here https://core.telegram.org/bots#commands
Type str | List[str]
callback
The callback function for this handler.
Type callable
filters
Optional. Only allow updates with these Filters.
Type telegram.ext.BaseFilter
allow_edited
Determines Whether the handler should also accept edited messages.
Type bool
pass_args
Determines whether the handler should be passed args.
Type bool
pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool
pass_user_data
Determines whether user_data will be passed to the callback function.
Type bool

3.1. telegram.ext package 39

Python Telegram Bot Documentation, Release 12.8

pass_chat_data
Determines whether chat_data will be passed to the callback function.
Type bool

Note: pass_user_data and pass_chat_data determine whether a dict you can use to keep any
data in will be sent to the callback function. Related to either the user or the chat that the update was
sent in. For each update from the same user or in the same chat, it will be the same dict.
Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for
more info.

Parameters
• command (str | List[str]) – The command or list of commands this handler should
listen for. Limitations are the same as described here https://core.telegram.org/bots#
commands
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• filters (telegram.ext.BaseFilter, optional) – A filter inheriting from
telegram.ext.filters.BaseFilter. Standard filters can be found in
telegram.ext.filters.Filters. Filters can be combined using bitwise op-
erators (& for and, | for or, ~ for not).
• allow_edited (bool, optional) – Determines whether the handler should also ac-
cept edited messages. Default is False. DEPRECATED: Edited is allowed by default.
To change this behavior use ~Filters.update.edited_message.
• pass_args (bool, optional) – Determines whether the handler should be passed the
arguments passed to the command as a keyword argument called args. It will contain
a list of strings, which is the text following the command split on single or consecutive
whitespace characters. Default is False DEPRECATED: Please switch to context
based callbacks.
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that
contains new updates which can be used to insert updates. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_job_queue (bool, optional) – If set to True, a keyword argument called
job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False. DEPRECATED: Please switch to context based
callbacks.
• pass_user_data (bool, optional) – If set to True, a keyword argument called
user_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_chat_data (bool, optional) – If set to True, a keyword argument called
chat_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
Raises ValueError - when command is too long or has illegal chars.

40 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (telegram.Update) – Incoming telegram update.
Returns The list of args for the handler
Return type list
collect_additional_context(context, update, dispatcher, check_result)
Prepares additional arguments for the context. Override if needed.
Parameters
• context (telegram.ext.CallbackContext) – The context object.
• update (telegram.Update) – The update to gather chat/user id from.
• dispatcher (telegram.ext.Dispatcher) – The calling dispatcher.
• check_result – The result (return value) from check_update.
collect_optional_args(dispatcher, update=None, check_result=None)
Prepares the optional arguments. If the handler has additional optional args, it should subclass this
method, but remember to call this super method.
DEPRECATED: This method is being replaced by new context based callbacks. Please see https:
//git.io/fxJuV for more info.
Parameters
• dispatcher (telegram.ext.Dispatcher) – The dispatcher.
• update (telegram.Update) – The update to gather chat/user id from.
• check_result – The result from check_update

telegram.ext.InlineQueryHandler

class telegram.ext.InlineQueryHandler(callback, pass_update_queue=False,

pass_job_queue=False, pattern=None,
pass_groups=False, pass_groupdict=False,
pass_user_data=False, pass_chat_data=False)
Bases: telegram.ext.handler.Handler
Handler class to handle Telegram inline queries. Optionally based on a regex. Read the documentation of
the re module for more information.
callback
The callback function for this handler.
Type callable
pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool
pattern
Optional. Regex pattern to test telegram.InlineQuery.query against.
Type str | Pattern
pass_groups
Determines whether groups will be passed to the callback function.

3.1. telegram.ext package 41

Python Telegram Bot Documentation, Release 12.8

Type bool
pass_groupdict
Determines whether groupdict. will be passed to the callback function.
Type bool
pass_user_data
Determines whether user_data will be passed to the callback function.
Type bool
pass_chat_data
Determines whether chat_data will be passed to the callback function.
Type bool

Note: pass_user_data and pass_chat_data determine whether a dict you can use to keep any
data in will be sent to the callback function. Related to either the user or the chat that the update was
sent in. For each update from the same user or in the same chat, it will be the same dict.
Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for
more info.

Parameters
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that
contains new updates which can be used to insert updates. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_job_queue (bool, optional) – If set to True, a keyword argument called
job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False. DEPRECATED: Please switch to context based
callbacks.
• pattern (str | Pattern, optional) – Regex pattern. If not None, re.match
is used on telegram.InlineQuery.query to determine if an update should be
handled by this handler.
• pass_groups (bool, optional) – If the callback should be passed the result of re.
match(pattern, data).groups() as a keyword argument called groups.
Default is False DEPRECATED: Please switch to context based callbacks.
• pass_groupdict (bool, optional) – If the callback should be passed the result
of re.match(pattern, data).groupdict() as a keyword argument called
groupdict. Default is False DEPRECATED: Please switch to context based call-
backs.
• pass_user_data (bool, optional) – If set to True, a keyword argument called
user_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.

42 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• pass_chat_data (bool, optional) – If set to True, a keyword argument called

chat_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (telegram.Update) – Incoming telegram update.
Returns bool
collect_additional_context(context, update, dispatcher, check_result)
Prepares additional arguments for the context. Override if needed.
Parameters
• context (telegram.ext.CallbackContext) – The context object.
• update (telegram.Update) – The update to gather chat/user id from.
• dispatcher (telegram.ext.Dispatcher) – The calling dispatcher.
• check_result – The result (return value) from check_update.
collect_optional_args(dispatcher, update=None, check_result=None)
Prepares the optional arguments. If the handler has additional optional args, it should subclass this
method, but remember to call this super method.
DEPRECATED: This method is being replaced by new context based callbacks. Please see https:
//git.io/fxJuV for more info.
Parameters
• dispatcher (telegram.ext.Dispatcher) – The dispatcher.
• update (telegram.Update) – The update to gather chat/user id from.
• check_result – The result from check_update

telegram.ext.MessageHandler

class telegram.ext.MessageHandler(filters, callback, pass_update_queue=False,

pass_job_queue=False, pass_user_data=False,
pass_chat_data=False, message_updates=None,
channel_post_updates=None, edited_updates=None)
Bases: telegram.ext.handler.Handler
Handler class to handle telegram messages. They might contain text, media or status updates.
filters
Only allow updates with these Filters. See telegram.ext.filters for a full list of all available
filters.
Type Filter
callback
The callback function for this handler.
Type callable
pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool

3.1. telegram.ext package 43

Python Telegram Bot Documentation, Release 12.8

pass_user_data
Determines whether user_data will be passed to the callback function.
Type bool
pass_chat_data
Determines whether chat_data will be passed to the callback function.
Type bool
message_updates
Should “normal” message updates be handled? Default is None.
Type bool
channel_post_updates
Should channel posts updates be handled? Default is None.
Type bool
edited_updates
Should “edited” message updates be handled? Default is None.
Type bool

Note: pass_user_data and pass_chat_data determine whether a dict you can use to keep any
data in will be sent to the callback function. Related to either the user or the chat that the update was
sent in. For each update from the same user or in the same chat, it will be the same dict.
Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for
more info.

Parameters
• filters (telegram.ext.BaseFilter, optional) – A filter inheriting from
telegram.ext.filters.BaseFilter. Standard filters can be found in
telegram.ext.filters.Filters. Filters can be combined using bitwise op-
erators (& for and, | for or, ~ for not). Default is telegram.ext.filters.
Filters.update. This defaults to all message_type updates being: message,
edited_message, channel_post and edited_channel_post. If you don’t
want or need any of those pass ~Filters.update.* in the filter argument.
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that
contains new updates which can be used to insert updates. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_job_queue (bool, optional) – If set to True, a keyword argument called
job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False. DEPRECATED: Please switch to context based
callbacks.

44 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• pass_user_data (bool, optional) – If set to True, a keyword argument called

user_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_chat_data (bool, optional) – If set to True, a keyword argument called
chat_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• message_updates (bool, optional) – Should “normal” message updates be han-
dled? Default is None. DEPRECATED: Please switch to filters for update filtering.
• channel_post_updates (bool, optional) – Should channel posts updates be han-
dled? Default is None. DEPRECATED: Please switch to filters for update filtering.
• edited_updates (bool, optional) – Should “edited” message updates be handled?
Default is None. DEPRECATED: Please switch to filters for update filtering.
Raises ValueError

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (telegram.Update) – Incoming telegram update.
Returns bool
collect_additional_context(context, update, dispatcher, check_result)
Prepares additional arguments for the context. Override if needed.
Parameters
• context (telegram.ext.CallbackContext) – The context object.
• update (telegram.Update) – The update to gather chat/user id from.
• dispatcher (telegram.ext.Dispatcher) – The calling dispatcher.
• check_result – The result (return value) from check_update.

telegram.ext.PollAnswerHandler

class telegram.ext.PollAnswerHandler(callback, pass_update_queue=False,

pass_job_queue=False, pass_user_data=False,
pass_chat_data=False)
Bases: telegram.ext.handler.Handler
Handler class to handle Telegram updates that contain a poll answer.
callback
The callback function for this handler.
Type callable
pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool
pass_user_data
Determines whether user_data will be passed to the callback function.
Type bool

3.1. telegram.ext package 45

Python Telegram Bot Documentation, Release 12.8

pass_chat_data
Determines whether chat_data will be passed to the callback function.
Type bool

Note: pass_user_data and pass_chat_data determine whether a dict you can use to keep any
data in will be sent to the callback function. Related to either the user or the chat that the update was
sent in. For each update from the same user or in the same chat, it will be the same dict.
Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for
more info.

Parameters
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that
contains new updates which can be used to insert updates. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_job_queue (bool, optional) – If set to True, a keyword argument called
job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False. DEPRECATED: Please switch to context based
callbacks.
• pass_user_data (bool, optional) – If set to True, a keyword argument called
user_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_chat_data (bool, optional) – If set to True, a keyword argument called
chat_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (telegram.Update) – Incoming telegram update.
Returns bool

telegram.ext.PollHandler

class telegram.ext.PollHandler(callback, pass_update_queue=False,

pass_job_queue=False, pass_user_data=False,
pass_chat_data=False)
Bases: telegram.ext.handler.Handler
Handler class to handle Telegram updates that contain a poll.
callback
The callback function for this handler.
Type callable

46 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool
pass_user_data
Determines whether user_data will be passed to the callback function.
Type bool
pass_chat_data
Determines whether chat_data will be passed to the callback function.
Type bool

Note: pass_user_data and pass_chat_data determine whether a dict you can use to keep any
data in will be sent to the callback function. Related to either the user or the chat that the update was
sent in. For each update from the same user or in the same chat, it will be the same dict.
Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for
more info.

Parameters
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that
contains new updates which can be used to insert updates. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_job_queue (bool, optional) – If set to True, a keyword argument called
job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False. DEPRECATED: Please switch to context based
callbacks.
• pass_user_data (bool, optional) – If set to True, a keyword argument called
user_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_chat_data (bool, optional) – If set to True, a keyword argument called
chat_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (telegram.Update) – Incoming telegram update.
Returns bool

3.1. telegram.ext package 47

Python Telegram Bot Documentation, Release 12.8

telegram.ext.PreCheckoutQueryHandler

class telegram.ext.PreCheckoutQueryHandler(callback, pass_update_queue=False,

pass_job_queue=False,
pass_user_data=False,
pass_chat_data=False)
Bases: telegram.ext.handler.Handler
Handler class to handle Telegram PreCheckout callback queries.
callback
The callback function for this handler.
Type callable
pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool
pass_user_data
Determines whether user_data will be passed to the callback function.
Type bool
pass_chat_data
Determines whether chat_data will be passed to the callback function.
Type bool

Note: pass_user_data and pass_chat_data determine whether a dict you can use to keep any
data in will be sent to the callback function. Related to either the user or the chat that the update was
sent in. For each update from the same user or in the same chat, it will be the same dict.
Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for
more info.

Parameters
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• pass_update_queue (bool, optional) – If set to True, a keyword argument
called update_queue will be passed to the callback function. It will be the Queue
DEPRECATED: Please switch to context based callbacks. instance used by the
telegram.ext.Updater and telegram.ext.Dispatcher that contains new
updates which can be used to insert updates. Default is False.
• pass_job_queue (bool, optional) – If set to True, a keyword argument called
job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False. DEPRECATED: Please switch to context based
callbacks.

48 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• pass_user_data (bool, optional) – If set to True, a keyword argument called

user_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_chat_data (bool, optional) – If set to True, a keyword argument called
chat_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (telegram.Update) – Incoming telegram update.
Returns bool

telegram.ext.PrefixHandler

class telegram.ext.PrefixHandler(prefix, command, callback, filters=None,

pass_args=False, pass_update_queue=False,
pass_job_queue=False, pass_user_data=False,
pass_chat_data=False)
Bases: telegram.ext.commandhandler.CommandHandler
Handler class to handle custom prefix commands
This is a intermediate handler between MessageHandler and CommandHandler. It supports con-
figurable commands with the same options as CommandHandler. It will respond to every combination of
prefix and command. It will add a list to the CallbackContext named CallbackContext.
args. It will contain a list of strings, which is the text following the command split on single or consecutive
whitespace characters.
Examples:

Single prefix and command:

PrefixHandler('!', 'test', callback) will respond to '!test'.

Multiple prefixes, single command:

PrefixHandler(['!', '#'], 'test', callback) will respond to '!test' and

'#test'.

Miltiple prefixes and commands:

PrefixHandler(['!', '#'], ['test', 'help`], callback) will respond to '!

˓→test',
'#test', '!help' and '#help'.

By default the handler listens to messages as well as edited messages. To change this behavior use ~‘‘Fil-
ters.update.edited_message‘‘.
prefix
The prefix(es) that will precede command.
Type str | List[str]
command
The command or list of commands this handler should listen for.
Type str | List[str]
callback
The callback function for this handler.
Type callable

3.1. telegram.ext package 49

Python Telegram Bot Documentation, Release 12.8

filters
Optional. Only allow updates with these Filters.
Type telegram.ext.BaseFilter
pass_args
Determines whether the handler should be passed args.
Type bool
pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool
pass_user_data
Determines whether user_data will be passed to the callback function.
Type bool
pass_chat_data
Determines whether chat_data will be passed to the callback function.
Type bool

Note: pass_user_data and pass_chat_data determine whether a dict you can use to keep any
data in will be sent to the callback function. Related to either the user or the chat that the update was
sent in. For each update from the same user or in the same chat, it will be the same dict.
Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for
more info.

Parameters
• prefix (str | List[str]) – The prefix(es) that will precede command.
• command (str | List[str]) – The command or list of commands this handler should
listen for.
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• filters (telegram.ext.BaseFilter, optional) – A filter inheriting from
telegram.ext.filters.BaseFilter. Standard filters can be found in
telegram.ext.filters.Filters. Filters can be combined using bitwise op-
erators (& for and, | for or, ~ for not).
• pass_args (bool, optional) – Determines whether the handler should be passed the
arguments passed to the command as a keyword argument called args. It will contain
a list of strings, which is the text following the command split on single or consecutive
whitespace characters. Default is False DEPRECATED: Please switch to context
based callbacks.
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that

50 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

contains new updates which can be used to insert updates. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_job_queue (bool, optional) – If set to True, a keyword argument called
job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False. DEPRECATED: Please switch to context based
callbacks.
• pass_user_data (bool, optional) – If set to True, a keyword argument called
user_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_chat_data (bool, optional) – If set to True, a keyword argument called
chat_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (telegram.Update) – Incoming telegram update.
Returns The list of args for the handler
Return type list
collect_additional_context(context, update, dispatcher, check_result)
Prepares additional arguments for the context. Override if needed.
Parameters
• context (telegram.ext.CallbackContext) – The context object.
• update (telegram.Update) – The update to gather chat/user id from.
• dispatcher (telegram.ext.Dispatcher) – The calling dispatcher.
• check_result – The result (return value) from check_update.

telegram.ext.RegexHandler

class telegram.ext.RegexHandler(pattern, callback, pass_groups=False,

pass_groupdict=False, pass_update_queue=False,
pass_job_queue=False, pass_user_data=False,
pass_chat_data=False, allow_edited=False, mes-
sage_updates=True, channel_post_updates=False,
edited_updates=False)
Bases: telegram.ext.messagehandler.MessageHandler
Handler class to handle Telegram updates based on a regex.
It uses a regular expression to check text messages. Read the documentation of the re module for more
information. The re.match function is used to determine if an update should be handled by this handler.
pattern
The regex pattern.
Type str | Pattern
callback
The callback function for this handler.
Type callable
pass_groups
Determines whether groups will be passed to the callback function.
Type bool

3.1. telegram.ext package 51

Python Telegram Bot Documentation, Release 12.8

pass_groupdict
Determines whether groupdict. will be passed to the callback function.
Type bool
pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool
pass_user_data
Determines whether user_data will be passed to the callback function.
Type bool
pass_chat_data
Determines whether chat_data will be passed to the callback function.
Type bool

Note: This handler is being deprecated. For the same usecase use: MessageHandler(Filters.
regex(r'pattern'), callback)

Parameters
• pattern (str | Pattern) – The regex pattern.
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• pass_groups (bool, optional) – If the callback should be passed the result of re.
match(pattern, data).groups() as a keyword argument called groups.
Default is False
• pass_groupdict (bool, optional) – If the callback should be passed the result
of re.match(pattern, data).groupdict() as a keyword argument called
groupdict. Default is False
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that
contains new updates which can be used to insert updates. Default is False.
• pass_job_queue (bool, optional) – If set to True, a keyword argument called
job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False.
• pass_user_data (bool, optional) – If set to True, a keyword argument called
user_data will be passed to the callback function. Default is False.
• pass_chat_data (bool, optional) – If set to True, a keyword argument called
chat_data will be passed to the callback function. Default is False.
• message_updates (bool, optional) – Should “normal” message updates be han-
dled? Default is True.

52 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• channel_post_updates (bool, optional) – Should channel posts updates be han-

dled? Default is True.
• edited_updates (bool, optional) – Should “edited” message updates be handled?
Default is False.
Raises ValueError

collect_optional_args(dispatcher, update=None, check_result=None)

Prepares the optional arguments. If the handler has additional optional args, it should subclass this
method, but remember to call this super method.
DEPRECATED: This method is being replaced by new context based callbacks. Please see https:
//git.io/fxJuV for more info.
Parameters
• dispatcher (telegram.ext.Dispatcher) – The dispatcher.
• update (telegram.Update) – The update to gather chat/user id from.
• check_result – The result from check_update

telegram.ext.ShippingQueryHandler

class telegram.ext.ShippingQueryHandler(callback, pass_update_queue=False,

pass_job_queue=False,
pass_user_data=False,
pass_chat_data=False)
Bases: telegram.ext.handler.Handler
Handler class to handle Telegram shipping callback queries.
callback
The callback function for this handler.
Type callable
pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool
pass_user_data
Determines whether user_data will be passed to the callback function.
Type bool
pass_chat_data
Determines whether chat_data will be passed to the callback function.
Type bool

Note: pass_user_data and pass_chat_data determine whether a dict you can use to keep any
data in will be sent to the callback function. Related to either the user or the chat that the update was
sent in. For each update from the same user or in the same chat, it will be the same dict.
Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for
more info.

Parameters

3.1. telegram.ext package 53

Python Telegram Bot Documentation, Release 12.8

• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that
contains new updates which can be used to insert updates. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_job_queue (bool, optional) – If set to True, a keyword argument called
job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False. DEPRECATED: Please switch to context based
callbacks.
• pass_user_data (bool, optional) – If set to True, a keyword argument called
user_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_chat_data (bool, optional) – If set to True, a keyword argument called
chat_data will be passed to the callback function. Default is False. DEPRE-
CATED: Please switch to context based callbacks.

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (telegram.Update) – Incoming telegram update.
Returns bool

telegram.ext.StringCommandHandler

class telegram.ext.StringCommandHandler(command, callback, pass_args=False,

pass_update_queue=False,
pass_job_queue=False)
Bases: telegram.ext.handler.Handler
Handler class to handle string commands. Commands are string updates that start with /.

Note: This handler is not used to handle Telegram telegram.Update, but strings manually put in the
queue. For example to send messages with the bot using command line or API.

command
The command this handler should listen for.
Type str
callback
The callback function for this handler.
Type callable
pass_args
Determines whether the handler should be passed args.
Type bool

54 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool

Parameters
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• pass_args (bool, optional) – Determines whether the handler should be passed the
arguments passed to the command as a keyword argument called args. It will contain
a list of strings, which is the text following the command split on single or consecutive
whitespace characters. Default is False DEPRECATED: Please switch to context
based callbacks.
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that
contains new updates which can be used to insert updates. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_job_queue (bool, optional) – If set to True, a keyword argument
called job_queue will be passed to the callback function. It will be a
class:telegram.ext.JobQueue instance created by the telegram.ext.Updater
which can be used to schedule new jobs. Default is False. DEPRECATED: Please
switch to context based callbacks.

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (str) – An incoming command.
Returns bool
collect_additional_context(context, update, dispatcher, check_result)
Prepares additional arguments for the context. Override if needed.
Parameters
• context (telegram.ext.CallbackContext) – The context object.
• update (telegram.Update) – The update to gather chat/user id from.
• dispatcher (telegram.ext.Dispatcher) – The calling dispatcher.
• check_result – The result (return value) from check_update.
collect_optional_args(dispatcher, update=None, check_result=None)
Prepares the optional arguments. If the handler has additional optional args, it should subclass this
method, but remember to call this super method.
DEPRECATED: This method is being replaced by new context based callbacks. Please see https:
//git.io/fxJuV for more info.
Parameters
• dispatcher (telegram.ext.Dispatcher) – The dispatcher.

3.1. telegram.ext package 55

Python Telegram Bot Documentation, Release 12.8

• update (telegram.Update) – The update to gather chat/user id from.

• check_result – The result from check_update

telegram.ext.StringRegexHandler

class telegram.ext.StringRegexHandler(pattern, callback, pass_groups=False,

pass_groupdict=False,
pass_update_queue=False,
pass_job_queue=False)
Bases: telegram.ext.handler.Handler
Handler class to handle string updates based on a regex which checks the update content.
Read the documentation of the re module for more information. The re.match function is used to
determine if an update should be handled by this handler.

Note: This handler is not used to handle Telegram telegram.Update, but strings manually put in the
queue. For example to send messages with the bot using command line or API.

pattern
The regex pattern.
Type str | Pattern
callback
The callback function for this handler.
Type callable
pass_groups
Determines whether groups will be passed to the callback function.
Type bool
pass_groupdict
Determines whether groupdict. will be passed to the callback function.
Type bool
pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool

Parameters
• pattern (str | Pattern) – The regex pattern.
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• pass_groups (bool, optional) – If the callback should be passed the result of re.
match(pattern, data).groups() as a keyword argument called groups.
Default is False DEPRECATED: Please switch to context based callbacks.

56 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• pass_groupdict (bool, optional) – If the callback should be passed the result

of re.match(pattern, data).groupdict() as a keyword argument called
groupdict. Default is False DEPRECATED: Please switch to context based call-
backs.
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that
contains new updates which can be used to insert updates. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_job_queue (bool, optional) – If set to True, a keyword argument called
job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False. DEPRECATED: Please switch to context based
callbacks.

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (str) – An incoming command.
Returns bool
collect_additional_context(context, update, dispatcher, check_result)
Prepares additional arguments for the context. Override if needed.
Parameters
• context (telegram.ext.CallbackContext) – The context object.
• update (telegram.Update) – The update to gather chat/user id from.
• dispatcher (telegram.ext.Dispatcher) – The calling dispatcher.
• check_result – The result (return value) from check_update.
collect_optional_args(dispatcher, update=None, check_result=None)
Prepares the optional arguments. If the handler has additional optional args, it should subclass this
method, but remember to call this super method.
DEPRECATED: This method is being replaced by new context based callbacks. Please see https:
//git.io/fxJuV for more info.
Parameters
• dispatcher (telegram.ext.Dispatcher) – The dispatcher.
• update (telegram.Update) – The update to gather chat/user id from.
• check_result – The result from check_update

telegram.ext.TypeHandler

class telegram.ext.TypeHandler(type, callback, strict=False, pass_update_queue=False,

pass_job_queue=False)
Bases: telegram.ext.handler.Handler
Handler class to handle updates of custom types.
type
The type of updates this handler should process.
Type type
callback
The callback function for this handler.

3.1. telegram.ext package 57

Python Telegram Bot Documentation, Release 12.8

Type callable
strict
Use type instead of isinstance. Default is False.
Type bool
pass_update_queue
Determines whether update_queue will be passed to the callback function.
Type bool
pass_job_queue
Determines whether job_queue will be passed to the callback function.
Type bool

Parameters
• type (type) – The type of updates this handler should process, as determined by
isinstance
• callback (callable) – The callback function for this handler. Will be called when
check_update has determined that an update should be processed by this handler.
Callback signature for context based API:
def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler.
• strict (bool, optional) – Use type instead of isinstance. Default is False
• pass_update_queue (bool, optional) – If set to True, a keyword argument called
update_queue will be passed to the callback function. It will be the Queue instance
used by the telegram.ext.Updater and telegram.ext.Dispatcher that
contains new updates which can be used to insert updates. Default is False. DEPRE-
CATED: Please switch to context based callbacks.
• pass_job_queue (bool, optional) – If set to True, a keyword argument called
job_queue will be passed to the callback function. It will be a telegram.ext.
JobQueue instance created by the telegram.ext.Updater which can be used to
schedule new jobs. Default is False. DEPRECATED: Please switch to context based
callbacks.

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (telegram.Update) – Incoming telegram update.
Returns bool

3.1.12 Persistence

telegram.ext.BasePersistence

class telegram.ext.BasePersistence(store_user_data=True, store_chat_data=True,

store_bot_data=True)
Bases: abc.ABC
Interface class for adding persistence to your bot. Subclass this object for different implementations of a
persistent bot.
All relevant methods must be overwritten. This means:

58 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• If store_bot_data is True you must overwrite get_bot_data() and

update_bot_data().
• If store_chat_data is True you must overwrite get_chat_data() and
update_chat_data().
• If store_user_data is True you must overwrite get_user_data() and
update_user_data().
• If you want to store conversation data with telegram.ext.ConversationHandler, you must
overwrite get_conversations() and update_conversation().
• flush() will be called when the bot is shutdown.
store_user_data
Optional, Whether user_data should be saved by this persistence class.
Type bool
store_chat_data
Optional. Whether chat_data should be saved by this persistence class.
Type bool
store_bot_data
Optional. Whether bot_data should be saved by this persistence class.
Type bool

Parameters
• store_user_data (bool, optional) – Whether user_data should be saved by this
persistence class. Default is True.
• store_chat_data (bool, optional) – Whether chat_data should be saved by this
persistence class. Default is True .
• store_bot_data (bool, optional) – Whether bot_data should be saved by this per-
sistence class. Default is True .

flush()
Will be called by telegram.ext.Updater upon receiving a stop signal. Gives the persistence a
chance to finish up saving or close a database connection gracefully. If this is not of any importance
just pass will be sufficient.
get_bot_data()
“Will be called by telegram.ext.Dispatcher upon creation with a persistence object. It should
return the bot_data if stored, or an empty dict.
Returns The restored bot data.
Return type defaultdict
get_chat_data()
“Will be called by telegram.ext.Dispatcher upon creation with a persistence object. It should
return the chat_data if stored, or an empty defaultdict(dict).
Returns The restored chat data.
Return type defaultdict
get_conversations(name)
“Will be called by telegram.ext.Dispatcher when a telegram.ext.
ConversationHandler is added if telegram.ext.ConversationHandler.
persistent is True. It should return the conversations for the handler with name or an
empty dict
Parameters name (str) – The handlers name.

3.1. telegram.ext package 59

Python Telegram Bot Documentation, Release 12.8

Returns The restored conversations for the handler.

Return type dict
get_user_data()
“Will be called by telegram.ext.Dispatcher upon creation with a persistence object. It should
return the user_data if stored, or an empty defaultdict(dict).
Returns The restored user data.
Return type defaultdict
update_bot_data(data)
Will be called by the telegram.ext.Dispatcher after a handler has handled an update.
Parameters data (dict) – The telegram.ext.dispatcher.bot_data .
update_chat_data(chat_id, data)
Will be called by the telegram.ext.Dispatcher after a handler has handled an update.
Parameters
• chat_id (int) – The chat the data might have been changed for.
• data (dict) – The telegram.ext.dispatcher.chat_data [chat_id].
update_conversation(name, key, new_state)
Will be called when a telegram.ext.ConversationHandler.update_state is called.
this allows the storeage of the new state in the persistence.
Parameters
• name (str) – The handlers name.
• key (tuple) – The key the state is changed for.
• new_state (tuple | any) – The new state for the given key.
update_user_data(user_id, data)
Will be called by the telegram.ext.Dispatcher after a handler has handled an update.
Parameters
• user_id (int) – The user the data might have been changed for.
• data (dict) – The telegram.ext.dispatcher.user_data [user_id].

telegram.ext.PicklePersistence

class telegram.ext.PicklePersistence(filename, store_user_data=True,

store_chat_data=True, store_bot_data=True,
single_file=True, on_flush=False)
Bases: telegram.ext.basepersistence.BasePersistence
Using python’s builtin pickle for making you bot persistent.
filename
The filename for storing the pickle files. When single_file is false this will be used as a prefix.
Type str
store_user_data
Optional. Whether user_data should be saved by this persistence class.
Type bool
store_chat_data
Optional. Whether user_data should be saved by this persistence class.
Type bool

60 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

store_bot_data
Optional. Whether bot_data should be saved by this persistence class.
Type bool
single_file
Optional. When False will store 3 sperate files of filename_user_data, filename_chat_data and
filename_conversations. Default is True.
Type bool
on_flush
When True will only save to file when flush() is called and keep data in memory until that hap-
pens. When False will store data on any transaction and on call fo flush(). Default is False.
Type bool, optional

Parameters
• filename (str) – The filename for storing the pickle files. When single_file is
false this will be used as a prefix.
• store_user_data (bool, optional) – Whether user_data should be saved by this
persistence class. Default is True.
• store_chat_data (bool, optional) – Whether user_data should be saved by this
persistence class. Default is True.
• store_bot_data (bool, optional) – Whether bot_data should be saved by this per-
sistence class. Default is True .
• single_file (bool, optional) – When False will store 3 sperate files of file-
name_user_data, filename_chat_data and filename_conversations. Default is True.
• on_flush (bool, optional) – When True will only save to file when flush() is
called and keep data in memory until that happens. When False will store data on any
transaction and on call fo flush(). Default is False.

flush()
Will save all data in memory to pickle file(s).
get_bot_data()
Returns the bot_data from the pickle file if it exsists or an empty dict.
Returns The restored bot data.
Return type defaultdict
get_chat_data()
Returns the chat_data from the pickle file if it exsists or an empty defaultdict.
Returns The restored chat data.
Return type defaultdict
get_conversations(name)
Returns the conversations from the pickle file if it exsists or an empty defaultdict.
Parameters name (str) – The handlers name.
Returns The restored conversations for the handler.
Return type dict
get_user_data()
Returns the user_data from the pickle file if it exsists or an empty defaultdict.
Returns The restored user data.
Return type defaultdict

3.1. telegram.ext package 61

Python Telegram Bot Documentation, Release 12.8

update_bot_data(data)
Will update the bot_data (if changed) and depending on on_flush save the pickle file.
Parameters data (dict) – The telegram.ext.dispatcher.bot_data.
update_chat_data(chat_id, data)
Will update the chat_data (if changed) and depending on on_flush save the pickle file.
Parameters
• chat_id (int) – The chat the data might have been changed for.
• data (dict) – The telegram.ext.dispatcher.chat_data [chat_id].
update_conversation(name, key, new_state)
Will update the conversations for the given handler and depending on on_flush save the pickle file.
Parameters
• name (str) – The handlers name.
• key (tuple) – The key the state is changed for.
• new_state (tuple | any) – The new state for the given key.
update_user_data(user_id, data)
Will update the user_data (if changed) and depending on on_flush save the pickle file.
Parameters
• user_id (int) – The user the data might have been changed for.
• data (dict) – The telegram.ext.dispatcher.user_data [user_id].

telegram.ext.DictPersistence

class telegram.ext.DictPersistence(store_user_data=True, store_chat_data=True,

store_bot_data=True, user_data_json=”,
chat_data_json=”, bot_data_json=”, conversa-
tions_json=”)
Bases: telegram.ext.basepersistence.BasePersistence
Using python’s dicts and json for making your bot persistent.
store_user_data
Whether user_data should be saved by this persistence class.
Type bool
store_chat_data
Whether chat_data should be saved by this persistence class.
Type bool
store_bot_data
Whether bot_data should be saved by this persistence class.
Type bool

Parameters
• store_user_data (bool, optional) – Whether user_data should be saved by this
persistence class. Default is True.
• store_chat_data (bool, optional) – Whether user_data should be saved by this
persistence class. Default is True.
• store_bot_data (bool, optional) – Whether bot_data should be saved by this per-
sistence class. Default is True .

62 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• user_data_json (str, optional) – Json string that will be used to reconstruct

user_data on creating this persistence. Default is "".
• chat_data_json (str, optional) – Json string that will be used to reconstruct
chat_data on creating this persistence. Default is "".
• bot_data_json (str, optional) – Json string that will be used to reconstruct
bot_data on creating this persistence. Default is "".
• conversations_json (str, optional) – Json string that will be used to reconstruct
conversation on creating this persistence. Default is "".

bot_data
The bot_data as a dict
Type dict
bot_data_json
The bot_data serialized as a JSON-string.
Type str
chat_data
The chat_data as a dict
Type dict
chat_data_json
The chat_data serialized as a JSON-string.
Type str
conversations
The conversations as a dict
Type dict
conversations_json
The conversations serialized as a JSON-string.
Type str
get_bot_data()
Returns the bot_data created from the bot_data_json or an empty dict.
Returns The restored user data.
Return type defaultdict
get_chat_data()
Returns the chat_data created from the chat_data_json or an empty defaultdict.
Returns The restored user data.
Return type defaultdict
get_conversations(name)
Returns the conversations created from the conversations_json or an empty defaultdict.
Returns The restored user data.
Return type defaultdict
get_user_data()
Returns the user_data created from the user_data_json or an empty defaultdict.
Returns The restored user data.
Return type defaultdict
update_bot_data(data)
Will update the bot_data (if changed).

3.1. telegram.ext package 63

Python Telegram Bot Documentation, Release 12.8

Parameters data (dict) – The telegram.ext.dispatcher.bot_data.

update_chat_data(chat_id, data)
Will update the chat_data (if changed).
Parameters
• chat_id (int) – The chat the data might have been changed for.
• data (dict) – The telegram.ext.dispatcher.chat_data [chat_id].
update_conversation(name, key, new_state)
Will update the conversations for the given handler.
Parameters
• name (str) – The handlers name.
• key (tuple) – The key the state is changed for.
• new_state (tuple | any) – The new state for the given key.
update_user_data(user_id, data)
Will update the user_data (if changed).
Parameters
• user_id (int) – The user the data might have been changed for.
• data (dict) – The telegram.ext.dispatcher.user_data [user_id].
user_data
The user_data as a dict
Type dict
user_data_json
The user_data serialized as a JSON-string.
Type str

3.2 telegram package

3.2.1 telegram.Animation

class telegram.Animation(file_id, file_unique_id, width, height, duration, thumb=None,

file_name=None, mime_type=None, file_size=None, bot=None,
**kwargs)
Bases: telegram.base.TelegramObject
This object represents an animation file to be displayed in the message containing a game.
file_id
File identifier.
Type str
file_unique_id
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t
be used to download or reuse the file.
Type str
width
Video width as defined by sender.
Type int

64 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

height
Video height as defined by sender.
Type int
duration
Duration of the video in seconds as defined by sender.
Type int
thumb
Optional. Animation thumbnail as defined by sender.
Type telegram.PhotoSize
file_name
Optional. Original animation filename as defined by sender.
Type str
mime_type
Optional. MIME type of the file as defined by sender.
Type str
file_size
Optional. File size.
Type int
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot

Parameters
• file_id (str) – Identifier for this file, which can be used to download or reuse the
file.
• file_unique_id (str) – Unique and the same over time and for different bots file
identifier.
• width (int) – Video width as defined by sender.
• height (int) – Video height as defined by sender.
• duration (int) – Duration of the video in seconds as defined by sender.
• thumb (telegram.PhotoSize, optional) – Animation thumbnail as defined by
sender.
• file_name (str, optional) – Original animation filename as defined by sender.
• mime_type (str, optional) – MIME type of the file as defined by sender.
• file_size (int, optional) – File size.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• **kwargs (dict) – Arbitrary keyword arguments.

get_file(timeout=None, **kwargs)
Convenience wrapper over telegram.Bot.get_file
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.

3.2. telegram package 65

Python Telegram Bot Documentation, Release 12.8

Returns telegram.File
Raises telegram.TelegramError

3.2.2 telegram.Audio

class telegram.Audio(file_id, file_unique_id, duration, performer=None, title=None,

mime_type=None, file_size=None, thumb=None, bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents an audio file to be treated as music by the Telegram clients.
file_id
Unique identifier for this file.
Type str
file_unique_id
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t
be used to download or reuse the file.
Type str
duration
Duration of the audio in seconds.
Type int
performer
Optional. Performer of the audio as defined by sender or by audio tags.
Type str
title
Optional. Title of the audio as defined by sender or by audio tags.
Type str
mime_type
Optional. MIME type of the file as defined by sender.
Type str
file_size
Optional. File size.
Type int
thumb
Optional. Thumbnail of the album cover to which the music file belongs
Type telegram.PhotoSize
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot

Parameters
• file_id (str) – Identifier for this file, which can be used to download or reuse the
file.
• file_unique_id (str) – Unique and the same over time and for different bots file
identifier.
• duration (int) – Duration of the audio in seconds as defined by sender.

66 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• performer (str, optional) – Performer of the audio as defined by sender or by audio

tags.
• title (str, optional) – Title of the audio as defined by sender or by audio tags.
• mime_type (str, optional) – MIME type of the file as defined by sender.
• file_size (int, optional) – File size.
• thumb (telegram.PhotoSize, optional) – Thumbnail of the album cover to which
the music file belongs
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• **kwargs (dict) – Arbitrary keyword arguments.

get_file(timeout=None, **kwargs)
Convenience wrapper over telegram.Bot.get_file
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.File
Raises telegram.TelegramError

3.2.3 telegram.Bot

class telegram.Bot(token, base_url=None, base_file_url=None, request=None, pri-

vate_key=None, private_key_password=None, defaults=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.
• defaults (telegram.ext.Defaults, optional) – An object containing default
values to be used if not set explicitly in the bot methods.
addStickerToSet(user_id, name, emojis, png_sticker=None, mask_position=None, timeout=20,
tgs_sticker=None, **kwargs)
Alias for add_sticker_to_set
add_sticker_to_set(user_id, name, emojis, png_sticker=None, mask_position=None, time-
out=20, tgs_sticker=None, **kwargs)
Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields
png_sticker or tgs_sticker. Animated stickers can be added to animated sticker sets and only to them.
Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers.

3.2. telegram package 67

Python Telegram Bot Documentation, Release 12.8

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

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

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

68 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

the user can be redirected to the specified Game URL. For this option to work, you must first cre-
ate 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 in-
line 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.

3.2. telegram package 69

Python Telegram Bot Documentation, Release 12.8

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

Returns On success, True is returned.

Return type bool
Raises telegram.TelegramError

answer_pre_checkout_query(pre_checkout_query_id, ok, error_message=None, time-

out=None, **kwargs)
Once the user has confirmed their payment and shipping details, the Bot API sends the final confirma-
tion 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 an-
swered.
• 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, er-

ror_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 possi-
ble).

70 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• 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 On success, True is returned.
Return type bool
Raises telegram.TelegramError
can_join_groups
Bot’s can_join_groups attribute.
Type str
can_read_all_group_messages
Bot’s can_read_all_group_messages attribute.
Type str
commands
Bot’s commands.
Type List[BotCommand]
createNewStickerSet(user_id, name, title, emojis, png_sticker=None, contains_masks=None,
mask_position=None, timeout=20, tgs_sticker=None, **kwargs)
Alias for create_new_sticker_set
create_new_sticker_set(user_id, name, title, emojis, png_sticker=None, con-
tains_masks=None, mask_position=None, timeout=20,
tgs_sticker=None, **kwargs)
Use this method to create new sticker set owned by a user. The bot will be able to edit the created
sticker set. You must use exactly one of the fields png_sticker or tgs_sticker.

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

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

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

3.2. telegram package 71

Python Telegram Bot Documentation, Release 12.8

• png_sticker (str | filelike object, optional) – Png image with the sticker, must
be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width
or height must be exactly 512px. Pass a file_id as a String to send a file that already
exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a
file from the Internet, or upload a new one using multipart/form-data.
• tgs_sticker (str | filelike object, optional) – TGS animation with the sticker,
uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#
technical-requirements for technical requirements
• 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
Returns On success, True is returned.
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

72 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

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 On success, True is returned.
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.
• A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
• Bots can delete outgoing messages in private chats, groups, and supergroups.
• Bots can delete incoming messages in private chats.
• Bots granted can_post_messages permissions can delete outgoing messages in channels.
• If the bot is an administrator of a group, it can delete any message there.
• If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any
message there.

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

3.2. telegram package 73

Python Telegram Bot Documentation, Release 12.8

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, cap-
tion=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, re-
ply_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, re-
ply_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, cap-
tion=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, optional) – Required if inline_message_id is not specified.
Unique identifier for the target chat or username of the target channel (in the format
@channelusername)
• message_id (int, optional) – Required if inline_message_id is not specified. Iden-
tifier of the message to edit.
• inline_message_id (str, optional) – Required if chat_id and message_id are
not specified. Identifier of the inline message.
• caption (str, optional) – New caption of the message, 0-1024 characters after
entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See
the constants in telegram.ParseMode for the available modes.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – A JSON-
serialized object for an inline keyboard.

74 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• 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, in-
line_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, optional) – Required if inline_message_id is not specified.
Unique identifier for the target chat or username of the target channel (in the format
@channelusername).
• message_id (int, optional) – Required if inline_message_id is not specified. Iden-
tifier of the message to edit.
• inline_message_id (str, optional) – Required if chat_id and message_id are
not specified. Identifier of the inline message.
• latitude (float, optional) – Latitude of location.
• longitude (float, optional) – Longitude of location.
• location (telegram.Location, optional) – The location to send.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – A JSON-
serialized object for a new inline keyboard.
• timeout (int | float, optional) – If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
Returns On success, if edited message is sent by the bot, the edited Message is returned,
otherwise True is returned.
Return type telegram.Message

edit_message_media(chat_id=None, message_id=None, inline_message_id=None, me-

dia=None, reply_markup=None, timeout=None, **kwargs)
Use this method to edit animation, 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.
Parameters
• chat_id (int | str, optional) – Required if inline_message_id is not specified.
Unique identifier for the target chat or username of the target channel (in the format
@channelusername).

3.2. telegram package 75

Python Telegram Bot Documentation, Release 12.8

• message_id (int, optional) – Required if inline_message_id is not specified. Iden-

tifier of the message to edit.
• inline_message_id (str, optional) – Required if chat_id and message_id are
not specified. Identifier of the inline message.
• media (telegram.InputMedia) – An object for a new media content of the
message.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – A JSON-
serialized object for an inline keyboard.
• timeout (int | float, optional) – If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
• **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_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, optional) – Required if inline_message_id is not specified.
Unique identifier for the target chat or username of the target channel (in the format
@channelusername).
• message_id (int, optional) – Required if inline_message_id is not specified. Iden-
tifier of the message to edit.
• inline_message_id (str, optional) – Required if chat_id and message_id are
not specified. Identifier of the inline message.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – A JSON-
serialized object for an inline keyboard.
• timeout (int | float, optional) – If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
• **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_text(text, chat_id=None, message_id=None, inline_message_id=None,
parse_mode=None, disable_web_page_preview=None, re-
ply_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, optional) – Required if inline_message_id is not specified.
Unique identifier for the target chat or username of the target channel (in the format
@channelusername)

76 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• message_id (int, optional) – Required if inline_message_id is not specified. Iden-

tifier of the message to edit.
• inline_message_id (str, optional) – Required if chat_id and message_id are
not specified. Identifier of the inline message.
• text (str) – New text of the message, 1-4096 characters after entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in your bot’s message. See
the constants in telegram.ParseMode for the available modes.
• disable_web_page_preview (bool, optional) – Disables link previews for
links in this message.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – A JSON-
serialized object for an inline keyboard.
• timeout (int | float, optional) – If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
• **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
exportChatInviteLink(chat_id, timeout=None, **kwargs)
Alias for export_chat_invite_link
export_chat_invite_link(chat_id, timeout=None, **kwargs)
Use this method to generate a new invite link for a chat; any previously generated link is revoked. The
bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Parameters
• 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 New 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, time-
out=None, **kwargs)
Use this method to forward messages of any kind.
Parameters

3.2. telegram package 77

Python Telegram Bot Documentation, Release 12.8

• 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 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
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
getMyCommands(timeout=None, **kwargs)
Alias for get_my_commands
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).

78 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• 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.
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 On success, returns a list of ChatMember objects that contains information about
all chat administrators except other bots. If the chat is a group or a supergroup and no
administrators were appointed, only the creator will be returned.
Return type List[telegram.ChatMember]
Raises telegram.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

3.2. telegram package 79

Python Telegram Bot Documentation, Release 12.8

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.

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

Parameters
• file_id (str | telegram.Animation | telegram.Audio | telegram.
ChatPhoto | telegram.Document | telegram.PhotoSize | telegram.
Sticker | telegram.Video | telegram.VideoNote | telegram.Voice)
– Either the file identifier or an object that has a file_id attribute to get file information
about.
• 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.File
Raises telegram.TelegramError

get_game_high_scores(user_id, chat_id=None, message_id=None, in-

line_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) – Target user id.
• chat_id (int | str, optional) – Required if inline_message_id is not specified.
Unique identifier for the target chat.
• message_id (int, optional) – Required if inline_message_id is not specified. Iden-
tifier 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

80 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

Raises telegram.TelegramError
get_my_commands(timeout=None, **kwargs)
Use this method to get the current list of the bot’s commands.
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 On success, the commands set for the bot
Return type List[telegram.BotCommand]
Raises telegram.TelegramError
get_sticker_set(name, timeout=None, **kwargs)
Use this method to get a sticker set.
Parameters
• name (str) – Name of the sticker set.
• timeout (int | float, optional) – If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
• **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 be-
tween 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 pur-
poses only.
• allowed_updates (List[str]), optional) – A JSON-serialized list the types
of updates you want your bot to receive. For example, specify [“message”,
“edited_channel_post”, “callback_query”] to only receive updates of these types. See
telegram.Update for a complete list of available update types. Specify an empty
list to receive all updates 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.

Note:

3.2. telegram package 81

Python Telegram Bot Documentation, Release 12.8

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 or a channel. In the case of supergroups
and channels, the user will not be able to return to the group on their own using invite links, etc., unless
unbanned first. The bot must be an administrator in the 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.

82 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• 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.
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
link
Convenience property. Returns the t.me link of the bot.
Type str
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 group, a supergroup, or a channel. The bot must be an adminis-
trator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup
or ‘can_edit_messages’ admin right in the channel.
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. Notifications
are always disabled in channels.

3.2. telegram package 83

Python Telegram Bot Documentation, Release 12.8

• 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
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, time-
out=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 On success, True is returned.

84 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

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 On success, True is returned.
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, re-
ply_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, dis-
able_notification=False, reply_to_message_id=None, reply_markup=None, time-
out=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, dis-
able_notification=False, reply_to_message_id=None, reply_markup=None,
timeout=None, contact=None, vcard=None, **kwargs)
Alias for send_contact
sendDice(chat_id, disable_notification=None, reply_to_message_id=None, reply_markup=None,
timeout=None, emoji=None, **kwargs)
Alias for send_dice

3.2. telegram package 85

Python Telegram Bot Documentation, Release 12.8

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, cur-
rency, 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, dis-
able_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, re-
ply_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, time-
out=20, **kwargs)
Alias for send_media_group
sendMessage(chat_id, text, parse_mode=None, disable_web_page_preview=None, dis-
able_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, re-
ply_to_message_id=None, reply_markup=None, timeout=20, parse_mode=None,
**kwargs)
Alias for send_photo
sendPoll(chat_id, question, options, is_anonymous=True, type=’regular’, al-
lows_multiple_answers=False, correct_option_id=None, is_closed=None,
disable_notification=None, reply_to_message_id=None, re-
ply_markup=None, timeout=None, explanation=None, explana-
tion_parse_mode=<telegram.utils.helpers.DefaultValue object>, open_period=None,
close_date=None, **kwargs)
Alias for send_poll
sendSticker(chat_id, sticker, disable_notification=False, reply_to_message_id=None, re-
ply_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, re-
ply_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, re-
ply_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

86 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

sendVoice(chat_id, voice, duration=None, caption=None, disable_notification=False, re-

ply_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, re-
ply_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). Bots can
currently send animation files of up to 50 MB in size, this limit may be changed in the future.
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 (rec-
ommended), 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; can be ignored if thumb-
nail generation for the file is supported server-side. The thumbnail should be in JPEG
format and less than 200 kB in size. A thumbnail’s width and height should not exceed
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t
be reused and can be only uploaded as a new file.
• caption (str, optional) – Animation caption (may also be used when resending
animations by file_id), 0-1024 characters after entities parsing.
• parse_mode (str, optional) – 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 op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions 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, dis-
able_notification=False, reply_to_message_id=None, reply_markup=None, time-
out=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 or .m4a format.
Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

3.2. telegram package 87

Python Telegram Bot Documentation, Release 12.8

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 after entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See
the constants in telegram.ParseMode for the available modes.
• 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 op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions to remove reply keyboard or to force a reply from the user.
• thumb (filelike object, optional) – Thumbnail of the file sent; can be ignored if thumb-
nail generation for the file is supported server-side. The thumbnail should be in JPEG
format and less than 200 kB in size. A thumbnail’s width and height should not exceed
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t
be reused and can be only uploaded as a new file.
• 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). Telegram only recommends using this method when a response from the bot will take
a noticeable amount of time to arrive.
Parameters
• chat_id (int | str) – Unique identifier for the target chat or username of the target
channel (in the format @channelusername).

88 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• 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 On success, True is returned.
Return type bool
Raises telegram.TelegramError
send_contact(chat_id, phone_number=None, first_name=None, last_name=None, dis-
able_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 op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions 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_dice(chat_id, disable_notification=None, reply_to_message_id=None, re-

ply_markup=None, timeout=None, emoji=None, **kwargs)
Use this method to send an animated emoji, which will have a random value. On success, the sent
Message is returned.

3.2. telegram package 89

Python Telegram Bot Documentation, Release 12.8

Parameters
• chat_id (int | str) – Unique identifier for the target private chat.
• emoji (str, optional) – Emoji on which the dice throw animation is based. Cur-
rently, must be one of “”, “” or “”. Dice can have values 1-6 for “” and “”, and values
1-5 for “” . Defaults to “”
• 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 op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions 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.
Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the
future.

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

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 after entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See
the constants in telegram.ParseMode for the available modes.
• disable_notification (bool, optional) – Sends the message silently. Users
will receive a notification with no sound.

90 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

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

original message.
• reply_markup (telegram.ReplyMarkup, optional) – Additional interface op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions to remove reply keyboard or to force a reply from the user.
• thumb (filelike object, optional) – Thumbnail of the file sent; can be ignored if thumb-
nail generation for the file is supported server-side. The thumbnail should be in JPEG
format and less than 200 kB in size. A thumbnail’s width and height should not exceed
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t
be reused and can be only uploaded as a new file.
• 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.InlineKeyboardMarkup, optional) – A JSON-
serialized object for a new inline keyboard. If empty, one ‘Play game_title’ button will
be shown. If not empty, the first button must launch the game.
• timeout (int | float, optional) – If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
• **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, cur-
rency, 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, dis-
able_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.

3.2. telegram package 91

Python Telegram Bot Documentation, Release 12.8

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

• description (str) – Product description, 1-255 characters.
• payload (str) – Bot-defined invoice payload, 1-128 bytes. This will not be dis-
played 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 JSON-serialized
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 in-
voice, which will be shared with the payment provider. A detailed description of re-
quired 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 com-
plete 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 ship-
ping 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.InlineKeyboardMarkup, optional) – A JSON-
serialized object for an inline keyboard. If empty, one ‘Pay total price’ button will be
shown. If not empty, the first button must be a Pay button.
• 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.

92 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

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, re-
ply_to_message_id=None, reply_markup=None, timeout=None, loca-
tion=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 op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions 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).

3.2. telegram package 93

Python Telegram Bot Documentation, Release 12.8

• **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, dis-
able_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 after entities
parsing. Also found as telegram.constants.MAX_MESSAGE_LENGTH.
• parse_mode (str) – Send Markdown or HTML, if you want Telegram apps to
show bold, italic, fixed-width text or inline URLs in your bot’s message. See the
constants in telegram.ParseMode for the available modes.
• 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 op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions 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, re-
ply_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

94 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

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 after entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See
the constants in telegram.ParseMode for the available modes.
• 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 op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions 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, is_anonymous=True, type=’regular’, al-

lows_multiple_answers=False, correct_option_id=None, is_closed=None,
disable_notification=None, reply_to_message_id=None, re-
ply_markup=None, timeout=None, explanation=None, explana-
tion_parse_mode=<telegram.utils.helpers.DefaultValue object>, open_period=None,
close_date=None, **kwargs)
Use this method to send a native poll.
Parameters
• chat_id (int | str) – Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
• question (str) – Poll question, 1-255 characters.
• options (List[str]) – List of answer options, 2-10 strings 1-100 characters each.
• is_anonymous (bool, optional) – True, if the poll needs to be anonymous, defaults
to True.
• type (str, optional) – Poll type, telegram.Poll.QUIZ or telegram.Poll.
REGULAR, defaults to telegram.Poll.REGULAR.
• allows_multiple_answers (bool, optional) – True, if the poll allows multiple
answers, ignored for polls in quiz mode, defaults to False.
• correct_option_id (int, optional) – 0-based identifier of the correct answer
option, required for polls in quiz mode.
• explanation (str, optional) – Text that is shown when a user chooses an incorrect
answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2
line feeds after entities parsing.
• explanation_parse_mode (str, optional) – Mode for parsing entities in the
explanation. See the constants in telegram.ParseMode for the available modes.
• open_period (int, optional) – Amount of time in seconds the poll will be active
after creation, 5-600. Can’t be used together with close_date.

3.2. telegram package 95

Python Telegram Bot Documentation, Release 12.8

• close_date (int | datetime.datetime, optional) – Point in time (Unix

timestamp) when the poll will be automatically closed. Must be at least 5 and no
more than 600 seconds in the future. Can’t be used together with open_period.
• is_closed (bool, optional) – Pass True, if the poll needs to be immediately closed.
This can be useful for poll preview.
• disable_notification (bool, optional) – Sends the message silently. Users
will receive a notification with no sound.
• reply_to_message_id (int, optional) – If the message is a reply, ID of the
original message.
• reply_markup (telegram.ReplyMarkup, optional) – Additional interface op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions 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, re-
ply_markup=None, timeout=20, **kwargs)
Use this method to send static .WEBP or animated .TGS 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 op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions 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

96 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

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 op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions 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, re-

ply_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).
Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

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

3.2. telegram package 97

Python Telegram Bot Documentation, Release 12.8

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 after entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See
the constants in telegram.ParseMode for the available modes.
• 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 op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions to remove reply keyboard or to force a reply from the user.
• thumb (filelike object, optional) – Thumbnail of the file sent; can be ignored if thumb-
nail generation for the file is supported server-side. The thumbnail should be in JPEG
format and less than 200 kB in size. A thumbnail’s width and height should not exceed
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t
be reused and can be only uploaded as a new file.
• 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, dis-

able_notification=False, reply_to_message_id=None, reply_markup=None,
timeout=20, thumb=None, **kwargs)
As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this
method to send video messages.

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

98 Chapter 3. Reference
 Python Telegram Bot Documentation, Release 12.8

• 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, i.e. diameter of the video mes-
sage.
• 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 op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions to remove reply keyboard or to force a reply from the user.
• thumb (filelike object, optional) – Thumbnail of the file sent; can be ignored if thumb-
nail generation for the file is supported server-side. The thumbnail should be in JPEG
format and less than 200 kB in size. A thumbnail’s width and height should not exceed
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t
be reused and can be only uploaded as a new file.
• 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, re-

ply_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). Bots can currently send voice messages of up to 50 MB in size, this
limit may be changed in the future.

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 after entities
parsing.

3.2. telegram package 99

Python Telegram Bot Documentation, Release 12.8

• 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 op-
tions. A JSON-serialized object for an inline keyboard, custom reply keyboard, in-
structions 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

setChatAdministratorCustomTitle(chat_id, user_id, custom_title, timeout=None,

**kwargs)
Alias for set_chat_administrator_custom_title
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
setMyCommands(commands, timeout=None, **kwargs)
Alias for set_my_commands
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
setStickerSetThumb(name, user_id, thumb=None, timeout=None, **kwargs)
Alias for set_sticker_set_thumb
setWebhook(url=None, certificate=None, timeout=None, max_connections=40, al-
lowed_updates=None, **kwargs)
Alias for set_webhook
set_chat_administrator_custom_title(chat_id, user_id, custom_title, timeout=None,
**kwargs)
Use this method to set a custom title for administrators promoted by the bot in a supergroup. The bot
must be an administrator for this to work.

100 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Parameters
• chat_id (int | str) – Unique identifier for the target chat or username of the target
supergroup (in the format @supergroupusername).
• user_id (int) – Unique identifier of the target administrator.
• custom_title (str) – emoji are not allowed.
• timeout (int | float, optional) – If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
• **kwargs (dict) – Arbitrary keyword arguments
Returns On success, True is returned.
Return type bool
Raises telegram.TelegramError
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, 0-255 characters.
• timeout (int | float, optional) – If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
• **kwargs (dict) – Arbitrary keyword arguments
Returns On success, True is returned.
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.
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 permis-
sions.
• 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

3.2. telegram package 101

Python Telegram Bot Documentation, Release 12.8

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
Returns On success, True is returned.
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 On success, True is returned.
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
Returns On success, True is returned.
Return type bool
Raises telegram.TelegramError

102 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

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.
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. Iden-
tifier 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_my_commands(commands, timeout=None, **kwargs)
Use this method to change the list of the bot’s commands.
Parameters
• commands (List[BotCommand | (str, str)]) – A JSON-serialized list of bot com-
mands to be set as the list of the bot’s commands. At most 100 commands can be
specified.
• timeout (int | float, optional) – If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
• **kwargs (dict) – Arbitrary keyword arguments.
Returns On success
Return type True
Raises telegram.TelegramError
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).
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.

3.2. telegram package 103

Python Telegram Bot Documentation, Release 12.8

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_sticker_set_thumb(name, user_id, thumb=None, timeout=None, **kwargs)
Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated
sticker sets only.

Note: The thumb can be either a file_id, an URL or a file from disk open(filename, 'rb')

Parameters
• name (str) – Sticker set name
• user_id (int) – User identifier of created sticker set owner.
• thumb (str | filelike object, optional) – A PNG image with the thumbnail, must
• up to 128 kilobytes in size and have width and height
exactly 100px, or a TGS (be) –
• with the thumbnail up to 32 kilobytes in size; see
(animation) –
• https – //core.telegram.org/animated_stickers#technical-requirements for animated
sticker
• requirements. Pass a file_id as a String to send a file
that already exists (technical) –
• the Telegram servers, pass an HTTP URL as a String for
Telegram to get a file from (on) –

104 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• Internet, or upload a new one using multipart/form-data.

(the) –
• 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, al-

lowed_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, Telegram will send an HTTPS POST request to the specified url, con-
taining a JSON-serialized Update. In case of an unsuccessful request, Telegram will give up after a
reasonable amount of attempts.
If you’d like to make sure that the Webhook request comes from Telegram, Telegram recommends
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) – A JSON-serialized list the types
of updates you want your bot to receive. For example, specify [“message”,
“edited_channel_post”, “callback_query”] to only receive updates of these types. See
telegram.Update for a complete list of available update types. Specify an empty
list to receive all updates 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.

3.2. telegram package 105

Python Telegram Bot Documentation, Release 12.8

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.
If you’re having any trouble setting up webhooks, please check out this guide to Webhooks.

Returns bool On success, True is returned.

Raises telegram.TelegramError

stopMessageLiveLocation(chat_id=None, message_id=None, inline_message_id=None, re-

ply_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, in-
line_message_id=None, reply_markup=None, time-
out=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) – Required if inline_message_id is not specified. Unique
identifier for the target chat or username of the target channel (in the format @chan-
nelusername).
• message_id (int, optional) – Required if inline_message_id is not specified. Iden-
tifier of the sent message with live location to stop.
• inline_message_id (str, optional) – Required if chat_id and message_id are
not specified. Identifier of the inline message.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – A JSON-
serialized object for a new inline keyboard.
• timeout (int | float, optional) – If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
Returns On success, if edited message is sent by the bot, the edited Message is returned,
otherwise True is returned.
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.InlineKeyboardMarkup, optional) – A JSON-
serialized object for a new message inline keyboard.
• timeout (int | float, optional) – If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
• **kwargs (dict) – Arbitrary keyword arguments.
Returns On success, the stopped Poll with the final results is returned.

106 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Return type telegram.Poll

Raises telegram.TelegramError
supports_inline_queries
Bot’s supports_inline_queries attribute.
Type str
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 or channel.
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 group, a supergroup, or a channel. The bot must be an
administrator in the chat for this to work and must have the can_pin_messages admin right in the
supergroup or can_edit_messages admin right in the 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 On success, True is returned.
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')

3.2. telegram package 107

Python Telegram Bot Documentation, Release 12.8

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

3.2.4 telegram.BotCommand

class telegram.BotCommand(command, description, **kwargs)

Bases: telegram.base.TelegramObject
This object represents a bot command.
command
Text of the command.
Type str
description
Description of the command.
Type str

Parameters
• command (str) – Text of the command, 1-32 characters. Can contain only lowercase
English letters, digits and underscores.
• description (str) – Description of the command, 3-256 characters.

3.2.5 telegram.CallbackQuery

class telegram.CallbackQuery(id, from_user, chat_instance, message=None, data=None, in-

line_message_id=None, game_short_name=None, bot=None,
**kwargs)
Bases: telegram.base.TelegramObject
This object represents an incoming callback query from a callback button in an inline keyboard.
If the button that originated the query was attached to a message sent by the bot, the field message
will be present. If the button was attached to a message sent via the bot (in inline mode), the field
inline_message_id will be present.

Note:
• In Python from is a reserved word, use from_user instead.

108 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• Exactly one of the fields data or game_short_name will be present.

id
Unique identifier for this query.
Type str
from_user
Sender.
Type telegram.User
chat_instance
Global identifier, uniquely corresponding to the chat to which the message with the callback button
was sent.
Type str
message
Optional. Message with the callback button that originated the query.
Type telegram.Message
data
Optional. Data associated with the callback button.
Type str
inline_message_id
Optional. Identifier of the message sent via the bot in inline mode, that originated the query.
Type str
game_short_name
Optional. Short name of a Game to be returned.
Type str
bot
The Bot to use for instance methods.
Type telegram.Bot, optional

Parameters
• id (str) – Unique identifier for this query.
• from_user (telegram.User) – Sender.
• chat_instance (str) – Global identifier, uniquely corresponding to the chat to
which the message with the callback button was sent. Useful for high scores in games.
• message (telegram.Message, optional) – Message with the callback button that
originated the query. Note that message content and message date will not be available
if the message is too old.
• data (str, optional) – Data associated with the callback button. Be aware that a bad
client can send arbitrary data in this field.
• inline_message_id (str, optional) – Identifier of the message sent via the bot in
inline mode, that originated the query.
• game_short_name (str, optional) – Short name of a Game to be returned, serves
as the unique identifier for the game
• bot (telegram.Bot, optional) – The Bot to use for instance methods.

3.2. telegram package 109

Python Telegram Bot Documentation, Release 12.8

Note: After the user presses an inline button, Telegram clients will display a progress bar until you call
answer. It is, therefore, necessary to react by calling telegram.Bot.answer_callback_query
even if no notification to the user is needed (e.g., without specifying any of the optional parameters).

answer(*args, **kwargs)
Shortcut for:

bot.answer_callback_query(update.callback_query.id, *args, **kwargs)

Returns On success, True is returned.

Return type bool

edit_message_caption(caption, *args, **kwargs)

Shortcut for either:

bot.edit_message_caption(caption=caption,
chat_id=update.callback_query.message.chat_id,
message_id=update.callback_query.message.message_id,
*args, **kwargs)

or:

bot.edit_message_caption(caption=caption
inline_message_id=update.callback_query.inline_
˓→message_id,

*args, **kwargs)

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

edit_message_reply_markup(reply_markup, *args, **kwargs)

Shortcut for either:

bot.edit_message_replyMarkup(chat_id=update.callback_query.message.chat_id,
message_id=update.callback_query.message.
˓→message_id,

reply_markup=reply_markup,
*args, **kwargs)

or:

bot.edit_message_reply_markup(inline_message_id=update.callback_query.
˓→inline_message_id,

reply_markup=reply_markup,
*args, **kwargs)

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

edit_message_text(text, *args, **kwargs)

Shortcut for either:

110 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

bot.edit_message_text(text, chat_id=update.callback_query.message.chat_id,
message_id=update.callback_query.message.message_id,
*args, **kwargs)

or:

bot.edit_message_text(text, inline_message_id=update.callback_query.inline_
˓→message_id,

*args, **kwargs)

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

3.2.6 telegram.Chat

class telegram.Chat(id, type, title=None, username=None, first_name=None, last_name=None,

bot=None, photo=None, description=None, invite_link=None,
pinned_message=None, permissions=None, sticker_set_name=None,
can_set_sticker_set=None, slow_mode_delay=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a chat.
id
Unique identifier for this chat.
Type int
type
Type of chat.
Type str
title
Optional. Title, for supergroups, channels and group chats.
Type str
username
Optional. Username.
Type str
first_name
Optional. First name of the other party in a private chat.
Type str
last_name
Optional. Last name of the other party in a private chat.
Type str
photo
Optional. Chat photo.
Type telegram.ChatPhoto
description
Optional. Description, for groups, supergroups and channel chats.
Type str
invite_link
Optional. Chat invite link, for supergroups and channel chats.

3.2. telegram package 111

Python Telegram Bot Documentation, Release 12.8

Type str
pinned_message
Optional. Pinned message, for supergroups. Returned only in get_chat.
Type telegram.Message
permissions
Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat.
Type telegram.ChatPermission
slow_mode_delay
Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each
unpriviledged user. Returned only in getChat.
Type int
sticker_set_name
Optional. For supergroups, name of Group sticker set.
Type str
can_set_sticker_set
Optional. True, if the bot can change group the sticker set.
Type bool

Parameters
• id (int) – Unique identifier for this chat. This number may be greater than 32 bits and
some programming languages may have difficulty/silent defects in interpreting it. But it
is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe
for storing this identifier.
• type (str) – Type of chat, can be either ‘private’, ‘group’, ‘supergroup’ or ‘channel’.
• title (str, optional) – Title, for supergroups, channels and group chats.
• username (str, optional) – Username, for private chats, supergroups and channels if
available.
• first_name (str, optional) – First name of the other party in a private chat.
• last_name (str, optional) – Last name of the other party in a private chat.
• photo (telegram.ChatPhoto, optional) – Chat photo. Returned only in getChat.
• description (str, optional) – Description, for groups, supergroups and channel
chats. Returned only in get_chat.
• invite_link (str, optional) – Chat invite link, for supergroups and channel chats.
Returned only in get_chat.
• pinned_message (telegram.Message, optional) – Pinned message, for super-
groups. Returned only in get_chat.
• permissions (telegram.ChatPermission) – Optional. Default chat member
permissions, for groups and supergroups. Returned only in getChat.
• slow_mode_delay (int, optional) – For supergroups, the minimum allowed de-
lay between consecutive messages sent by each unpriviledged user. Returned only in
getChat.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• sticker_set_name (str, optional) – For supergroups, name of Group sticker set.
Returned only in get_chat.
• can_set_sticker_set (bool, optional) – True, if the bot can change group the
sticker set. Returned only in get_chat.

112 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• **kwargs (dict) – Arbitrary keyword arguments.

CHANNEL = 'channel'
‘channel’
Type str
GROUP = 'group'
‘group’
Type str
PRIVATE = 'private'
‘private’
Type str
SUPERGROUP = 'supergroup'
‘supergroup’
Type str
get_administrators(*args, **kwargs)
Shortcut for:

bot.get_chat_administrators(update.message.chat.id, *args, **kwargs)

Returns A list of administrators in a chat. An Array of telegram.ChatMember objects

that contains information about all chat administrators except other bots. If the chat is
a group or a supergroup and no administrators were appointed, only the creator will be
returned
Return type List[telegram.ChatMember]

get_member(*args, **kwargs)
Shortcut for:

bot.get_chat_member(update.message.chat.id, *args, **kwargs)

Returns telegram.ChatMember

get_members_count(*args, **kwargs)
Shortcut for:

bot.get_chat_members_count(update.message.chat.id, *args, **kwargs)

Returns int

kick_member(*args, **kwargs)
Shortcut for:

bot.kick_chat_member(update.message.chat.id, *args, **kwargs)

Returns If the action was sent succesfully.

Return type bool

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

3.2. telegram package 113

Python Telegram Bot Documentation, Release 12.8

leave(*args, **kwargs)
Shortcut for:

bot.leave_chat(update.message.chat.id, *args, **kwargs)

Returns bool If the action was sent successfully.

link
Convenience property. If the chat has a username, returns a t.me link of the chat.
Type str
send_action(*args, **kwargs)
Shortcut for:

bot.send_chat_action(update.message.chat.id, *args, **kwargs)

Returns If the action was sent successfully.

Return type bool

send_animation(*args, **kwargs)
Shortcut for:

bot.send_animation(Chat.id, *args, **kwargs)

Where Chat is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_audio(*args, **kwargs)
Shortcut for:

bot.send_audio(Chat.id, *args, **kwargs)

Where Chat is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_document(*args, **kwargs)
Shortcut for:

bot.send_document(Chat.id, *args, **kwargs)

Where Chat is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_message(*args, **kwargs)
Shortcut for:

bot.send_message(Chat.id, *args, **kwargs)

Where Chat is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message

114 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

send_photo(*args, **kwargs)
Shortcut for:

bot.send_photo(Chat.id, *args, **kwargs)

Where Chat is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_poll(*args, **kwargs)
Shortcut for:

bot.send_poll(Chat.id, *args, **kwargs)

Where Chat is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_sticker(*args, **kwargs)
Shortcut for:

bot.send_sticker(Chat.id, *args, **kwargs)

Where Chat is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_video(*args, **kwargs)
Shortcut for:

bot.send_video(Chat.id, *args, **kwargs)

Where Chat is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_video_note(*args, **kwargs)
Shortcut for:

bot.send_video_note(Chat.id, *args, **kwargs)

Where Chat is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_voice(*args, **kwargs)
Shortcut for:

bot.send_voice(Chat.id, *args, **kwargs)

Where Chat is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
set_administrator_custom_title(*args, **kwargs)
Shortcut for:

3.2. telegram package 115

Python Telegram Bot Documentation, Release 12.8

bot.set_chat_administrator_custom_title(update.message.chat.id, *args,
˓→**kwargs)

Returns: bool: If the action was sent successfully.

set_permissions(*args, **kwargs)
Shortcut for:

bot.set_chat_permissions(update.message.chat.id, *args, **kwargs)

Returns: bool: If the action was sent successfully.

unban_member(*args, **kwargs)
Shortcut for:

bot.unban_chat_member(update.message.chat.id, *args, **kwargs)

Returns If the action was sent successfully.

Return type bool

3.2.7 telegram.ChatAction

class telegram.ChatAction
Bases: object
Helper class to provide constants for different chatactions.
FIND_LOCATION = 'find_location'
‘find_location’
Type str
RECORD_AUDIO = 'record_audio'
‘record_audio’
Type str
RECORD_VIDEO = 'record_video'
‘record_video’
Type str
RECORD_VIDEO_NOTE = 'record_video_note'
‘record_video_note’
Type str
TYPING = 'typing'
‘typing’
Type str
UPLOAD_AUDIO = 'upload_audio'
‘upload_audio’
Type str
UPLOAD_DOCUMENT = 'upload_document'
‘upload_document’
Type str
UPLOAD_PHOTO = 'upload_photo'
‘upload_photo’
Type str

116 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

UPLOAD_VIDEO = 'upload_video'
‘upload_video’
Type str
UPLOAD_VIDEO_NOTE = 'upload_video_note'
‘upload_video_note’
Type str

3.2.8 telegram.ChatMember

class telegram.ChatMember(user, status, until_date=None, can_be_edited=None,

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,
can_send_messages=None, can_send_media_messages=None,
can_send_polls=None, can_send_other_messages=None,
can_add_web_page_previews=None, is_member=None, cus-
tom_title=None, **kwargs)
Bases: telegram.base.TelegramObject
This object contains information about one member of the chat.
user
Information about the user.
Type telegram.User
status
The member’s status in the chat.
Type str
custom_title
Optional. Custom title for owner and administrators.
Type str
until_date
Optional. Date when restrictions will be lifted for this user.
Type datetime.datetime
can_be_edited
Optional. If the bot is allowed to edit administrator privileges of that user.
Type bool
can_change_info
Optional. If the user can change the chat title, photo and other settings.
Type bool
can_post_messages
Optional. If the administrator can post in the channel.
Type bool
can_edit_messages
Optional. If the administrator can edit messages of other users.
Type bool
can_delete_messages
Optional. If the administrator can delete messages of other users.

3.2. telegram package 117

Python Telegram Bot Documentation, Release 12.8

Type bool
can_invite_users
Optional. If the user can invite new users to the chat.
Type bool
can_restrict_members
Optional. If the administrator can restrict, ban or unban chat members.
Type bool
can_pin_messages
Optional. If the user can pin messages.
Type bool
can_promote_members
Optional. If the administrator can add new administrators.
Type bool
is_member
Optional. Restricted only. True, if the user is a member of the chat at the moment of the request.
Type bool
can_send_messages
Optional. If the user can send text messages, contacts, locations and venues.
Type bool
can_send_media_messages
Optional. If the user can send media messages, implies can_send_messages.
Type bool
can_send_polls
Optional. True, if the user is allowed to send polls.
Type bool
can_send_other_messages
Optional. If the user can send animations, games, stickers and use inline bots, implies
can_send_media_messages.
Type bool
can_add_web_page_previews
Optional. If user may add web page previews to his messages, implies can_send_media_messages
Type bool

Parameters
• user (telegram.User) – Information about the user.
• status (str) – The member’s status in the chat. Can be ‘creator’, ‘administrator’,
‘member’, ‘restricted’, ‘left’ or ‘kicked’.
• custom_title (str, optional) – Owner and administrators only. Custom title for
this user.
• until_date (datetime.datetime, optional) – Restricted and kicked only. Date
when restrictions will be lifted for this user.
• can_be_edited (bool, optional) – Administrators only. True, if the bot is allowed
to edit administrator privileges of that user.
• can_change_info (bool, optional) – Administrators and restricted only. True, if
the user can change the chat title, photo and other settings.

118 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• can_post_messages (bool, optional) – Administrators only. True, if the admin-

istrator can post in the channel, channels only.
• can_edit_messages (bool, optional) – Administrators only. True, if the admin-
istrator can edit messages of other users, channels only.
• can_delete_messages (bool, optional) – Administrators only. True, if the ad-
ministrator can delete messages of other user.
• can_invite_users (bool, optional) – Administrators and restricted only. True, if
the user can invite new users to the chat.
• can_restrict_members (bool, optional) – Administrators only. True, if the ad-
ministrator can restrict, ban or unban chat members.
• can_pin_messages (bool, optional) – Administrators and restricted only. True, if
the user can pin messages, supergroups only.
• can_promote_members (bool, optional) – Administrators only. True, if the ad-
ministrator 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 the user).
• is_member (bool, optional) – Restricted only. True, if the user is a member of the
chat at the moment of the request.
• can_send_messages (bool, optional) – Restricted only. True, if the user can send
text messages, contacts, locations and venues.
• can_send_media_messages (bool, optional) – Restricted only. True, if the
user can send audios, documents, photos, videos, video notes and voice notes, implies
can_send_messages.
• can_send_polls (bool, optional) – Restricted only. True, if the user is allowed to
send polls.
• can_send_other_messages (bool, optional) – Restricted only. True, if
the user can send animations, games, stickers and use inline bots, implies
can_send_media_messages.
• can_add_web_page_previews (bool, optional) – Restricted only. True, if user
may add web page previews to his messages, implies can_send_media_messages.

ADMINISTRATOR = 'administrator'
‘administrator’
Type str
CREATOR = 'creator'
‘creator’
Type str
KICKED = 'kicked'
‘kicked’
Type str
LEFT = 'left'
‘left’
Type str
MEMBER = 'member'
‘member’
Type str

3.2. telegram package 119

Python Telegram Bot Documentation, Release 12.8

RESTRICTED = 'restricted'
‘restricted’
Type str

3.2.9 telegram.ChatPermissions

class telegram.ChatPermissions(can_send_messages=None, can_send_media_messages=None,

can_send_polls=None, can_send_other_messages=None,
can_add_web_page_previews=None,
can_change_info=None, can_invite_users=None,
can_pin_messages=None, **kwargs)
Bases: telegram.base.TelegramObject
Describes actions that a non-administrator user is allowed to take in a chat.

Note: Though not stated explicitly in the offical docs, Telegram changes not only the permissions that
are set, but also sets all the others to False. However, since not documented, this behaviour may change
unbeknown to PTB.

can_send_messages
Optional. True, if the user is allowed to send text messages, contacts, locations and venues.
Type bool
can_send_media_messages
Optional. True, if the user is allowed to send audios, documents, photos, videos, video notes and voice
notes, implies can_send_messages.
Type bool
can_send_polls
Optional. True, if the user is allowed to send polls, implies can_send_messages.
Type bool
can_send_other_messages
Optional. True, if the user is allowed to send animations, games, stickers and use inline bots, implies
can_send_media_messages.
Type bool
can_add_web_page_previews
Optional. True, if the user is allowed to add web page previews to their messages, implies
can_send_media_messages.
Type bool
can_change_info
Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in
public supergroups.
Type bool
can_invite_users
Optional. True, if the user is allowed to invite new users to the chat.
Type bool
can_pin_messages
Optional. True, if the user is allowed to pin messages. Ignored in public supergroups.
Type bool

Parameters

120 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• can_send_messages (bool, optional) – True, if the user is allowed to send text

messages, contacts, locations and venues.
• can_send_media_messages (bool, optional) – True, if the user is allowed
to send audios, documents, photos, videos, video notes and voice notes, implies
can_send_messages.
• can_send_polls (bool, optional) – True, if the user is allowed to send polls, im-
plies can_send_messages.
• can_send_other_messages (bool, optional) – True, if the user is al-
lowed to send animations, games, stickers and use inline bots, implies
can_send_media_messages.
• can_add_web_page_previews (bool, optional) – True, if the user is allowed to
add web page previews to their messages, implies can_send_media_messages.
• can_change_info (bool, optional) – True, if the user is allowed to change the chat
title, photo and other settings. Ignored in public supergroups.
• can_invite_users (bool, optional) – True, if the user is allowed to invite new
users to the chat.
• can_pin_messages (bool, optional) – True, if the user is allowed to pin messages.
Ignored in public supergroups.

3.2.10 telegram.ChatPhoto

class telegram.ChatPhoto(small_file_id, small_file_unique_id, big_file_id, big_file_unique_id,

bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a chat photo.
small_file_id
File identifier of small (160x160) chat photo. This file_id can be used only for photo download and
only for as long as the photo is not changed.
Type str
small_file_unique_id
Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and
for different bots. Can’t be used to download or reuse the file.
Type str
big_file_id
File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only
for as long as the photo is not changed.
Type str
big_file_unique_id
Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for
different bots. Can’t be used to download or reuse the file.
Type str

Parameters
• small_file_id (str) – Unique file identifier of small (160x160) chat photo. This
file_id can be used only for photo download and only for as long as the photo is not
changed.

3.2. telegram package 121

Python Telegram Bot Documentation, Release 12.8

• small_file_unique_id (str) – Unique file identifier of small (160x160) chat

photo, which is supposed to be the same over time and for different bots. Can’t be used
to download or reuse the file.
• big_file_id (str) – Unique file identifier of big (640x640) chat photo. This file_id
can be used only for photo download and only for as long as the photo is not changed.
• big_file_unique_id (str) – Unique file identifier of big (640x640) chat photo,
which is supposed to be the same over time and for different bots. Can’t be used to
download or reuse the file.
• bot (telegram.Bot, optional) – The Bot to use for instance methods
• **kwargs (dict) – Arbitrary keyword arguments.

get_big_file(timeout=None, **kwargs)
Convenience wrapper over telegram.Bot.get_file for getting the big (640x640) chat photo
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.File
Raises telegram.TelegramError
get_small_file(timeout=None, **kwargs)
Convenience wrapper over telegram.Bot.get_file for getting the small (160x160) chat photo
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.File
Raises telegram.TelegramError

3.2.11 telegram.constants Module

Constants in the Telegram network.

The following constants were extracted from the Telegram Bots FAQ and Telegram Bots API.
telegram.constants.MAX_MESSAGE_LENGTH
4096
Type int
telegram.constants.MAX_CAPTION_LENGTH
1024
Type int
telegram.constants.SUPPORTED_WEBHOOK_PORTS
[443, 80, 88, 8443]
Type List[int]
telegram.constants.MAX_FILESIZE_DOWNLOAD
In bytes (20MB)

122 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Type int
telegram.constants.MAX_FILESIZE_UPLOAD
In bytes (50MB)
Type int
telegram.constants.MAX_PHOTOSIZE_UPLOAD
In bytes (10MB)
Type int
telegram.constants.MAX_MESSAGES_PER_SECOND_PER_CHAT
1. Telegram may allow short bursts that go over this limit, but eventually you’ll begin receiving 429 errors.
Type int
telegram.constants.MAX_MESSAGES_PER_SECOND
30
Type int
telegram.constants.MAX_MESSAGES_PER_MINUTE_PER_GROUP
20
Type int
telegram.constants.MAX_INLINE_QUERY_RESULTS
50
Type int
The following constant have been found by experimentation:
telegram.constants.MAX_MESSAGE_ENTITIES
100 (Beyond this cap telegram will simply ignore further formatting styles)
Type int

3.2.12 telegram.Contact

class telegram.Contact(phone_number, first_name, last_name=None, user_id=None,

vcard=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a phone contact.
phone_number
Contact’s phone number.
Type str
first_name
Contact’s first name.
Type str
last_name
Optional. Contact’s last name.
Type str
user_id
Optional. Contact’s user identifier in Telegram.
Type int
vcard
Optional. Additional data about the contact in the form of a vCard.

3.2. telegram package 123

Python Telegram Bot Documentation, Release 12.8

Type str

Parameters
• phone_number (str) – Contact’s phone number.
• first_name (str) – Contact’s first name.
• last_name (str, optional) – Contact’s last name.
• user_id (int, optional) – Contact’s user identifier in Telegram.
• vcard (str, optional) – Additional data about the contact in the form of a vCard.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2.13 telegram.Dice

class telegram.Dice(value, emoji, **kwargs)

Bases: telegram.base.TelegramObject
This object represents an animated emoji with a random value for currently supported base emoji. (The
singular form of “dice” is “die”. However, PTB mimics the Telegram API, which uses the term “dice”.)

Note: If emoji is “”, a value of 6 currently represents a bullseye, while a value of 1 indicates that the
dartboard was missed. However, this behaviour is undocumented and might be changed by Telegram.
If emoji is “”, a value of 4 or 5 currently score a basket, while a value of 1 to 3 indicates that the basket
was missed. However, this behaviour is undocumented and might be changed by Telegram.

value
Value of the dice.
Type int
emoji
Emoji on which the dice throw animation is based.
Type str

Parameters
• value (int) – Value of the dice. 1-6 for dice and darts, 1-5 for basketball.
• emoji (str) – Emoji on which the dice throw animation is based.

ALL_EMOJI = ['', '', '']

List of all supported base emoji. Currently DICE, DARTS and BASKETBALL.
Type List[str]
BASKETBALL = ''
‘’
Type str
DARTS = ''
‘’
Type str
DICE = ''
‘’
Type str

124 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

3.2.14 telegram.Document

class telegram.Document(file_id, file_unique_id, thumb=None, file_name=None,

mime_type=None, file_size=None, bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a general file (as opposed to photos, voice messages and audio files).
file_id
Unique file identifier.
Type str
file_unique_id
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t
be used to download or reuse the file.
Type str
thumb
Optional. Document thumbnail.
Type telegram.PhotoSize
file_name
Original filename.
Type str
mime_type
Optional. MIME type of the file.
Type str
file_size
Optional. File size.
Type int
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot

Parameters
• file_id (str) – Identifier for this file, which can be used to download or reuse the
file.
• file_unique_id (str) – Unique and the same over time and for different bots file
identifier.
• thumb (telegram.PhotoSize, optional) – Document thumbnail as defined by
sender.
• file_name (str, optional) – Original filename as defined by sender.
• mime_type (str, optional) – MIME type of the file as defined by sender.
• file_size (int, optional) – File size.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• **kwargs (dict) – Arbitrary keyword arguments.

get_file(timeout=None, **kwargs)
Convenience wrapper over telegram.Bot.get_file
Parameters

3.2. telegram package 125

Python Telegram Bot Documentation, Release 12.8

• 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.File
Raises telegram.TelegramError

3.2.15 telegram.error module

This module contains an object that represents Telegram errors.

exception telegram.error.BadRequest(message)
Bases: telegram.error.NetworkError
exception telegram.error.ChatMigrated(new_chat_id)
Bases: telegram.error.TelegramError
Parameters new_chat_id (int) –
exception telegram.error.Conflict(msg)
Bases: telegram.error.TelegramError
Raised when a long poll or webhook conflicts with another one.
Parameters msg (str) – The message from telegrams server.
exception telegram.error.InvalidToken
Bases: telegram.error.TelegramError
exception telegram.error.NetworkError(message)
Bases: telegram.error.TelegramError
exception telegram.error.RetryAfter(retry_after)
Bases: telegram.error.TelegramError
Parameters retry_after (int) –
exception telegram.error.TelegramError(message)
Bases: Exception
exception telegram.error.TimedOut
Bases: telegram.error.NetworkError
exception telegram.error.Unauthorized(message)
Bases: telegram.error.TelegramError

3.2.16 telegram.File

class telegram.File(file_id, file_unique_id, bot=None, file_size=None, file_path=None,

**kwargs)
Bases: telegram.base.TelegramObject
This object represents a file ready to be downloaded. The file can be downloaded with 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 getFile.

Note: Maximum file size to download is 20 MB

file_id
Unique identifier for this file.
Type str

126 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

file_unique_id
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t
be used to download or reuse the file.
Type str
file_size
Optional. File size.
Type str
file_path
Optional. File path. Use download to get the file.
Type str

Parameters
• file_id (str) – Identifier for this file, which can be used to download or reuse the
file.
• file_unique_id (str) – Unique and the same over time and for different bots file
identifier.
• file_size (int, optional) – Optional. File size, if known.
• file_path (str, optional) – File path. Use download to get the file.
• bot (telegram.Bot, optional) – Bot to use with shortcut method.
• **kwargs (dict) – Arbitrary keyword arguments.

Note: If you obtain an instance of this class from telegram.PassportFile.get_file, then it will
automatically be decrypted as it downloads when you call download().

download(custom_path=None, out=None, timeout=None)

Download this file. By default, the file is saved in the current working directory with its original
filename as reported by Telegram. If the file has no filename, it the file ID will be used as filename. If
a custom_path is supplied, it will be saved to that path instead. If out is defined, the file contents
will be saved to that object using the out.write method.

Note: custom_path and out are mutually exclusive.

Parameters
• custom_path (str, optional) – Custom path.
• out (io.BufferedWriter, optional) – A file-like object. Must be opened for
writing in binary mode, if applicable.
• 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 The same object as out if specified. Otherwise, returns the filename downloaded
to.
Return type str | io.BufferedWriter
Raises ValueError – If both custom_path and out are passed.

download_as_bytearray(buf=None)
Download this file and return it as a bytearray.

3.2. telegram package 127

Python Telegram Bot Documentation, Release 12.8

Parameters buf (bytearray, optional) – Extend the given bytearray with the down-
loaded data.
Returns The same object as buf if it was specified. Otherwise a newly allocated
bytearray.
Return type bytearray

3.2.17 telegram.ForceReply

class telegram.ForceReply(force_reply=True, selective=False, **kwargs)

Bases: telegram.replymarkup.ReplyMarkup
Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as
if the user has selected the bot’s message and tapped ‘Reply’). This can be extremely useful if you want to
create user-friendly step-by-step interfaces without having to sacrifice privacy mode.
force_reply
Shows reply interface to the user.
Type True
selective
Optional. Force reply from specific users only.
Type bool

Parameters
• selective (bool, optional) – Use this parameter if you want to force reply from
specific users only. Targets:
1) users that are @mentioned in the text of the Message object
2) if the bot’s message is a reply (has reply_to_message_id), sender of the original mes-
sage.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2.18 telegram.InlineKeyboardButton

class telegram.InlineKeyboardButton(text, url=None, callback_data=None,

switch_inline_query=None,
switch_inline_query_current_chat=None, call-
back_game=None, pay=None, login_url=None,
**kwargs)
Bases: telegram.base.TelegramObject
This object represents one button of an inline keyboard.

Note: You must use exactly one of the optional fields. Mind that callback_game is not working as
expected. Putting a game short name in it might, but is not guaranteed to work.

text
Label text on the button.
Type str
url
Optional. HTTP or tg:// url to be opened when button is pressed.
Type str

128 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

login_url
authorize the user. Can be used as a replacement for the Telegram Login Widget.
Type telegram.LoginUrl
callback_data
Optional. Data to be sent in a callback query to the bot when button is pressed, UTF-8 1-64 bytes.
Type str
switch_inline_query
Optional. Will prompt the user to select one of their chats, open that chat and insert the bot’s username
and the specified inline query in the input field. Can be empty, in which case just the bot’s username
will be inserted.
Type str
switch_inline_query_current_chat
Optional. Will insert the bot’s username and the specified inline query in the current chat’s input field.
Can be empty, in which case just the bot’s username will be inserted.
Type str
callback_game
Optional. Description of the game that will be launched when the user presses the button.
Type telegram.CallbackGame
pay
Optional. Specify True, to send a Pay button.
Type bool

Parameters
• text (str) – Label text on the button.
• url (str) – HTTP or tg:// url to be opened when button is pressed.
• login_url (telegram.LoginUrl, optional) – authorize the user. Can be used as
a replacement for the Telegram Login Widget.
• callback_data (str, optional) – Data to be sent in a callback query to the bot
when button is pressed, UTF-8 1-64 bytes.
• switch_inline_query (str, optional) – If set, pressing the button will prompt
the user to select one of their chats, open that chat and insert the bot’s username and
the specified inline query in the input field. Can be empty, in which case just the bot’s
username will be inserted. This offers an easy way for users to start using your bot in
inline mode when they are currently in a private chat with it. Especially useful when
combined with switch_pm* actions - in this case the user will be automatically returned
to the chat they switched from, skipping the chat selection screen.
• switch_inline_query_current_chat (str, optional) – If set, pressing the
button will insert the bot’s username and the specified inline query in the current chat’s
input field. Can be empty, in which case only the bot’s username will be inserted. This
offers a quick way for the user to open your bot in inline mode in the same chat - good
for selecting something from multiple options.
• callback_game (telegram.CallbackGame, optional) – Description of the
game that will be launched when the user presses the button. This type of button must
always be the first button in the first row.
• pay (bool, optional) – Specify True, to send a Pay button. This type of button must
always be the first button in the first row.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2. telegram package 129

Python Telegram Bot Documentation, Release 12.8

3.2.19 telegram.InlineKeyboardMarkup

class telegram.InlineKeyboardMarkup(inline_keyboard, **kwargs)

Bases: telegram.replymarkup.ReplyMarkup
This object represents an inline keyboard that appears right next to the message it belongs to.
inline_keyboard
Array of button rows, each represented by an Array of InlineKeyboardButton objects.
Type List[List[telegram.InlineKeyboardButton]]

Parameters
• inline_keyboard (List[List[telegram.InlineKeyboardButton]]) – Ar-
ray of button rows, each represented by an Array of InlineKeyboardButton objects.
• **kwargs (dict) – Arbitrary keyword arguments.

classmethod from_button(button, **kwargs)

Shortcut for:
InlineKeyboardMarkup([[button]], **kwargs)

Return an InlineKeyboardMarkup from a single InlineKeyboardButton

Parameters
• button (telegram.InlineKeyboardButton) – The button to use in the
markup
• **kwargs (dict) – Arbitrary keyword arguments.
classmethod from_column(button_column, **kwargs)
Shortcut for:
InlineKeyboardMarkup([[button] for button in button_column], **kwargs)

Return an InlineKeyboardMarkup from a single column of InlineKeyboardButtons

Parameters
• button_column (List[telegram.InlineKeyboardButton]) – The button
to use in the markup
• **kwargs (dict) – Arbitrary keyword arguments.
classmethod from_row(button_row, **kwargs)
Shortcut for:
InlineKeyboardMarkup([button_row], **kwargs)

Return an InlineKeyboardMarkup from a single row of InlineKeyboardButtons

Parameters
• button_row (List[telegram.InlineKeyboardButton]) – The button to use
in the markup
• **kwargs (dict) – Arbitrary keyword arguments.

3.2.20 telegram.InputFile

class telegram.InputFile(obj, filename=None, attach=None)

Bases: object
This object represents a Telegram InputFile.

130 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

input_file_content
The binaray content of the file to send.
Type bytes
filename
Optional, Filename for the file to be sent.
Type str
attach
Optional, attach id for sending multiple files.
Type str

Parameters
• obj (File handler) – An open file descriptor.
• filename (str, optional) – Filename for this InputFile.
• attach (bool, optional) – Whether this should be send as one file or is part of a
collection of files.
Raises TelegramError

static is_image(stream)
Check if the content file is an image by analyzing its headers.
Parameters stream (str) – A str representing the content of a file.
Returns The str mime-type of an image.
Return type str

3.2.21 telegram.InputMedia

class telegram.InputMedia
Bases: telegram.base.TelegramObject
Base class for Telegram InputMedia Objects.
See telegram.InputMediaAnimation, telegram.InputMediaAudio, telegram.
InputMediaDocument, telegram.InputMediaPhoto and telegram.InputMediaVideo
for detailed use.

3.2.22 telegram.InputMediaAnimation

class telegram.InputMediaAnimation(media, thumb=None, caption=None,

parse_mode=<telegram.utils.helpers.DefaultValue
object>, width=None, height=None, duration=None)
Bases: telegram.files.inputmedia.InputMedia
Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
type
animation.
Type str
media
Animation to send.
Type str | telegram.InputFile
caption
Optional. Caption of the document to be sent.

3.2. telegram package 131

Python Telegram Bot Documentation, Release 12.8

Type str
parse_mode
Optional. The parse mode to use for text formatting.
Type str
thumb
Optional. Thumbnail of the file to send.
Type telegram.InputFile
width
Optional. Animation width.
Type int
height
Optional. Animation height.
Type int
duration
Optional. Animation duration.
Type int

Parameters
• media (str | filelike object | telegram.Animation) – File to send. Pass a file_id
to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for
Telegram to get a file from the Internet. Lastly you can pass an existing telegram.
Animation object to send.
• thumb (filelike object, optional) – Thumbnail of the file sent; can be ignored if thumb-
nail generation for the file is supported server-side. The thumbnail should be in JPEG
format and less than 200 kB in size. A thumbnail’s width and height should not exceed
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be
reused and can be only uploaded as a new file.
• caption (str, optional) – Caption of the animation to be sent, 0-1024 characters
after entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• width (int, optional) – Animation width.
• height (int, optional) – Animation height.
• duration (int, optional) – Animation duration.

Note: When using a telegram.Animation for the media attribute. It will take the width, height and
duration from that video, unless otherwise specified with the optional arguments.

3.2.23 telegram.InputMediaAudio

class telegram.InputMediaAudio(media, thumb=None, caption=None,

parse_mode=<telegram.utils.helpers.DefaultValue ob-
ject>, duration=None, performer=None, title=None)
Bases: telegram.files.inputmedia.InputMedia
Represents an audio file to be treated as music to be sent.

132 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

type
audio.
Type str
media
Audio file to send.
Type str | telegram.InputFile
caption
Optional. Caption of the document to be sent.
Type str
parse_mode
Optional. The parse mode to use for text formatting.
Type str
duration
Duration of the audio in seconds.
Type int
performer
Optional. Performer of the audio as defined by sender or by audio tags.
Type str
title
Optional. Title of the audio as defined by sender or by audio tags.
Type str
thumb
Optional. Thumbnail of the file to send.
Type telegram.InputFile

Parameters
• media (str | filelike object | telegram.Audio) – File to send. Pass a file_id to
send a file that exists on the Telegram servers (recommended), pass an HTTP URL for
Telegram to get a file from the Internet. Lastly you can pass an existing telegram.
Document object to send.
• caption (str, optional) – Caption of the audio to be sent, 0-1024 characters after
entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• duration (int) – Duration of the audio in seconds as defined by sender.
• performer (str, optional) – Performer of the audio as defined by sender or by audio
tags.
• title (str, optional) – Title of the audio as defined by sender or by audio tags.
• thumb (filelike object, optional) – Thumbnail of the file sent; can be ignored if thumb-
nail generation for the file is supported server-side. The thumbnail should be in JPEG
format and less than 200 kB in size. A thumbnail’s width and height should not exceed
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be
reused and can be only uploaded as a new file.

3.2. telegram package 133

Python Telegram Bot Documentation, Release 12.8

Note: When using a telegram.Audio for the media attribute. It will take the duration, performer and
title from that video, unless otherwise specified with the optional arguments.

3.2.24 telegram.InputMediaDocument

class telegram.InputMediaDocument(media, thumb=None, caption=None,

parse_mode=<telegram.utils.helpers.DefaultValue
object>)
Bases: telegram.files.inputmedia.InputMedia
Represents a general file to be sent.
type
document.
Type str
media
File to send.
Type str | telegram.InputFile
caption
Optional. Caption of the document to be sent.
Type str
parse_mode
Optional. The parse mode to use for text formatting.
Type str
thumb
Optional. Thumbnail of the file to send.
Type telegram.InputFile

Parameters
• media (str | filelike object | telegram.Document) – File to send. Pass a file_id to
send a file that exists on the Telegram servers (recommended), pass an HTTP URL for
Telegram to get a file from the Internet. Lastly you can pass an existing telegram.
Document object to send.
• caption (str, optional) – Caption of the document to be sent, 0-1024 characters after
entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• thumb (filelike object, optional) – Thumbnail of the file sent; can be ignored if thumb-
nail generation for the file is supported server-side. The thumbnail should be in JPEG
format and less than 200 kB in size. A thumbnail’s width and height should not exceed
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be
reused and can be only uploaded as a new file.

3.2.25 telegram.InputMediaPhoto

class telegram.InputMediaPhoto(media, caption=None, parse_mode=<telegram.utils.helpers.DefaultValue

object>)
Bases: telegram.files.inputmedia.InputMedia

134 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Represents a photo to be sent.

type
photo.
Type str
media
Photo to send.
Type str | telegram.InputFile
caption
Optional. Caption of the document to be sent.
Type str
parse_mode
Optional. The parse mode to use for text formatting.
Type str

Parameters
• media (str | filelike object | telegram.PhotoSize) – File to send. Pass a file_id
to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for
Telegram to get a file from the Internet. Lastly you can pass an existing telegram.
PhotoSize object to send.
• caption (str, optional) – Caption of the photo to be sent, 0-1024 characters after
entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.

3.2.26 telegram.InputMediaVideo

class telegram.InputMediaVideo(media, caption=None, width=None, height=None,

duration=None, supports_streaming=None,
parse_mode=<telegram.utils.helpers.DefaultValue ob-
ject>, thumb=None)
Bases: telegram.files.inputmedia.InputMedia
Represents a video to be sent.
type
video.
Type str
media
Video file to send.
Type str | telegram.InputFile
caption
Optional. Caption of the document to be sent.
Type str
parse_mode
Optional. The parse mode to use for text formatting.
Type str
width
Optional. Video width.

3.2. telegram package 135

Python Telegram Bot Documentation, Release 12.8

Type int
height
Optional. Video height.
Type int
duration
Optional. Video duration.
Type int
supports_streaming
Optional. Pass True, if the uploaded video is suitable for streaming.
Type bool
thumb
Optional. Thumbnail of the file to send.
Type telegram.InputFile

Parameters
• media (str | filelike object | telegram.Video) – File to send. Pass a file_id to
send a file that exists on the Telegram servers (recommended), pass an HTTP URL for
Telegram to get a file from the Internet. Lastly you can pass an existing telegram.
Video object to send.
• caption (str, optional) – Caption of the video to be sent, 0-1024 characters after
entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• width (int, optional) – Video width.
• height (int, optional) – Video height.
• duration (int, optional) – Video duration.
• supports_streaming (bool, optional) – Pass True, if the uploaded video is suit-
able for streaming.
• thumb (filelike object, optional) – Thumbnail of the file sent; can be ignored if thumb-
nail generation for the file is supported server-side. The thumbnail should be in JPEG
format and less than 200 kB in size. A thumbnail’s width and height should not exceed
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be
reused and can be only uploaded as a new file.

Note: When using a telegram.Video for the media attribute. It will take the width, height and
duration from that video, unless otherwise specified with the optional arguments.

3.2.27 telegram.KeyboardButton

class telegram.KeyboardButton(text, request_contact=None, request_location=None, re-

quest_poll=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents one button of the reply keyboard. For simple text buttons String can be used instead
of this object to specify text of the button.

136 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Note: Optional fields are mutually exclusive.

text
Text of the button.
Type str
request_contact
Optional. If the user’s phone number will be sent.
Type bool
request_location
Optional. If the user’s current location will be sent.
Type bool
request_poll
Optional. If the user should create a poll.
Type KeyboardButtonPollType

Parameters
• text (str) – Text of the button. If none of the optional fields are used, it will be sent
to the bot as a message when the button is pressed.
• request_contact (bool, optional) – If True, the user’s phone number will be sent
as a contact when the button is pressed. Available in private chats only.
• request_location (bool, optional) – If True, the user’s current location will be
sent when the button is pressed. Available in private chats only.
• request_poll (KeyboardButtonPollType, optional) – If specified, the user
will be asked to create a poll and send it to the bot when the button is pressed. Available
in private chats only.

Note: request_contact and request_location options will only work in Telegram versions
released after 9 April, 2016. Older clients will ignore them.
request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients
will receive unsupported message.

3.2.28 telegram.KeyboardButtonPollType

class telegram.KeyboardButtonPollType(type=None)
Bases: telegram.base.TelegramObject
This object represents type of a poll, which is allowed to be created and sent when the corresponding button
is pressed.
type
Optional. If telegram.Poll.QUIZ is passed, the user will be allowed to create only polls in the
quiz mode. If telegram.Poll.REGULAR is passed, only regular polls will be allowed. Otherwise,
the user will be allowed to create a poll of any type.
Type str

3.2. telegram package 137

Python Telegram Bot Documentation, Release 12.8

3.2.29 telegram.Location

class telegram.Location(longitude, latitude, **kwargs)

Bases: telegram.base.TelegramObject
This object represents a point on the map.
longitude
Longitude as defined by sender.
Type float
latitude
Latitude as defined by sender.
Type float

Parameters
• longitude (float) – Longitude as defined by sender.
• latitude (float) – Latitude as defined by sender.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2.30 telegram.LoginUrl

class telegram.LoginUrl(url, forward_text=None, bot_username=None, re-

quest_write_access=None)
Bases: telegram.base.TelegramObject
This object represents a parameter of the inline keyboard button used to automatically authorize a user.
Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All
the user needs to do is tap/click a button and confirm that they want to log in. Telegram apps support these
buttons as of version 5.7.
Sample bot: @discussbot
url
An HTTP URL to be opened with user authorization data.
Type str
forward_text
Optional. New text of the button in forwarded messages.
Type str
bot_username
Optional. Username of a bot, which will be used for user authorization.
Type str
request_write_access
Optional. Pass True to request the permission for your bot to send messages to the user.
Type bool

Parameters
• url (str) – An HTTP URL to be opened with user authorization data added to the
query string when the button is pressed. If the user refuses to provide authorization data,
the original URL without information about the user will be opened. The data added is
the same as described in Receiving authorization data. NOTE: You must always check
the hash of the received data to verify the authentication and the integrity of the data as
described in Checking authorization.

138 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• forward_text (str, optional) – New text of the button in forwarded messages.

• bot_username (str, optional) – Username of a bot, which will be used for user
authorization. See Setting up a bot for more details. If not specified, the current bot’s
username will be assumed. The url’s domain must be the same as the domain linked
with the bot. See Linking your domain to the bot for more details.
• request_write_access (bool, optional) – Pass True to request the permission
for your bot to send messages to the user.

3.2.31 telegram.Message

class telegram.Message(message_id, from_user, date, chat, forward_from=None, for-

ward_from_chat=None, forward_from_message_id=None, for-
ward_date=None, reply_to_message=None, edit_date=None,
text=None, entities=None, caption_entities=None, audio=None, doc-
ument=None, game=None, photo=None, sticker=None, video=None,
voice=None, video_note=None, new_chat_members=None,
caption=None, contact=None, location=None,
venue=None, left_chat_member=None, new_chat_title=None,
new_chat_photo=None, delete_chat_photo=False,
group_chat_created=False, supergroup_chat_created=False,
channel_chat_created=False, migrate_to_chat_id=None,
migrate_from_chat_id=None, pinned_message=None, in-
voice=None, successful_payment=None, forward_signature=None,
author_signature=None, media_group_id=None, con-
nected_website=None, animation=None, passport_data=None,
poll=None, forward_sender_name=None, reply_markup=None,
bot=None, default_quote=None, dice=None, via_bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a message.

Note:
• In Python from is a reserved word, use from_user instead.

message_id
Unique message identifier inside this chat.
Type int
from_user
Optional. Sender.
Type telegram.User
date
Date the message was sent.
Type datetime.datetime
chat
Conversation the message belongs to.
Type telegram.Chat
forward_from
Optional. Sender of the original message.
Type telegram.User

3.2. telegram package 139

Python Telegram Bot Documentation, Release 12.8

forward_from_chat
Optional. Information about the original channel.
Type telegram.Chat
forward_from_message_id
Optional. Identifier of the original message in the channel.
Type int
forward_date
Optional. Date the original message was sent.
Type datetime.datetime
reply_to_message
Optional. The original message.
Type telegram.Message
edit_date
Optional. Date the message was last edited.
Type datetime.datetime
media_group_id
Optional. The unique identifier of a media message group this message belongs to.
Type str
text
Optional. The actual UTF-8 text of the message.
Type str
entities
Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the text. See
Message.parse_entity and parse_entities methods for how to use properly.
Type List[telegram.MessageEntity]
caption_entities
Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the caption. See
Message.parse_caption_entity and parse_caption_entities methods for how to
use properly.
Type List[telegram.MessageEntity]
audio
Optional. Information about the file.
Type telegram.Audio
document
Optional. Information about the file.
Type telegram.Document
animation
For backward compatibility, when this field is set, the document field will also be set.
Type telegram.Animation
game
Optional. Information about the game.
Type telegram.Game
photo
Optional. Available sizes of the photo.
Type List[telegram.PhotoSize]

140 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

sticker
Optional. Information about the sticker.
Type telegram.Sticker
video
Optional. Information about the video.
Type telegram.Video
voice
Optional. Information about the file.
Type telegram.Voice
video_note
Optional. Information about the video message.
Type telegram.VideoNote
new_chat_members
Optional. Information about new members to the chat. (the bot itself may be one of these members).
Type List[telegram.User]
caption
Optional. Caption for the document, photo or video, 0-1024 characters.
Type str
contact
Optional. Information about the contact.
Type telegram.Contact
location
Optional. Information about the location.
Type telegram.Location
venue
Optional. Information about the venue.
Type telegram.Venue
left_chat_member
Optional. Information about the user that left the group. (this member may be the bot itself).
Type telegram.User
new_chat_title
Optional. A chat title was changed to this value.
Type str
new_chat_photo
Optional. A chat photo was changed to this value.
Type List[telegram.PhotoSize]
delete_chat_photo
Optional. The chat photo was deleted.
Type bool
group_chat_created
Optional. The group has been created.
Type bool
supergroup_chat_created
Optional. The supergroup has been created.

3.2. telegram package 141

Python Telegram Bot Documentation, Release 12.8

Type bool
channel_chat_created
Optional. The channel has been created.
Type bool
migrate_to_chat_id
Optional. The group has been migrated to a supergroup with the specified identifier.
Type int
migrate_from_chat_id
Optional. The supergroup has been migrated from a group with the specified identifier.
Type int
pinned_message
Optional. Specified message was pinned.
Type telegram.message
invoice
Optional. Information about the invoice.
Type telegram.Invoice
successful_payment
Optional. Information about the payment.
Type telegram.SuccessfulPayment
connected_website
Optional. The domain name of the website on which the user has logged in.
Type str
forward_signature
Optional. Signature of the post author for messages forwarded from channels.
Type str
forward_sender_name
Optional. Sender’s name for messages forwarded from users who disallow adding a link to their
account in forwarded messages.
Type str
author_signature
Optional. Signature of the post author for messages in channels.
Type str
passport_data
Optional. Telegram Passport data.
Type telegram.PassportData
poll
Optional. Message is a native poll, information about the poll.
Type telegram.Poll
dice
Optional. Message is a dice.
Type telegram.Dice
via_bot
Optional. Bot through which the message was sent.
Type telegram.User

142 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot
default_quote
Optional. Default setting for the quote parameter of the reply_text and friends.
Type bool

Parameters
• message_id (int) – Unique message identifier inside this chat.
• from_user (telegram.User, optional) – Sender, can be empty for messages sent
to channels.
• date (datetime.datetime) – Date the message was sent in Unix time. Converted
to datetime.datetime.
• chat (telegram.Chat) – Conversation the message belongs to.
• forward_from (telegram.User, optional) – For forwarded messages, sender of
the original message.
• forward_from_chat (telegram.Chat, optional) – For messages forwarded
from a channel, information about the original channel.
• forward_from_message_id (int, optional) – For forwarded channel posts, iden-
tifier of the original message in the channel.
• forward_sender_name (str, optional) – Sender’s name for messages forwarded
from users who disallow adding a link to their account in forwarded messages.
• forward_date (datetime.datetime, optional) – For forwarded messages, date
the original message was sent in Unix time. Converted to datetime.datetime.
• reply_to_message (telegram.Message, optional) – For replies, the origi-
nal message. Note that the Message object in this field will not contain further
reply_to_message fields even if it itself is a reply.
• edit_date (datetime.datetime, optional) – Date the message was last edited
in Unix time. Converted to datetime.datetime.
• media_group_id (str, optional) – The unique identifier of a media message group
this message belongs to.
• text (str, optional) – For text messages, the actual UTF-8 text of
the message, 0-4096 characters. Also found as telegram.constants.
MAX_MESSAGE_LENGTH.
• entities (List[telegram.MessageEntity], optional) – For text messages,
special entities like usernames, URLs, bot commands, etc. that appear in the text. See
attr:parse_entity and attr:parse_entities methods for how to use properly.
• caption_entities (List[telegram.MessageEntity]) – Optional. For Mes-
sages with a Caption. Special entities like usernames, URLs, bot commands,
etc. that appear in the caption. See Message.parse_caption_entity and
parse_caption_entities methods for how to use properly.
• audio (telegram.Audio, optional) – Message is an audio file, information about
the file.

3.2. telegram package 143

Python Telegram Bot Documentation, Release 12.8

• document (telegram.Document, optional) – Message is a general file, informa-

tion about the file.
• animation (telegram.Animation, optional) – Message is an animation, infor-
mation about the animation. For backward compatibility, when this field is set, the
document field will also be set.
• game (telegram.Game, optional) – Message is a game, information about the game.
• photo (List[telegram.PhotoSize], optional) – Message is a photo, available
sizes of the photo.
• sticker (telegram.Sticker, optional) – Message is a sticker, information about
the sticker.
• video (telegram.Video, optional) – Message is a video, information about the
video.
• voice (telegram.Voice, optional) – Message is a voice message, information
about the file.
• video_note (telegram.VideoNote, optional) – Message is a video note, infor-
mation about the video message.
• new_chat_members (List[telegram.User], optional) – New members that were
added to the group or supergroup and information about them (the bot itself may be one
of these members).
• caption (str, optional) – Caption for the document, photo or video, 0-1024 charac-
ters.
• contact (telegram.Contact, optional) – Message is a shared contact, informa-
tion about the contact.
• location (telegram.Location, optional) – Message is a shared location, infor-
mation about the location.
• venue (telegram.Venue, optional) – Message is a venue, information about the
venue.
• left_chat_member (telegram.User, optional) – A member was removed from
the group, information about them (this member may be the bot itself).
• new_chat_title (str, optional) – A chat title was changed to this value.
• new_chat_photo (List[telegram.PhotoSize], optional) – A chat photo was
change to this value.
• delete_chat_photo (bool, optional) – Service message: The chat photo was
deleted.
• group_chat_created (bool, optional) – Service message: The group has been
created.
• supergroup_chat_created (bool, optional) – Service message: The super-
group has been created. This field can’t be received in a message coming through
updates, because bot can’t be a member of a supergroup when it is created. It can
only be found in reply_to_message if someone replies to a very first message in a
directly created supergroup.
• channel_chat_created (bool, optional) – Service message: The channel has
been created. This field can’t be received in a message coming through updates, be-
cause bot can’t be a member of a channel when it is created. It can only be found in
attr:reply_to_message if someone replies to a very first message in a channel.
• migrate_to_chat_id (int, optional) – The group has been migrated to a super-
group with the specified identifier. This number may be greater than 32 bits and some
programming languages may have difficulty/silent defects in interpreting it. But it is

144 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for
storing this identifier.
• migrate_from_chat_id (int, optional) – The supergroup has been migrated
from a group with the specified identifier. This number may be greater than 32 bits
and some programming languages may have difficulty/silent defects in interpreting it.
But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type
are safe for storing this identifier.
• pinned_message (telegram.message, optional) – Specified message was
pinned. Note that the Message object in this field will not contain further
reply_to_message fields even if it is itself a reply.
• invoice (telegram.Invoice, optional) – Message is an invoice for a payment,
information about the invoice.
• successful_payment (telegram.SuccessfulPayment, optional) – Mes-
sage is a service message about a successful payment, information about the payment.
• connected_website (str, optional) – The domain name of the website on which
the user has logged in.
• forward_signature (str, optional) – Signature of the post author for messages
forwarded from channels.
• author_signature (str, optional) – Signature of the post author for messages in
channels.
• passport_data (telegram.PassportData, optional) – Telegram Passport
data.
• poll (telegram.Poll, optional) – Message is a native poll, information about the
poll.
• dice (telegram.Dice, optional) – Message is a dice with random value from 1 to
6.
• via_bot (telegram.User, optional) – Message was sent through an inline bot.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message. login_url buttons are represented as ordinary url buttons.
• default_quote (bool, optional) – Default setting for the quote parameter of the
reply_text and friends.

caption_html
Creates an HTML-formatted string from the markup entities found in the message’s caption.
Use this if you want to retrieve the message caption with the caption entities formatted as HTML in
the same way the original message was formatted.
Returns Message caption with captionentities formatted as HTML.
Return type str
caption_html_urled
Creates an HTML-formatted string from the markup entities found in the message’s caption.
Use this if you want to retrieve the message caption with the caption entities formatted as HTML. This
also formats telegram.MessageEntity.URL as a hyperlink.
Returns Message caption with caption entities formatted as HTML.
Return type str
caption_markdown
Creates an Markdown-formatted string from the markup entities found in the message’s caption using
telegram.ParseMode.MARKDOWN .

3.2. telegram package 145

Python Telegram Bot Documentation, Release 12.8

Use this if you want to retrieve the message caption with the caption entities formatted as Markdown
in the same way the original message was formatted.
Returns Message caption with caption entities formatted as Markdown.
Return type str
caption_markdown_urled
Creates an Markdown-formatted string from the markup entities found in the message’s caption using
telegram.ParseMode.MARKDOWN .
Use this if you want to retrieve the message caption with the caption entities formatted as Markdown.
This also formats telegram.MessageEntity.URL as a hyperlink.
Returns Message caption with caption entities formatted as Markdown.
Return type str
caption_markdown_v2
Creates an Markdown-formatted string from the markup entities found in the message’s caption using
telegram.ParseMode.MARKDOWN_V2.
Use this if you want to retrieve the message caption with the caption entities formatted as Markdown
in the same way the original message was formatted.
Returns Message caption with caption entities formatted as Markdown.
Return type str
caption_markdown_v2_urled
Creates an Markdown-formatted string from the markup entities found in the message’s caption using
telegram.ParseMode.MARKDOWN_V2.
Use this if you want to retrieve the message caption with the caption entities formatted as Markdown.
This also formats telegram.MessageEntity.URL as a hyperlink.
Returns Message caption with caption entities formatted as Markdown.
Return type str
chat_id
Shortcut for telegram.Chat.id for chat.
Type int
delete(*args, **kwargs)
Shortcut for:

bot.delete_message(chat_id=message.chat_id,
message_id=message.message_id,
*args,
**kwargs)

Returns On success, True is returned.

Return type bool

edit_caption(*args, **kwargs)
Shortcut for:

bot.edit_message_caption(chat_id=message.chat_id,
message_id=message.message_id,
*args,
**kwargs)

146 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Note: You can only edit messages that the bot sent itself (i.e. of the bot.send_* family of methods)
or channel posts, if the bot is an admin in that channel. However, this behaviour is undocumented and
might be changed by Telegram.

Returns On success, instance representing the edited message.

Return type telegram.Message

edit_media(media, *args, **kwargs)

Shortcut for:

bot.edit_message_media(chat_id=message.chat_id,
message_id=message.message_id,
*args,
**kwargs)

Note: You can only edit messages that the bot sent itself (i.e. of the bot.send_* family of methods)
or channel posts, if the bot is an admin in that channel. However, this behaviour is undocumented and
might be changed by Telegram.

Returns On success, instance representing the edited message.

Return type telegram.Message

edit_reply_markup(*args, **kwargs)
Shortcut for:

bot.edit_message_reply_markup(chat_id=message.chat_id,
message_id=message.message_id,
*args,
**kwargs)

Note: You can only edit messages that the bot sent itself (i.e. of the bot.send_* family of methods)
or channel posts, if the bot is an admin in that channel. However, this behaviour is undocumented and
might be changed by Telegram.

Returns On success, instance representing the edited message.

Return type telegram.Message

edit_text(*args, **kwargs)
Shortcut for:

bot.edit_message_text(chat_id=message.chat_id,
message_id=message.message_id,
*args,
**kwargs)

Note: You can only edit messages that the bot sent itself (i.e. of the bot.send_* family of methods)
or channel posts, if the bot is an admin in that channel. However, this behaviour is undocumented and
might be changed by Telegram.

Returns On success, instance representing the edited message.

3.2. telegram package 147

Python Telegram Bot Documentation, Release 12.8

Return type telegram.Message

effective_attachment
telegram.Audio or telegram.Contact or telegram.Document or telegram.
Animation or telegram.Game or telegram.Invoice or telegram.
Location or List[telegram.PhotoSize] or telegram.Sticker or telegram.
SuccessfulPayment or telegram.Venue or telegram.Video or telegram.
VideoNote or telegram.Voice: The attachment that this message was sent with. May
be None if no attachment was sent.
forward(chat_id, *args, **kwargs)
Shortcut for:

bot.forward_message(chat_id=chat_id,
from_chat_id=update.message.chat_id,
message_id=update.message.message_id,
*args,
**kwargs)

Returns On success, instance representing the message forwarded.

Return type telegram.Message

link
Convenience property. If the chat of the message is not a private chat or normal group, returns a t.me
link of the message.
Type str
parse_caption_entities(types=None)
Returns a dict that maps telegram.MessageEntity to str. It contains entities from this
message’s caption filtered by their telegram.MessageEntity.type attribute as the key, and
the text that each entity belongs to as the value of the dict.

Note: This method should always be used instead of the caption_entities attribute,
since it calculates the correct substring from the message text based on UTF-16 codepoints. See
parse_entity for more info.

Parameters types (List[str], optional) – List of telegram.MessageEntity types

as strings. If the type attribute of an entity is contained in this list, it will be returned.
Defaults to a list of all types. All types can be found as constants in telegram.
MessageEntity.
Returns A dictionary of entities mapped to the text that belongs to them, calculated based
on UTF-16 codepoints.
Return type Dict[telegram.MessageEntity, str]

parse_caption_entity(entity)
Returns the text from a given telegram.MessageEntity.

Note: This method is present because Telegram calculates the offset and length in UTF-16 code-
point pairs, which some versions of Python don’t handle automatically. (That is, you can’t just slice
Message.caption with the offset and length.)

Parameters entity (telegram.MessageEntity) – The entity to extract the text

from. It must be an entity that belongs to this message.
Returns The text of the given entity

148 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Return type str

parse_entities(types=None)
Returns a dict that maps telegram.MessageEntity to str. It contains entities from this
message filtered by their telegram.MessageEntity.type attribute as the key, and the text that
each entity belongs to as the value of the dict.

Note: This method should always be used instead of the entities attribute, since it calculates the
correct substring from the message text based on UTF-16 codepoints. See parse_entity for more
info.

Parameters types (List[str], optional) – List of telegram.MessageEntity types

as strings. If the type attribute of an entity is contained in this list, it will be returned.
Defaults to a list of all types. All types can be found as constants in telegram.
MessageEntity.
Returns A dictionary of entities mapped to the text that belongs to them, calculated based
on UTF-16 codepoints.
Return type Dict[telegram.MessageEntity, str]

parse_entity(entity)
Returns the text from a given telegram.MessageEntity.

Note: This method is present because Telegram calculates the offset and length in UTF-16 code-
point pairs, which some versions of Python don’t handle automatically. (That is, you can’t just slice
Message.text with the offset and length.)

Parameters entity (telegram.MessageEntity) – The entity to extract the text

from. It must be an entity that belongs to this message.
Returns The text of the given entity
Return type str

reply_animation(*args, **kwargs)
Shortcut for:

bot.send_animation(update.message.chat_id, *args, **kwargs)

Keyword Arguments quote (bool, optional) – If set to True, the animation is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message

reply_audio(*args, **kwargs)
Shortcut for:

bot.send_audio(update.message.chat_id, *args, **kwargs)

Keyword Arguments quote (bool, optional) – If set to True, the audio is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.

3.2. telegram package 149

Python Telegram Bot Documentation, Release 12.8

Return type telegram.Message

reply_contact(*args, **kwargs)
Shortcut for:

bot.send_contact(update.message.chat_id, *args, **kwargs)

Keyword Arguments quote (bool, optional) – If set to True, the contact is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message

reply_dice(*args, **kwargs)
Shortcut for:

bot.send_dice(update.message.chat_id, *args, **kwargs)

Keyword Arguments quote (bool, optional) – If set to True, the dice is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message

reply_document(*args, **kwargs)
Shortcut for:

bot.send_document(update.message.chat_id, *args, **kwargs)

Keyword Arguments quote (bool, optional) – If set to True, the document is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message

reply_html(*args, **kwargs)
Shortcut for:

bot.send_message(update.message.chat_id, parse_mode=ParseMode.HTML, *args,

˓→**kwargs)

Sends a message with HTML formatting.

Keyword Arguments quote (bool, optional) – If set to True, the message is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message
reply_location(*args, **kwargs)
Shortcut for:

bot.send_location(update.message.chat_id, *args, **kwargs)

150 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Keyword Arguments quote (bool, optional) – If set to True, the location is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message

reply_markdown(*args, **kwargs)
Shortcut for:

bot.send_message(update.message.chat_id, parse_mode=ParseMode.MARKDOWN,
˓→*args,

**kwargs)

Sends a message with markdown version 1 formatting.

Keyword Arguments quote (bool, optional) – If set to True, the message is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message
reply_markdown_v2(*args, **kwargs)
Shortcut for:

bot.send_message(update.message.chat_id, parse_mode=ParseMode.MARKDOWN_V2,
˓→*args,

**kwargs)

Sends a message with markdown version 2 formatting.

Keyword Arguments quote (bool, optional) – If set to True, the message is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message
reply_media_group(*args, **kwargs)
Shortcut for:

bot.reply_media_group(update.message.chat_id, *args, **kwargs)

Keyword Arguments quote (bool, optional) – If set to True, the media group is sent
as an actual reply to this message. If reply_to_message_id is passed in kwargs,
this parameter will be ignored. Default: True in group chats and False in private
chats.
Returns An array of the sent Messages.
Return type List[telegram.Message]
Raises telegram.TelegramError

reply_photo(*args, **kwargs)
Shortcut for:

bot.send_photo(update.message.chat_id, *args, **kwargs)

3.2. telegram package 151

Python Telegram Bot Documentation, Release 12.8

Keyword Arguments quote (bool, optional) – If set to True, the photo is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message

reply_poll(*args, **kwargs)
Shortcut for:

bot.send_poll(update.message.chat_id, *args, **kwargs)

Keyword Arguments quote (bool, optional) – If set to True, the poll is sent as an ac-
tual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message

reply_sticker(*args, **kwargs)
Shortcut for:

bot.send_sticker(update.message.chat_id, *args, **kwargs)

Keyword Arguments quote (bool, optional) – If set to True, the sticker is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message

reply_text(*args, **kwargs)
Shortcut for:

bot.send_message(update.message.chat_id, *args, **kwargs)

Keyword Arguments quote (bool, optional) – If set to True, the message is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message

reply_venue(*args, **kwargs)
Shortcut for:

bot.send_venue(update.message.chat_id, *args, **kwargs)

Keyword Arguments quote (bool, optional) – If set to True, the venue is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message

reply_video(*args, **kwargs)
Shortcut for:

152 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

bot.send_video(update.message.chat_id, *args, **kwargs)

Keyword Arguments quote (bool, optional) – If set to True, the video is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message

reply_video_note(*args, **kwargs)
Shortcut for:

bot.send_video_note(update.message.chat_id, *args, **kwargs)

Keyword Arguments quote (bool, optional) – If set to True, the video note is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message

reply_voice(*args, **kwargs)
Shortcut for:

bot.send_voice(update.message.chat_id, *args, **kwargs)

Keyword Arguments quote (bool, optional) – If set to True, the voice note is sent as an
actual reply to this message. If reply_to_message_id is passed in kwargs, this
parameter will be ignored. Default: True in group chats and False in private chats.
Returns On success, instance representing the message posted.
Return type telegram.Message

stop_poll(*args, **kwargs)
Shortcut for:

bot.stop_poll(chat_id=message.chat_id,
message_id=message.message_id,
*args,
**kwargs)

Returns
On success, the stopped Poll with the final results is returned.
Return type telegram.Poll

text_html
Creates an HTML-formatted string from the markup entities found in the message.
Use this if you want to retrieve the message text with the entities formatted as HTML in the same way
the original message was formatted.
Returns Message text with entities formatted as HTML.
Return type str

3.2. telegram package 153

Python Telegram Bot Documentation, Release 12.8

text_html_urled
Creates an HTML-formatted string from the markup entities found in the message.
Use this if you want to retrieve the message text with the entities formatted as HTML. This also formats
telegram.MessageEntity.URL as a hyperlink.
Returns Message text with entities formatted as HTML.
Return type str
text_markdown
Creates an Markdown-formatted string from the markup entities found in the message using
telegram.ParseMode.MARKDOWN .
Use this if you want to retrieve the message text with the entities formatted as Markdown in the same
way the original message was formatted.
Returns Message text with entities formatted as Markdown.
Return type str
text_markdown_urled
Creates an Markdown-formatted string from the markup entities found in the message using
telegram.ParseMode.MARKDOWN .
Use this if you want to retrieve the message text with the entities formatted as Markdown. This also
formats telegram.MessageEntity.URL as a hyperlink.
Returns Message text with entities formatted as Markdown.
Return type str
text_markdown_v2
Creates an Markdown-formatted string from the markup entities found in the message using
telegram.ParseMode.MARKDOWN_V2.
Use this if you want to retrieve the message text with the entities formatted as Markdown in the same
way the original message was formatted.
Returns Message text with entities formatted as Markdown.
Return type str
text_markdown_v2_urled
Creates an Markdown-formatted string from the markup entities found in the message using
telegram.ParseMode.MARKDOWN_V2.
Use this if you want to retrieve the message text with the entities formatted as Markdown. This also
formats telegram.MessageEntity.URL as a hyperlink.
Returns Message text with entities formatted as Markdown.
Return type str

3.2.32 telegram.MessageEntity

class telegram.MessageEntity(type, offset, length, url=None, user=None, language=None,

**kwargs)
Bases: telegram.base.TelegramObject
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
type
Type of the entity.
Type str
offset
Offset in UTF-16 code units to the start of the entity.

154 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Type int
length
Length of the entity in UTF-16 code units.
Type int
url
Optional. Url that will be opened after user taps on the text.
Type str
user
Optional. The mentioned user.
Type telegram.User
language
Optional. Programming language of the entity text
Type str

Parameters
• type (str) – Type of the entity. Can be mention (@username), hashtag,
bot_command, url, email, bold (bold text), italic (italic text), code (monowidth string),
pre (monowidth block), text_link (for clickable text URLs), text_mention (for users
without usernames).
• offset (int) – Offset in UTF-16 code units to the start of the entity.
• length (int) – Length of the entity in UTF-16 code units.
• url (str, optional) – For TEXT_LINK only, url that will be opened after usertaps on
the text.
• user (telegram.User, optional) – For TEXT_MENTION only, the mentioned user.
• language (str, optional) – For PRE only, the programming language of the entity
text

ALL_TYPES = ['mention', 'hashtag', 'cashtag', 'phone_number', 'bot_command', 'url',

List of all the types.
Type List[str]
BOLD = 'bold'
‘bold’
Type str
BOT_COMMAND = 'bot_command'
‘bot_command’
Type str
CASHTAG = 'cashtag'
‘cashtag’
Type str
CODE = 'code'
‘code’
Type str
EMAIL = 'email'
‘email’
Type str

3.2. telegram package 155

Python Telegram Bot Documentation, Release 12.8

HASHTAG = 'hashtag'
‘hashtag’
Type str
ITALIC = 'italic'
‘italic’
Type str
MENTION = 'mention'
‘mention’
Type str
PHONE_NUMBER = 'phone_number'
‘phone_number’
Type str
PRE = 'pre'
‘pre’
Type str
STRIKETHROUGH = 'strikethrough'
‘strikethrough’
Type str
TEXT_LINK = 'text_link'
‘text_link’
Type str
TEXT_MENTION = 'text_mention'
‘text_mention’
Type str
UNDERLINE = 'underline'
‘underline’
Type str
URL = 'url'
‘url’
Type str

3.2.33 telegram.ParseMode

class telegram.ParseMode
Bases: object
This object represents a Telegram Message Parse Modes.
HTML = 'HTML'
‘HTML’
Type str
MARKDOWN = 'Markdown'
‘Markdown’
Type str
MARKDOWN_V2 = 'MarkdownV2'
‘MarkdownV2’

156 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Type str

3.2.34 telegram.PhotoSize

class telegram.PhotoSize(file_id, file_unique_id, width, height, file_size=None, bot=None,

**kwargs)
Bases: telegram.base.TelegramObject
This object represents one size of a photo or a file/sticker thumbnail.
file_id
Unique identifier for this file.
Type str
file_unique_id
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t
be used to download or reuse the file.
Type str
width
Photo width.
Type int
height
Photo height.
Type int
file_size
Optional. File size.
Type int
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot

Parameters
• file_id (str) – Identifier for this file, which can be used to download or reuse the
file.
• file_unique_id (str) – Unique and the same over time and for different bots file
identifier.
• width (int) – Photo width.
• height (int) – Photo height.
• file_size (int, optional) – File size.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• **kwargs (dict) – Arbitrary keyword arguments.

get_file(timeout=None, **kwargs)
Convenience wrapper over telegram.Bot.get_file
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.

3.2. telegram package 157

Python Telegram Bot Documentation, Release 12.8

Returns telegram.File
Raises telegram.TelegramError

3.2.35 telegram.Poll

class telegram.Poll(id, question, options, total_voter_count, is_closed, is_anonymous, type, al-

lows_multiple_answers, correct_option_id=None, explanation=None, expla-
nation_entities=None, open_period=None, close_date=None, **kwargs)
Bases: telegram.base.TelegramObject
This object contains information about a poll.
id
Unique poll identifier.
Type str
question
Poll question, 1-255 characters.
Type str
options
List of poll options.
Type List[PollOption]
total_voter_count
Total number of users that voted in the poll.
Type int
is_closed
True, if the poll is closed.
Type bool
is_anonymous
True, if the poll is anonymous.
Type bool
type
Poll type, currently can be REGULAR or QUIZ.
Type str
allows_multiple_answers
True, if the poll allows multiple answers.
Type bool
correct_option_id
Optional. Identifier of the correct answer option.
Type int
explanation
Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a
quiz-style poll.
Type str
explanation_entities
Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the
explanation.
Type List[telegram.MessageEntity]

158 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

open_period
Optional. Amount of time in seconds the poll will be active after creation.
Type int
close_date
Optional. Point in time when the poll will be automatically closed.
Type datetime.datetime

Parameters
• id (str) – Unique poll identifier.
• question (str) – Poll question, 1-255 characters.
• options (List[PollOption]) – List of poll options.
• is_closed (bool) – True, if the poll is closed.
• is_anonymous (bool) – True, if the poll is anonymous.
• type (str) – Poll type, currently can be REGULAR or QUIZ.
• allows_multiple_answers (bool) – True, if the poll allows multiple answers.
• correct_option_id (int, optional) – 0-based identifier of the correct answer op-
tion. Available only for polls in the quiz mode, which are closed, or was sent (not
forwarded) by the bot or to the private chat with the bot.
• explanation (str, optional) – Text that is shown when a user chooses an incorrect
answer or taps on the lamp icon in a quiz-style poll, 0-200 characters.
• explanation_entities (List[telegram.MessageEntity], optional) – Spe-
cial entities like usernames, URLs, bot commands, etc. that appear in the
explanation.
• open_period (int, optional) – Amount of time in seconds the poll will be active
after creation.
• close_date (datetime.datetime, optional) – Point in time (Unix timestamp)
when the poll will be automatically closed. Converted to datetime.datetime.

QUIZ = 'quiz'
‘quiz’
Type str
REGULAR = 'regular'
‘regular’
Type str
parse_explanation_entities(types=None)
Returns a dict that maps telegram.MessageEntity to str. It contains entities from this polls
explanation filtered by their type attribute as the key, and the text that each entity belongs to as the
value of the dict.

Note: This method should always be used instead of the explanation_entities attribute,
since it calculates the correct substring from the message text based on UTF-16 codepoints. See
parse_explanation_entity for more info.

Parameters types (List[str], optional) – List of MessageEntity types as strings. If

the type attribute of an entity is contained in this list, it will be returned. Defaults to
telegram.MessageEntity.ALL_TYPES.

3.2. telegram package 159

Python Telegram Bot Documentation, Release 12.8

Returns A dictionary of entities mapped to the text that belongs to them, calculated based
on UTF-16 codepoints.
Return type Dict[telegram.MessageEntity, str]

parse_explanation_entity(entity)
Returns the text from a given telegram.MessageEntity.

Note: This method is present because Telegram calculates the offset and length in UTF-16 code-
point pairs, which some versions of Python don’t handle automatically. (That is, you can’t just slice
Message.text with the offset and length.)

Parameters entity (telegram.MessageEntity) – The entity to extract the text

from. It must be an entity that belongs to this message.
Returns The text of the given entity.
Return type str

3.2.36 telegram.PollAnswer

class telegram.PollAnswer(poll_id, user, option_ids, **kwargs)

Bases: telegram.base.TelegramObject
This object represents an answer of a user in a non-anonymous poll.
poll_id
Unique poll identifier.
Type str
user
The user, who changed the answer to the poll.
Type telegram.User
option_ids
Identifiers of answer options, chosen by the user.
Type List[int]

Parameters
• poll_id (str) – Unique poll identifier.
• user (telegram.User) – The user, who changed the answer to the poll.
• option_ids (List[int]) – 0-based identifiers of answer options, chosen by the user.
May be empty if the user retracted their vote.

3.2.37 telegram.PollOption

class telegram.PollOption(text, voter_count, **kwargs)

Bases: telegram.base.TelegramObject
This object contains information about one answer option in a poll.
text
Option text, 1-100 characters.
Type str

160 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

voter_count
Number of users that voted for this option.
Type int

Parameters
• text (str) – Option text, 1-100 characters.
• voter_count (int) – Number of users that voted for this option.

3.2.38 telegram.ReplyKeyboardRemove

class telegram.ReplyKeyboardRemove(selective=False, **kwargs)

Bases: telegram.replymarkup.ReplyMarkup
Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and
display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent
by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a
button (see telegram.ReplyKeyboardMarkup).
remove_keyboard
Requests clients to remove the custom keyboard.
Type True
selective
Optional. Use this parameter if you want to remove the keyboard for specific users only.
Type bool

Example
A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for
that user, while still showing the keyboard with poll options to users who haven’t voted yet.

Parameters
• selective (bool, optional) – Use this parameter if you want to remove the keyboard
for specific users only. Targets:
1) users that are @mentioned in the text of the Message object
2) if the bot’s message is a reply (has reply_to_message_id), sender of the original mes-
sage.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2.39 telegram.ReplyKeyboardMarkup

class telegram.ReplyKeyboardMarkup(keyboard, resize_keyboard=False,

one_time_keyboard=False, selective=False,
**kwargs)
Bases: telegram.replymarkup.ReplyMarkup
This object represents a custom keyboard with reply options.
keyboard
Array of button rows.
Type List[List[telegram.KeyboardButton | str]]
resize_keyboard
Optional. Requests clients to resize the keyboard.

3.2. telegram package 161

Python Telegram Bot Documentation, Release 12.8

Type bool
one_time_keyboard
Optional. Requests clients to hide the keyboard as soon as it’s been used.
Type bool
selective
Optional. Show the keyboard to specific users only.
Type bool

Example
A user requests to change the bot’s language, bot replies to the request with a keyboard to select the new
language. Other users in the group don’t see the keyboard.

Parameters
• keyboard (List[List[str | telegram.KeyboardButton]]) – Array of button
rows, each represented by an Array of telegram.KeyboardButton objects.
• resize_keyboard (bool, optional) – Requests clients to resize the keyboard ver-
tically for optimal fit (e.g., make the keyboard smaller if there are just two rows of
buttons). Defaults to false, in which case the custom keyboard is always of the same
height as the app’s standard keyboard. Defaults to False
• one_time_keyboard (bool, optional) – Requests clients to hide the keyboard as
soon as it’s been used. The keyboard will still be available, but clients will automatically
display the usual letter-keyboard in the chat - the user can press a special button in the
input field to see the custom keyboard again. Defaults to False.
• selective (bool, optional) – Use this parameter if you want to show the keyboard
to specific users only. Targets:
1) users that are @mentioned in the text of the Message object
2) if the bot’s message is a reply (has reply_to_message_id), sender of the original mes-
sage.
Defaults to False.
• **kwargs (dict) – Arbitrary keyword arguments.

classmethod from_button(button, resize_keyboard=False, one_time_keyboard=False, selec-

tive=False, **kwargs)
Shortcut for:

ReplyKeyboardMarkup([[button]], **kwargs)

Return an ReplyKeyboardMarkup from a single KeyboardButton

Parameters
• button (telegram.KeyboardButton | str) – The button to use in the markup
• resize_keyboard (bool, optional) – Requests clients to resize the keyboard ver-
tically for optimal fit (e.g., make the keyboard smaller if there are just two rows of
buttons). Defaults to false, in which case the custom keyboard is always of the same
height as the app’s standard keyboard. Defaults to False
• one_time_keyboard (bool, optional) – Requests clients to hide the keyboard as
soon as it’s been used. The keyboard will still be available, but clients will automati-
cally display the usual letter-keyboard in the chat - the user can press a special button
in the input field to see the custom keyboard again. Defaults to False.

162 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• selective (bool, optional) – Use this parameter if you want to show the keyboard
to specific users only. Targets:
1) users that are @mentioned in the text of the Message object
2) if the bot’s message is a reply (has reply_to_message_id), sender of the
original message.
Defaults to False.
• **kwargs (dict) – Arbitrary keyword arguments.
classmethod from_column(button_column, resize_keyboard=False,
one_time_keyboard=False, selective=False, **kwargs)
Shortcut for:
ReplyKeyboardMarkup([[button] for button in button_column], **kwargs)

Return an ReplyKeyboardMarkup from a single column of KeyboardButtons

Parameters
• button_column (List[telegram.KeyboardButton | str]) – The button to
use in the markup
• resize_keyboard (bool, optional) – Requests clients to resize the keyboard ver-
tically for optimal fit (e.g., make the keyboard smaller if there are just two rows of
buttons). Defaults to false, in which case the custom keyboard is always of the same
height as the app’s standard keyboard. Defaults to False
• one_time_keyboard (bool, optional) – Requests clients to hide the keyboard as
soon as it’s been used. The keyboard will still be available, but clients will automati-
cally display the usual letter-keyboard in the chat - the user can press a special button
in the input field to see the custom keyboard again. Defaults to False.
• selective (bool, optional) – Use this parameter if you want to show the keyboard
to specific users only. Targets:
1) users that are @mentioned in the text of the Message object
2) if the bot’s message is a reply (has reply_to_message_id), sender of the
original message.
Defaults to False.
• **kwargs (dict) – Arbitrary keyword arguments.
classmethod from_row(button_row, resize_keyboard=False, one_time_keyboard=False, se-
lective=False, **kwargs)
Shortcut for:
ReplyKeyboardMarkup([button_row], **kwargs)

Return an ReplyKeyboardMarkup from a single row of KeyboardButtons

Parameters
• button_row (List[telegram.KeyboardButton | str]) – The button to use in
the markup
• resize_keyboard (bool, optional) – Requests clients to resize the keyboard ver-
tically for optimal fit (e.g., make the keyboard smaller if there are just two rows of
buttons). Defaults to false, in which case the custom keyboard is always of the same
height as the app’s standard keyboard. Defaults to False
• one_time_keyboard (bool, optional) – Requests clients to hide the keyboard as
soon as it’s been used. The keyboard will still be available, but clients will automati-
cally display the usual letter-keyboard in the chat - the user can press a special button
in the input field to see the custom keyboard again. Defaults to False.

3.2. telegram package 163

Python Telegram Bot Documentation, Release 12.8

• selective (bool, optional) – Use this parameter if you want to show the keyboard
to specific users only. Targets:
1) users that are @mentioned in the text of the Message object
2) if the bot’s message is a reply (has reply_to_message_id), sender of the
original message.
Defaults to False.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2.40 telegram.ReplyMarkup

class telegram.ReplyMarkup
Bases: telegram.base.TelegramObject
Base class for Telegram ReplyMarkup Objects.
See telegram.ReplyKeyboardMarkup and telegram.InlineKeyboardMarkup for detailed
use.

3.2.41 telegram.TelegramObject

class telegram.TelegramObject
Bases: object
Base class for most telegram objects.
to_json()
Returns str

3.2.42 telegram.Update

class telegram.Update(update_id, message=None, edited_message=None, chan-

nel_post=None, edited_channel_post=None, inline_query=None, cho-
sen_inline_result=None, callback_query=None, shipping_query=None,
pre_checkout_query=None, poll=None, poll_answer=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents an incoming update.

Note: At most one of the optional parameters can be present in any given update.

update_id
The update’s unique identifier.
Type int
message
Optional. New incoming message.
Type telegram.Message
edited_message
Optional. New version of a message.
Type telegram.Message
channel_post
Optional. New incoming channel post.

164 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Type telegram.Message
edited_channel_post
Optional. New version of a channel post.
Type telegram.Message
inline_query
Optional. New incoming inline query.
Type telegram.InlineQuery
chosen_inline_result
Optional. The result of an inline query that was chosen by a user.
Type telegram.ChosenInlineResult
callback_query
Optional. New incoming callback query.
Type telegram.CallbackQuery
shipping_query
Optional. New incoming shipping query.
Type telegram.ShippingQuery
pre_checkout_query
Optional. New incoming pre-checkout query.
Type telegram.PreCheckoutQuery
poll
Optional. New poll state. Bots receive only updates about stopped polls and polls, which are sent by
the bot
Type telegram.Poll
poll_answer
Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls
that were sent by the bot itself.
Type telegram.PollAnswer

Parameters
• update_id (int) – The update’s unique identifier. Update identifiers start from a
certain positive number and increase sequentially. This ID becomes especially handy if
you’re using Webhooks, since it allows you to ignore repeated updates or to restore the
correct update sequence, should they get out of order.
• message (telegram.Message, optional) – New incoming message of any kind -
text, photo, sticker, etc.
• edited_message (telegram.Message, optional) – New version of a message
that is known to the bot and was edited.
• channel_post (telegram.Message, optional) – New incoming channel post of
any kind - text, photo, sticker, etc.
• edited_channel_post (telegram.Message, optional) – New version of a
channel post that is known to the bot and was edited.
• inline_query (telegram.InlineQuery, optional) – New incoming inline
query.
• chosen_inline_result (telegram.ChosenInlineResult, optional) –
The result of an inline query that was chosen by a user and sent to their chat partner.

3.2. telegram package 165

Python Telegram Bot Documentation, Release 12.8

• callback_query (telegram.CallbackQuery, optional) – New incoming

callback query.
• shipping_query (telegram.ShippingQuery, optional) – New incoming
shipping query. Only for invoices with flexible price.
• pre_checkout_query (telegram.PreCheckoutQuery, optional) – New in-
coming pre-checkout query. Contains full information about checkout
• poll (telegram.Poll, optional) – New poll state. Bots receive only updates about
polls, which are sent or stopped by the bot
• poll_answer (telegram.PollAnswer, optional) – A user changed their answer
in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot
itself.
• **kwargs (dict) – Arbitrary keyword arguments.

classmethod de_json(data, bot)

effective_chat
The chat that this update was sent in, no matter what kind of update this is. Will be None
for inline_query, chosen_inline_result, callback_query from inline messages,
shipping_query, pre_checkout_query, poll and poll_answer.
Type telegram.Chat
effective_message
The message included in this update, no matter what kind of update this is. Will be None
for inline_query, chosen_inline_result, callback_query from inline messages,
shipping_query, pre_checkout_query, poll and poll_answer.
Type telegram.Message
effective_user
The user that sent this update, no matter what kind of update this is. Will be None for
channel_post and poll.
Type telegram.User

3.2.43 telegram.User

class telegram.User(id, first_name, is_bot, last_name=None, user-

name=None, language_code=None, can_join_groups=None,
can_read_all_group_messages=None, supports_inline_queries=None,
bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a Telegram user or bot.
id
Unique identifier for this user or bot.
Type int
is_bot
True, if this user is a bot
Type bool
first_name
User’s or bot’s first name.
Type str
last_name
Optional. User’s or bot’s last name.

166 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Type str
username
Optional. User’s or bot’s username.
Type str
language_code
Optional. IETF language tag of the user’s language.
Type str
can_join_groups
Optional. True, if the bot can be invited to groups. Returned only in telegram.Bot.get_me
requests.
Type str
can_read_all_group_messages
Optional. True, if privacy mode is disabled for the bot. Returned only in telegram.Bot.get_me
requests.
Type str
supports_inline_queries
Optional. True, if the bot supports inline queries. Returned only in telegram.Bot.get_me re-
quests.
Type str
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot

Parameters
• id (int) – Unique identifier for this user or bot.
• is_bot (bool) – True, if this user is a bot
• first_name (str) – User’s or bot’s first name.
• last_name (str, optional) – User’s or bot’s last name.
• username (str, optional) – User’s or bot’s username.
• language_code (str, optional) – IETF language tag of the user’s language.
• can_join_groups (str, optional) – True, if the bot can be invited to groups. Re-
turned only in telegram.Bot.get_me requests.
• can_read_all_group_messages (str, optional) – True, if privacy mode is dis-
abled for the bot. Returned only in telegram.Bot.get_me requests.
• supports_inline_queries (str, optional) – True, if the bot supports inline
queries. Returned only in telegram.Bot.get_me requests.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.

classmethod de_json(data, bot)

classmethod de_list(data, bot)
full_name
Convenience property. The user’s first_name, followed by (if available) last_name.
Type str
get_profile_photos(*args, **kwargs)
Shortcut for:

3.2. telegram package 167

Python Telegram Bot Documentation, Release 12.8

bot.get_user_profile_photos(update.message.from_user.id, *args, **kwargs)

link
Convenience property. If username is available, returns a t.me link of the user.
Type str
mention_html(name=None)
Parameters name (str) – The name used as a link for the user. Defaults to full_name.
Returns The inline mention for the user as HTML.
Return type str
mention_markdown(name=None)
Parameters name (str) – The name used as a link for the user. Defaults to full_name.
Returns The inline mention for the user as markdown (version 1).
Return type str
mention_markdown_v2(name=None)
Parameters name (str) – The name used as a link for the user. Defaults to full_name.
Returns The inline mention for the user as markdown (version 2).
Return type str
name
Convenience property. If available, returns the user’s username prefixed with “@”. If username
is not available, returns full_name.
Type str
send_animation(*args, **kwargs)
Shortcut for:

bot.send_animation(User.id, *args, **kwargs)

Where User is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_audio(*args, **kwargs)
Shortcut for:

bot.send_audio(User.id, *args, **kwargs)

Where User is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_document(*args, **kwargs)
Shortcut for:

bot.send_document(User.id, *args, **kwargs)

Where User is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message

168 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

send_message(*args, **kwargs)
Shortcut for:

bot.send_message(User.id, *args, **kwargs)

Where User is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_photo(*args, **kwargs)
Shortcut for:

bot.send_photo(User.id, *args, **kwargs)

Where User is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_poll(*args, **kwargs)
Shortcut for:

bot.send_poll(User.id, *args, **kwargs)

Where User is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_sticker(*args, **kwargs)
Shortcut for:

bot.send_sticker(User.id, *args, **kwargs)

Where User is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_video(*args, **kwargs)
Shortcut for:

bot.send_video(User.id, *args, **kwargs)

Where User is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_video_note(*args, **kwargs)
Shortcut for:

bot.send_video_note(User.id, *args, **kwargs)

Where User is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message
send_voice(*args, **kwargs)
Shortcut for:

3.2. telegram package 169

Python Telegram Bot Documentation, Release 12.8

bot.send_voice(User.id, *args, **kwargs)

Where User is the current instance.

Returns On success, instance representing the message posted.
Return type telegram.Message

3.2.44 telegram.UserProfilePhotos

class telegram.UserProfilePhotos(total_count, photos, **kwargs)

Bases: telegram.base.TelegramObject
This object represent a user’s profile pictures.
total_count
Total number of profile pictures.
Type int
photos
Requested profile pictures.
Type List[List[telegram.PhotoSize]]

Parameters
• total_count (int) – Total number of profile pictures the target user has.
• photos (List[List[telegram.PhotoSize]]) – Requested profile pictures (in up to
4 sizes each).

3.2.45 telegram.Venue

class telegram.Venue(location, title, address, foursquare_id=None, foursquare_type=None,

**kwargs)
Bases: telegram.base.TelegramObject
This object represents a venue.
location
Venue location.
Type telegram.Location
title
Name of the venue.
Type str
address
Address of the venue.
Type str
foursquare_id
Optional. Foursquare identifier of the venue.
Type str
foursquare_type
Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”,
“arts_entertainment/aquarium” or “food/icecream”.)
Type str

170 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Parameters
• location (telegram.Location) – Venue location.
• title (str) – Name of the venue.
• address (str) – Address of the venue.
• foursquare_id (str, optional) – Foursquare identifier of the venue.
• foursquare_type (str, optional) – Foursquare type of the venue. (For example,
“arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
• **kwargs (dict) – Arbitrary keyword arguments.

3.2.46 telegram.Video

class telegram.Video(file_id, file_unique_id, width, height, duration, thumb=None,

mime_type=None, file_size=None, bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a video file.
file_id
Unique identifier for this file.
Type str
file_unique_id
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t
be used to download or reuse the file.
Type str
width
Video width as defined by sender.
Type int
height
Video height as defined by sender.
Type int
duration
Duration of the video in seconds as defined by sender.
Type int
thumb
Optional. Video thumbnail.
Type telegram.PhotoSize
mime_type
Optional. Mime type of a file as defined by sender.
Type str
file_size
Optional. File size.
Type int
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot

Parameters

3.2. telegram package 171

Python Telegram Bot Documentation, Release 12.8

• file_id (str) – Identifier for this file, which can be used to download or reuse the
file.
• file_unique_id (str) – Unique and the same over time and for different bots file
identifier.
• width (int) – Video width as defined by sender.
• height (int) – Video height as defined by sender.
• duration (int) – Duration of the video in seconds as defined by sender.
• thumb (telegram.PhotoSize, optional) – Video thumbnail.
• mime_type (str, optional) – Mime type of a file as defined by sender.
• file_size (int, optional) – File size.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• **kwargs (dict) – Arbitrary keyword arguments.

get_file(timeout=None, **kwargs)
Convenience wrapper over telegram.Bot.get_file
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.File
Raises telegram.TelegramError

3.2.47 telegram.VideoNote

class telegram.VideoNote(file_id, file_unique_id, length, duration, thumb=None,

file_size=None, bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a video message (available in Telegram apps as of v.4.0).
file_id
Unique identifier for this file.
Type str
file_unique_id
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t
be used to download or reuse the file.
Type str
length
Video width and height as defined by sender.
Type int
duration
Duration of the video in seconds as defined by sender.
Type int
thumb
Optional. Video thumbnail.
Type telegram.PhotoSize

172 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

file_size
Optional. File size.
Type int
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot

Parameters
• file_id (str) – Identifier for this file, which can be used to download or reuse the
file.
• file_unique_id (str) – Unique and the same over time and for different bots file
identifier.
• length (int) – Video width and height as defined by sender.
• duration (int) – Duration of the video in seconds as defined by sender.
• thumb (telegram.PhotoSize, optional) – Video thumbnail.
• file_size (int, optional) – File size.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• **kwargs (dict) – Arbitrary keyword arguments.

get_file(timeout=None, **kwargs)
Convenience wrapper over telegram.Bot.get_file
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.File
Raises telegram.TelegramError

3.2.48 telegram.Voice

class telegram.Voice(file_id, file_unique_id, duration, mime_type=None, file_size=None,

bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a voice note.
file_id
Unique identifier for this file.
Type str
file_unique_id
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t
be used to download or reuse the file.
Type str
duration
Duration of the audio in seconds as defined by sender.
Type int

3.2. telegram package 173

Python Telegram Bot Documentation, Release 12.8

mime_type
Optional. MIME type of the file as defined by sender.
Type str
file_size
Optional. File size.
Type int
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot

Parameters
• file_id (str) – Identifier for this file, which can be used to download or reuse the
file.
• file_unique_id (str) – Unique and the same over time and for different bots file
identifier.
• duration (int, optional) – Duration of the audio in seconds as defined by sender.
• mime_type (str, optional) – MIME type of the file as defined by sender.
• file_size (int, optional) – File size.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• **kwargs (dict) – Arbitrary keyword arguments.

get_file(timeout=None, **kwargs)
Convenience wrapper over telegram.Bot.get_file
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.File
Raises telegram.TelegramError

3.2.49 telegram.WebhookInfo

class telegram.WebhookInfo(url, has_custom_certificate, pending_update_count,

last_error_date=None, last_error_message=None,
max_connections=None, allowed_updates=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a Telegram WebhookInfo.
Contains information about the current status of a webhook.
url
Webhook URL.
Type str
has_custom_certificate
If a custom certificate was provided for webhook.
Type bool

174 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

pending_update_count
Number of updates awaiting delivery.
Type int
last_error_date
Optional. Unix time for the most recent error that happened.
Type int
last_error_message
Optional. Error message in human-readable format.
Type str
max_connections
Optional. Maximum allowed number of simultaneous HTTPS connections.
Type int
allowed_updates
Optional. A list of update types the bot is subscribed to.
Type List[str]

Parameters
• url (str) – Webhook URL, may be empty if webhook is not set up.
• has_custom_certificate (bool) – True, if a custom certificate was provided
for webhook certificate checks.
• pending_update_count (int) – Number of updates awaiting delivery.
• last_error_date (int, optional) – Unix time for the most recent error that hap-
pened when trying todeliver an update via webhook.
• last_error_message (str, optional) – Error message in human-readable format
for the most recent error that happened when trying to deliver an update via webhook.
• max_connections (int, optional) – Maximum allowed number of simultaneous
HTTPS connections to the webhook for update delivery.
• allowed_updates (List[str], optional) – A list of update types the bot is sub-
scribed to. Defaults to all update types.

3.2.50 Stickers

telegram.Sticker

class telegram.Sticker(file_id, file_unique_id, width, height, is_animated, thumb=None,

emoji=None, file_size=None, set_name=None, mask_position=None,
bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a sticker.
file_id
Unique identifier for this file.
Type str
file_unique_id
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t
be used to download or reuse the file.
Type str

3.2. telegram package 175

Python Telegram Bot Documentation, Release 12.8

width
Sticker width.
Type int
height
Sticker height.
Type int
is_animated
True, if the sticker is animated.
Type bool
thumb
Optional. Sticker thumbnail in the .webp or .jpg format.
Type telegram.PhotoSize
emoji
Optional. Emoji associated with the sticker.
Type str
set_name
Optional. Name of the sticker set to which the sticker belongs.
Type str
mask_position
Optional. For mask stickers, the position where the mask should be placed.
Type telegram.MaskPosition
file_size
Optional. File size.
Type int
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot

Parameters
• file_id (str) – Identifier for this file, which can be used to download or reuse the
file.
• file_unique_id (str) – Unique and the same over time and for different bots file
identifier.
• width (int) – Sticker width.
• height (int) – Sticker height.
• is_animated (bool) – True, if the sticker is animated.
• thumb (telegram.PhotoSize, optional) – Sticker thumbnail in the .webp or .jpg
format.
• emoji (str, optional) – Emoji associated with the sticker
• set_name (str, optional) – Name of the sticker set to which the sticker belongs.
• mask_position (telegram.MaskPosition, optional) – For mask stickers, the
position where the mask should be placed.
• file_size (int, optional) – File size.
• (obj (**kwargs) – dict): Arbitrary keyword arguments.7

176 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• bot (telegram.Bot, optional) – The Bot to use for instance methods.

get_file(timeout=None, **kwargs)
Convenience wrapper over telegram.Bot.get_file
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.File
Raises telegram.TelegramError

telegram.StickerSet

class telegram.StickerSet(name, title, is_animated, contains_masks, stickers, bot=None,

thumb=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a sticker set.
name
Sticker set name.
Type str
title
Sticker set title.
Type str
is_animated
True, if the sticker set contains animated stickers.
Type bool
contains_masks
True, if the sticker set contains masks.
Type bool
stickers
List of all set stickers.
Type List[telegram.Sticker]
thumb
Optional. Sticker set thumbnail in the .WEBP or .TGS format
Type telegram.PhotoSize

Parameters
• name (str) – Sticker set name.
• title (str) – Sticker set title.
• is_animated (bool) – True, if the sticker set contains animated stickers.
• contains_masks (bool) – True, if the sticker set contains masks.
• stickers (List[telegram.Sticker]) – List of all set stickers.
• thumb (telegram.PhotoSize, optional) – Sticker set thumbnail in the .WEBP or
.TGS format

3.2. telegram package 177

Python Telegram Bot Documentation, Release 12.8

telegram.MaskPosition

class telegram.MaskPosition(point, x_shift, y_shift, scale, **kwargs)

Bases: telegram.base.TelegramObject
This object describes the position on faces where a mask should be placed by default.
point
The part of the face relative to which the mask should be placed.
Type str
x_shift
Shift by X-axis measured in widths of the mask scaled to the face size, from left to right.
Type float
y_shift
Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom.
Type float
scale
Mask scaling coefficient. For example, 2.0 means double size.
Type float

Note: type should be one of the following: forehead, eyes, mouth or chin. You can use the classconstants
for those.

Parameters
• point (str) – The part of the face relative to which the mask should be placed.
• x_shift (float) – Shift by X-axis measured in widths of the mask scaled to the face
size, from left to right. For example, choosing -1.0 will place mask just to the left of the
default mask position.
• y_shift (float) – Shift by Y-axis measured in heights of the mask scaled to the face
size, from top to bottom. For example, 1.0 will place the mask just below the default
mask position.
• scale (float) – Mask scaling coefficient. For example, 2.0 means double size.

CHIN = 'chin'
‘chin’
Type str
EYES = 'eyes'
‘eyes’
Type str
FOREHEAD = 'forehead'
‘forehead’
Type str
MOUTH = 'mouth'
‘mouth’
Type str

178 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

3.2.51 Inline Mode

telegram.InlineQuery

class telegram.InlineQuery(id, from_user, query, offset, location=None, bot=None, **kwargs)

Bases: telegram.base.TelegramObject
This object represents an incoming inline query. When the user sends an empty query, your bot could return
some default or trending results.

Note:
• In Python from is a reserved word, use from_user instead.

id
Unique identifier for this query.
Type str
from_user
Sender.
Type telegram.User
location
Optional. Sender location, only for bots that request user location.
Type telegram.Location
query
Text of the query (up to 256 characters).
Type str
offset
Offset of the results to be returned, can be controlled by the bot.
Type str

Parameters
• id (str) – Unique identifier for this query.
• from_user (telegram.User) – Sender.
• location (telegram.Location, optional) – Sender location, only for bots that
request user location.
• query (str) – Text of the query (up to 256 characters).
• offset (str) – Offset of the results to be returned, can be controlled by the bot.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• **kwargs (dict) – Arbitrary keyword arguments.

answer(*args, **kwargs)
Shortcut for:

bot.answer_inline_query(update.inline_query.id, *args, **kwargs)

Parameters
• results (List[telegram.InlineQueryResult]) – A list of results for the
inline query.

3.2. telegram package 179

Python Telegram Bot Documentation, Release 12.8

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

telegram.InlineQueryResult

class telegram.InlineQueryResult(type, id, **kwargs)

Bases: telegram.base.TelegramObject
Baseclass for the InlineQueryResult* classes.
type
Type of the result.
Type str
id
Unique identifier for this result, 1-64 Bytes.
Type str

Parameters
• type (str) – Type of the result.
• id (str) – Unique identifier for this result, 1-64 Bytes.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultArticle

class telegram.InlineQueryResultArticle(id, title, input_message_content,

reply_markup=None, url=None,
hide_url=None, description=None,
thumb_url=None, thumb_width=None,
thumb_height=None, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
This object represents a Telegram InlineQueryResultArticle.
type
‘article’.
Type str
id
Unique identifier for this result, 1-64 Bytes.
Type str

180 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

title
Title of the result.
Type str
input_message_content
Content of the message to be sent.
Type telegram.InputMessageContent
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.ReplyMarkup
url
Optional. URL of the result.
Type str
hide_url
Optional. Pass True, if you don’t want the URL to be shown in the message.
Type bool
description
Optional. Short description of the result.
Type str
thumb_url
Optional. Url of the thumbnail for the result.
Type str
thumb_width
Optional. Thumbnail width.
Type int
thumb_height
Optional. Thumbnail height.
Type int

Parameters
• id (str) – Unique identifier for this result, 1-64 Bytes.
• title (str) – Title of the result.
• input_message_content (telegram.InputMessageContent) – Content
of the message to be sent.
• reply_markup (telegram.ReplyMarkup, optional) – Inline keyboard attached
to the message
• url (str, optional) – URL of the result.
• hide_url (bool, optional) – Pass True, if you don’t want the URL to be shown in
the message.
• description (str, optional) – Short description of the result.
• thumb_url (str, optional) – Url of the thumbnail for the result.
• thumb_width (int, optional) – Thumbnail width.
• thumb_height (int, optional) – Thumbnail height.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2. telegram package 181

Python Telegram Bot Documentation, Release 12.8

telegram.InlineQueryResultAudio

class telegram.InlineQueryResultAudio(id, audio_url, title, performer=None,

audio_duration=None, cap-
tion=None, reply_markup=None,
input_message_content=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to an mp3 audio file. By default, this audio file will be sent by the user. Alternatively, you
can use input_message_content to send a message with the specified content instead of the audio.
type
‘audio’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
audio_url
A valid URL for the audio file.
Type str
title
Title.
Type str
performer
Optional. Performer.
Type str
audio_duration
Optional. Audio duration in seconds.
Type str
caption
Optional. Caption, 0-1024 characters after entities parsing.
Type str
parse_mode
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.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the audio.
Type telegram.InputMessageContent

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• audio_url (str) – A valid URL for the audio file.

182 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• title (str) – Title.

• performer (str, optional) – Performer.
• audio_duration (str, optional) – Audio duration in seconds.
• caption (str, optional) – Caption, 0-1024 characters after entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the audio.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultCachedAudio

class telegram.InlineQueryResultCachedAudio(id, audio_file_id, caption=None,

reply_markup=None, in-
put_message_content=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to an mp3 audio file stored on the Telegram servers. By default, this audio file will be sent
by the user. Alternatively, you can use input_message_content to send a message with the specified
content instead of the audio.
type
‘audio’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
audio_file_id
A valid file identifier for the audio file.
Type str
caption
Optional. Caption, 0-1024 characters after entities parsing.
Type str
parse_mode
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.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the audio.
Type telegram.InputMessageContent

3.2. telegram package 183

Python Telegram Bot Documentation, Release 12.8

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• audio_file_id (str) – A valid file identifier for the audio file.
• caption (str, optional) – Caption, 0-1024 characters after entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the audio.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultCachedDocument

class telegram.InlineQueryResultCachedDocument(id, title, document_file_id, de-

scription=None, caption=None,
reply_markup=None, in-
put_message_content=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with
an optional caption. Alternatively, you can use input_message_content to send a message with the
specified content instead of the file.
type
‘document’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
title
Title for the result.
Type str
document_file_id
A valid file identifier for the file.
Type str
description
Optional. Short description of the result.
Type str
caption
Optional. Caption of the document to be sent, 0-1024 characters after entities parsing.
Type str
parse_mode
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.

184 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the file.
Type telegram.InputMessageContent

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• title (str) – Title for the result.
• document_file_id (str) – A valid file identifier for the file.
• description (str, optional) – Short description of the result.
• caption (str, optional) – Caption of the document to be sent, 0-1024 characters after
entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption.. See the
constants in telegram.ParseMode for the available modes.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the file.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultCachedGif

class telegram.InlineQueryResultCachedGif(id, gif_file_id, title=None, cap-

tion=None, reply_markup=None,
input_message_content=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file
will be sent by the user with an optional caption. Alternatively, you can use input_message_content
to send a message with specified content instead of the animation.
type
‘gif’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
gif_file_id
A valid file identifier for the GIF file.
Type str
title
Optional. Title for the result.
Type str

3.2. telegram package 185

Python Telegram Bot Documentation, Release 12.8

caption
Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing.
Type str
parse_mode
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.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the gif.
Type telegram.InputMessageContent

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• gif_file_id (str) – A valid file identifier for the GIF file.
• title (str, optional) – Title for the result.caption (str, optional):
• caption (str, optional) – Caption of the GIF file to be sent, 0-1024 characters after
entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the gif.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultCachedMpeg4Gif

class telegram.InlineQueryResultCachedMpeg4Gif(id, mpeg4_file_id, title=None, cap-

tion=None, reply_markup=None,
input_message_content=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram
servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alterna-
tively, you can use input_message_content to send a message with the specified content instead of
the animation.
type
‘mpeg4_gif’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str

186 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

mpeg4_file_id
A valid file identifier for the MP4 file.
Type str
title
Optional. Title for the result.
Type str
caption
Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing.
Type str
parse_mode
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.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the MPEG-4 file.
Type telegram.InputMessageContent

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• mpeg4_file_id (str) – A valid file identifier for the MP4 file.
• title (str, optional) – Title for the result.
• caption (str, optional) – Caption of the MPEG-4 file to be sent, 0-1024 characters
after entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the MPEG-4 file.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultCachedPhoto

class telegram.InlineQueryResultCachedPhoto(id, photo_file_id, title=None, de-

scription=None, caption=None,
reply_markup=None, in-
put_message_content=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user
with an optional caption. Alternatively, you can use input_message_content to send a message with
the specified content instead of the photo.

3.2. telegram package 187

Python Telegram Bot Documentation, Release 12.8

type
‘photo’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
photo_file_id
A valid file identifier of the photo.
Type str
title
Optional. Title for the result.
Type str
description
Optional. Short description of the result.
Type str
caption
Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing.
Type str
parse_mode
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.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the photo.
Type telegram.InputMessageContent

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• photo_file_id (str) – A valid file identifier of the photo.
• title (str, optional) – Title for the result.
• description (str, optional) – Short description of the result.
• caption (str, optional) – Caption of the photo to be sent, 0-1024 characters after
entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the photo.
• **kwargs (dict) – Arbitrary keyword arguments.

188 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

telegram.InlineQueryResultCachedSticker

class telegram.InlineQueryResultCachedSticker(id, sticker_file_id, re-

ply_markup=None, in-
put_message_content=None,
**kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user.
Alternatively, you can use input_message_content to send a message with the specified content
instead of the sticker.
type
‘sticker‘.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
sticker_file_id
A valid file identifier of the sticker.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the sticker.
Type telegram.InputMessageContent

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• sticker_file_id (str) – A valid file identifier of the sticker.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the sticker.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultCachedVideo

class telegram.InlineQueryResultCachedVideo(id, video_file_id, title, description=None,

caption=None, reply_markup=None,
input_message_content=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the
user with an optional caption. Alternatively, you can use input_message_content to send a message
with the specified content instead of the video.
type
‘video’.

3.2. telegram package 189

Python Telegram Bot Documentation, Release 12.8

Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
video_file_id
A valid file identifier for the video file.
Type str
title
Title for the result.
Type str
description
Optional. Short description of the result.
Type str
caption
Optional. Caption of the video to be sent, 0-1024 characters after entities parsing.
Type str
parse_mode
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.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the video.
Type telegram.InputMessageContent

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• video_file_id (str) – A valid file identifier for the video file.
• title (str) – Title for the result.
• description (str, optional) – Short description of the result.
• caption (str, optional) – Caption of the video to be sent, 0-1024 characters after
entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the video.
• **kwargs (dict) – Arbitrary keyword arguments.

190 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

telegram.InlineQueryResultCachedVoice

class telegram.InlineQueryResultCachedVoice(id, voice_file_id, title, cap-

tion=None, reply_markup=None,
input_message_content=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to a voice message stored on the Telegram servers. By default, this voice message will
be sent by the user. Alternatively, you can use input_message_content to send a message with the
specified content instead of the voice message.
type
‘voice’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
voice_file_id
A valid file identifier for the voice message.
Type str
title
Voice message title.
Type str
caption
Optional. Caption, 0-1024 characters after entities parsing.
Type str
parse_mode
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.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the voice.
Type telegram.InputMessageContent

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• voice_file_id (str) – A valid file identifier for the voice message.
• title (str) – Voice message title.
• caption (str, optional) – Caption, 0-1024 characters after entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.

3.2. telegram package 191

Python Telegram Bot Documentation, Release 12.8

• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-

board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the voice.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultContact

class telegram.InlineQueryResultContact(id, phone_number, first_name,

last_name=None, reply_markup=None,
input_message_content=None,
thumb_url=None, thumb_width=None,
thumb_height=None, vcard=None, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively,
you can use input_message_content to send a message with the specified content instead of the
contact.
type
‘contact’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
phone_number
Contact’s phone number.
Type str
first_name
Contact’s first name.
Type str
last_name
Optional. Contact’s last name.
Type str
vcard
Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the contact.
Type telegram.InputMessageContent
thumb_url
Optional. Url of the thumbnail for the result.
Type str
thumb_width
Optional. Thumbnail width.

192 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Type int
thumb_height
Optional. Thumbnail height.
Type int

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• phone_number (str) – Contact’s phone number.
• first_name (str) – 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.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the contact.
• thumb_url (str, optional) – Url of the thumbnail for the result.
• thumb_width (int, optional) – Thumbnail width.
• thumb_height (int, optional) – Thumbnail height.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultDocument

class telegram.InlineQueryResultDocument(id, document_url, title, mime_type,

caption=None, description=None,
reply_markup=None, in-
put_message_content=None,
thumb_url=None, thumb_width=None,
thumb_height=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively,
you can use input_message_content to send a message with the specified content instead of the file.
Currently, only .PDF and .ZIP files can be sent using this method.
type
‘document’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
title
Title for the result.
Type str
caption
Optional. Caption of the document to be sent, 0-1024 characters after entities parsing.
Type str

3.2. telegram package 193

Python Telegram Bot Documentation, Release 12.8

parse_mode
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.
Type str
document_url
A valid URL for the file.
Type str
mime_type
Mime type of the content of the file, either “application/pdf” or “application/zip”.
Type str
description
Optional. Short description of the result.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the file.
Type telegram.InputMessageContent
thumb_url
Optional. URL of the thumbnail (jpeg only) for the file.
Type str
thumb_width
Optional. Thumbnail width.
Type int
thumb_height
Optional. Thumbnail height.
Type int

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• title (str) – Title for the result.
• caption (str, optional) – Caption of the document to be sent, 0-1024 characters after
entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• document_url (str) – A valid URL for the file.
• mime_type (str) – Mime type of the content of the file, either “application/pdf” or
“application/zip”.
• description (str, optional) – Short description of the result.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.

194 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• input_message_content (telegram.InputMessageContent, optional) –

Content of the message to be sent instead of the file.
• thumb_url (str, optional) – URL of the thumbnail (jpeg only) for the file.
• thumb_width (int, optional) – Thumbnail width.
• thumb_height (int, optional) – Thumbnail height.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultGame

class telegram.InlineQueryResultGame(id, game_short_name, reply_markup=None,

**kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a Game.
type
‘game’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
game_short_name
Short name of the game.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• game_short_name (str) – Short name of the game.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultGif

class telegram.InlineQueryResultGif(id, gif_url, thumb_url, gif_width=None,

gif_height=None, title=None, cap-
tion=None, reply_markup=None, in-
put_message_content=None, gif_duration=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, thumb_mime_type=None, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with
optional caption. Alternatively, you can use input_message_content to send a message with the
specified content instead of the animation.
type
‘gif’.

3.2. telegram package 195

Python Telegram Bot Documentation, Release 12.8

Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
gif_url
A valid URL for the GIF file. File size must not exceed 1MB.
Type str
gif_width
Optional. Width of the GIF.
Type int
gif_height
Optional. Height of the GIF.
Type int
gif_duration
Optional. Duration of the GIF.
Type int
thumb_url
URL of the static thumbnail for the result (jpeg or gif).
Type str
thumb_mime_type
Optional. MIME type of the thumbnail.
Type str
title
Optional. Title for the result.
Type str
caption
Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing.
Type str
parse_mode
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.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the GIF animation.
Type telegram.InputMessageContent

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• gif_url (str) – A valid URL for the GIF file. File size must not exceed 1MB.
• gif_width (int, optional) – Width of the GIF.

196 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• gif_height (int, optional) – Height of the GIF.

• gif_duration (int, optional) – Duration of the GIF
• thumb_url (str) – URL of the static thumbnail for the result (jpeg or gif).
• thumb_mime_type (str) – Optional. MIME type of the thumbnail, must be one of
“image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”.
• title (str, optional) – Title for the result.
• caption (str, optional) – Caption of the GIF file to be sent, 0-1024 characters after
entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the GIF animation.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultLocation

class telegram.InlineQueryResultLocation(id, latitude, longitude, title,

live_period=None, reply_markup=None,
input_message_content=None,
thumb_url=None, thumb_width=None,
thumb_height=None, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use
input_message_content to send a message with the specified content instead of the location.
type
‘location’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
latitude
Location latitude in degrees.
Type float
longitude
Location longitude in degrees.
Type float
title
Location title.
Type str
live_period
Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.
Type int

3.2. telegram package 197

Python Telegram Bot Documentation, Release 12.8

reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the location.
Type telegram.InputMessageContent
thumb_url
Optional. Url of the thumbnail for the result.
Type str
thumb_width
Optional. Thumbnail width.
Type int
thumb_height
Optional. Thumbnail height.
Type int

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• latitude (float) – Location latitude in degrees.
• longitude (float) – Location longitude in degrees.
• title (str) – Location title.
• live_period (int, optional) – Period in seconds for which the location can be
updated, should be between 60 and 86400.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the location.
• thumb_url (str, optional) – Url of the thumbnail for the result.
• thumb_width (int, optional) – Thumbnail width.
• thumb_height (int, optional) – Thumbnail height.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultMpeg4Gif

class telegram.InlineQueryResultMpeg4Gif(id, mpeg4_url, thumb_url,

mpeg4_width=None, mpeg4_height=None,
title=None, caption=None,
reply_markup=None, in-
put_message_content=None,
mpeg4_duration=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, thumb_mime_type=None,
**kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this
animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use
input_message_content to send a message with the specified content instead of the animation.

198 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

type
‘mpeg4_gif’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
mpeg4_url
A valid URL for the MP4 file. File size must not exceed 1MB.
Type str
mpeg4_width
Optional. Video width.
Type int
mpeg4_height
Optional. Video height.
Type int
mpeg4_duration
Optional. Video duration.
Type int
thumb_url
URL of the static thumbnail (jpeg or gif) for the result.
Type str
thumb_mime_type
Optional. MIME type of the thumbnail.
Type str
title
Optional. Title for the result.
Type str
caption
Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing.
Type str
parse_mode
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.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the video animation.
Type telegram.InputMessageContent

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• mpeg4_url (str) – A valid URL for the MP4 file. File size must not exceed 1MB.

3.2. telegram package 199

Python Telegram Bot Documentation, Release 12.8

• mpeg4_width (int, optional) – Video width.

• mpeg4_height (int, optional) – Video height.
• mpeg4_duration (int, optional) – Video duration.
• thumb_url (str) – URL of the static thumbnail (jpeg or gif) for the result.
• thumb_mime_type (str) – Optional. MIME type of the thumbnail, must be one of
“image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”.
• title (str, optional) – Title for the result.
• caption (str, optional) – Caption of the MPEG-4 file to be sent, 0-1024 characters
after entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the video animation.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultPhoto

class telegram.InlineQueryResultPhoto(id, photo_url, thumb_url, photo_width=None,

photo_height=None, title=None, descrip-
tion=None, caption=None, reply_markup=None,
input_message_content=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alterna-
tively, you can use input_message_content to send a message with the specified content instead of
the photo.
type
‘photo’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
photo_url
A valid URL of the photo. Photo must be in jpeg format. Photo size must not exceed 5MB.
Type str
thumb_url
URL of the thumbnail for the photo.
Type str
photo_width
Optional. Width of the photo.
Type int
photo_height
Optional. Height of the photo.

200 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Type int
title
Optional. Title for the result.
Type str
description
Optional. Short description of the result.
Type str
caption
Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing.
Type str
parse_mode
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.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the photo.
Type telegram.InputMessageContent

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• photo_url (str) – A valid URL of the photo. Photo must be in jpeg format. Photo
size must not exceed 5MB.
• thumb_url (str) – URL of the thumbnail for the photo.
• photo_width (int, optional) – Width of the photo.
• photo_height (int, optional) – Height of the photo.
• title (str, optional) – Title for the result.
• description (str, optional) – Short description of the result.
• caption (str, optional) – Caption of the photo to be sent, 0-1024 characters after
entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the photo.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2. telegram package 201

Python Telegram Bot Documentation, Release 12.8

telegram.InlineQueryResultVenue

class telegram.InlineQueryResultVenue(id, latitude, longitude, title,

address, foursquare_id=None,
foursquare_type=None, reply_markup=None,
input_message_content=None, thumb_url=None,
thumb_width=None, thumb_height=None,
**kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use
input_message_content to send a message with the specified content instead of the venue.
type
‘venue’.
Type str
id
Unique identifier for this result, 1-64 Bytes.
Type str
latitude
Latitude of the venue location in degrees.
Type float
longitude
Longitude of the venue location in degrees.
Type float
title
Title of the venue.
Type str
address
Address of the venue.
Type str
foursquare_id
Optional. Foursquare identifier of the venue if known.
Type str
foursquare_type
Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”,
“arts_entertainment/aquarium” or “food/icecream”.)
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the venue.
Type telegram.InputMessageContent
thumb_url
Optional. Url of the thumbnail for the result.
Type str

202 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

thumb_width
Optional. Thumbnail width.
Type int
thumb_height
Optional. Thumbnail height.
Type int

Parameters
• id (str) – Unique identifier for this result, 1-64 Bytes.
• latitude (float) – Latitude of the venue location in degrees.
• longitude (float) – Longitude of the venue location in degrees.
• title (str) – Title of the venue.
• address (str) – Address of the venue.
• foursquare_id (str, optional) – Foursquare identifier of the venue if known.
• foursquare_type (str, optional) – Foursquare type of the venue, if
known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or
“food/icecream”.)
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the location.
• thumb_url (str, optional) – Url of the thumbnail for the result.
• thumb_width (int, optional) – Thumbnail width.
• thumb_height (int, optional) – Thumbnail height.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultVideo

class telegram.InlineQueryResultVideo(id, video_url, mime_type, thumb_url, ti-

tle, caption=None, video_width=None,
video_height=None, video_duration=None,
description=None, reply_markup=None,
input_message_content=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to a page containing an embedded video player or a video file. By default, this video file
will be sent by the user with an optional caption. Alternatively, you can use input_message_content
to send a message with the specified content instead of the video.

Note: If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must
replace its content using input_message_content.

type
‘video’.
Type str

3.2. telegram package 203

Python Telegram Bot Documentation, Release 12.8

id
Unique identifier for this result, 1-64 bytes.
Type str
video_url
A valid URL for the embedded video player or video file.
Type str
mime_type
Mime type of the content of video url, “text/html” or “video/mp4”.
Type str
thumb_url
URL of the thumbnail (jpeg only) for the video.
Type str
title
Title for the result.
Type str
caption
Optional. Caption of the video to be sent, 0-1024 characters after entities parsing.
Type str
parse_mode
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.
Type str
video_width
Optional. Video width.
Type int
video_height
Optional. Video height.
Type int
video_duration
Optional. Video duration in seconds.
Type int
description
Optional. Short description of the result.
Type str
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the video. This field is required if Inline-
QueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).
Type telegram.InputMessageContent

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.

204 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• video_url (str) – A valid URL for the embedded video player or video file.
• mime_type (str) – Mime type of the content of video url, “text/html” or
“video/mp4”.
• thumb_url (str) – URL of the thumbnail (jpeg only) for the video.
• title (str) – Title for the result.
• caption (str, optional) – Caption, 0-1024 characters after entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• video_width (int, optional) – Video width.
• video_height (int, optional) – Video height.
• video_duration (int, optional) – Video duration in seconds.
• description (str, optional) – Short description of the result.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the video. This field is required if Inline-
QueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InlineQueryResultVoice

class telegram.InlineQueryResultVoice(id, voice_url, title, voice_duration=None,

caption=None, reply_markup=None,
input_message_content=None,
parse_mode=<telegram.utils.helpers.DefaultValue
object>, **kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a link to a voice recording in an .ogg container encoded with OPUS. By default, this voice
recording will be sent by the user. Alternatively, you can use input_message_content to send a
message with the specified content instead of the the voice message.
type
‘voice’.
Type str
id
Unique identifier for this result, 1-64 bytes.
Type str
voice_url
A valid URL for the voice recording.
Type str
title
Recording title.
Type str
caption
Optional. Caption, 0-1024 characters after entities parsing.
Type str

3.2. telegram package 205

Python Telegram Bot Documentation, Release 12.8

parse_mode
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.
Type str
voice_duration
Optional. Recording duration in seconds.
Type int
reply_markup
Optional. Inline keyboard attached to the message.
Type telegram.InlineKeyboardMarkup
input_message_content
Optional. Content of the message to be sent instead of the voice recording.
Type telegram.InputMessageContent

Parameters
• id (str) – Unique identifier for this result, 1-64 bytes.
• voice_url (str) – A valid URL for the voice recording.
• title (str) – Recording title.
• caption (str, optional) – Caption, 0-1024 characters after entities parsing.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram
apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the
constants in telegram.ParseMode for the available modes.
• voice_duration (int, optional) – Recording duration in seconds.
• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline key-
board attached to the message.
• input_message_content (telegram.InputMessageContent, optional) –
Content of the message to be sent instead of the voice recording.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InputMessageContent

class telegram.InputMessageContent
Bases: telegram.base.TelegramObject
Base class for Telegram InputMessageContent Objects.
See: telegram.InputContactMessageContent, telegram.
InputLocationMessageContent, telegram.InputTextMessageContent and
telegram.InputVenueMessageContent for more details.

telegram.InputTextMessageContent

class telegram.InputTextMessageContent(message_text, parse_mode=<telegram.utils.helpers.DefaultValue

object>, disable_web_page_preview=<telegram.utils.helpers.DefaultVal
object>, **kwargs)
Bases: telegram.inline.inputmessagecontent.InputMessageContent
Represents the content of a text message to be sent as the result of an inline query.

206 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

message_text
Text of the message to be sent, 1-4096 characters after entities parsing.
Type str
parse_mode
Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text
or inline URLs in your bot’s message.
Type str
disable_web_page_preview
Optional. Disables link previews for links in the sent message.
Type bool

Parameters
• message_text (str) – Text of the message to be sent, 1-4096 characters after enti-
ties parsing. Also found as telegram.constants.MAX_MESSAGE_LENGTH.
• parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram apps
to show bold, italic, fixed-width text or inline URLs in your bot’s message.
• disable_web_page_preview (bool, optional) – Disables link previews for links
in the sent message.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InputLocationMessageContent

class telegram.InputLocationMessageContent(latitude, longitude, live_period=None,

**kwargs)
Bases: telegram.inline.inputmessagecontent.InputMessageContent
Represents the content of a location message to be sent as the result of an inline query.
latitude
Latitude of the location in degrees.
Type float
longitude
Longitude of the location in degrees.
Type float

Parameters
• latitude (float) – Latitude of the location in degrees.
• longitude (float) – Longitude of the location in degrees.
• live_period (int, optional) – Period in seconds for which the location can be
updated, should be between 60 and 86400.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InputVenueMessageContent

class telegram.InputVenueMessageContent(latitude, longitude, title, address,

foursquare_id=None, foursquare_type=None,
**kwargs)
Bases: telegram.inline.inputmessagecontent.InputMessageContent
Represents the content of a venue message to be sent as the result of an inline query.

3.2. telegram package 207

Python Telegram Bot Documentation, Release 12.8

latitude
Latitude of the location in degrees.
Type float
longitude
Longitude of the location in degrees.
Type float
title
Name of the venue.
Type str
address
Address of the venue.
Type str
foursquare_id
Optional. Foursquare identifier of the venue, if known.
Type str
foursquare_type
Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”,
“arts_entertainment/aquarium” or “food/icecream”.)
Type str

Parameters
• latitude (float) – Latitude of the location in degrees.
• longitude (float) – Longitude of the location in degrees.
• title (str) – Name of the venue.
• address (str) – Address of the venue.
• foursquare_id (str, optional) – Foursquare identifier of the venue, if known.
• foursquare_type (str, optional) – Foursquare type of the venue, if
known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or
“food/icecream”.)
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.InputContactMessageContent

class telegram.InputContactMessageContent(phone_number, first_name,

last_name=None, vcard=None, **kwargs)
Bases: telegram.inline.inputmessagecontent.InputMessageContent
Represents the content of a contact message to be sent as the result of an inline query.
phone_number
Contact’s phone number.
Type str
first_name
Contact’s first name.
Type str
last_name
Optional. Contact’s last name.

208 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Type str
vcard
Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes.
Type str

Parameters
• phone_number (str) – Contact’s phone number.
• first_name (str) – 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.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.ChosenInlineResult

class telegram.ChosenInlineResult(result_id, from_user, query, location=None, in-

line_message_id=None, **kwargs)
Bases: telegram.base.TelegramObject
Represents a result of an inline query that was chosen by the user and sent to their chat partner.

Note: In Python from is a reserved word, use from_user instead.

result_id
The unique identifier for the result that was chosen.
Type str
from_user
The user that chose the result.
Type telegram.User
location
Optional. Sender location.
Type telegram.Location
inline_message_id
Optional. Identifier of the sent inline message.
Type str
query
The query that was used to obtain the result.
Type str

Parameters
• result_id (str) – The unique identifier for the result that was chosen.
• from_user (telegram.User) – The user that chose the result.
• location (telegram.Location, optional) – Sender location, only for bots that
require user location.
• inline_message_id (str, optional) – Identifier of the sent inline message. Avail-
able only if there is an inline keyboard attached to the message. Will be also received in
callback queries and can be used to edit the message.

3.2. telegram package 209

Python Telegram Bot Documentation, Release 12.8

• query (str) – The query that was used to obtain the result.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2.52 Payments

telegram.LabeledPrice

class telegram.LabeledPrice(label, amount, **kwargs)

Bases: telegram.base.TelegramObject
This object represents a portion of the price for goods or services.
label
Portion label.
Type str
amount
Price of the product in the smallest units of the currency.
Type int

Parameters
• label (str) – Portion label
• amount (int) – Price of the product in the smallest units of the currency (integer, not
float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp
parameter in currencies.json, it shows the number of digits past the decimal point for
each currency (2 for the majority of currencies).
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.Invoice

class telegram.Invoice(title, description, start_parameter, currency, total_amount, **kwargs)

Bases: telegram.base.TelegramObject
This object contains basic information about an invoice.
title
Product name.
Type str
description
Product description.
Type str
start_parameter
Unique bot deep-linking parameter.
Type str
currency
Three-letter ISO 4217 currency code.
Type str
total_amount
Total price in the smallest units of the currency.
Type int

210 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Parameters
• title (str) – Product name.
• description (str) – Product description.
• start_parameter (str) – Unique bot deep-linking parameter that can be used to
generate this invoice.
• currency (str) – Three-letter ISO 4217 currency code.
• total_amount (int) – Total price in the smallest units of the currency (integer, not
float/double). For example, for a price of US$ 1.45 pass amount = 145.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.ShippingAddress

class telegram.ShippingAddress(country_code, state, city, street_line1, street_line2,

post_code, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a Telegram ShippingAddress.
country_code
ISO 3166-1 alpha-2 country code.
Type str
state
State, if applicable.
Type str
city
City.
Type str
street_line1
First line for the address.
Type str
street_line2
Second line for the address.
Type str
post_code
Address post code.
Type str

Parameters
• country_code (str) – ISO 3166-1 alpha-2 country code.
• state (str) – State, if applicable.
• city (str) – City.
• street_line1 (str) – First line for the address.
• street_line2 (str) – Second line for the address.
• post_code (str) – Address post code.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2. telegram package 211

Python Telegram Bot Documentation, Release 12.8

telegram.OrderInfo

class telegram.OrderInfo(name=None, phone_number=None, email=None, ship-

ping_address=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents information about an order.
name
Optional. User name.
Type str
phone_number
Optional. User’s phone number.
Type str
email
Optional. User email.
Type str
shipping_address
Optional. User shipping address.
Type telegram.ShippingAddress

Parameters
• name (str, optional) – User name.
• phone_number (str, optional) – User’s phone number.
• email (str, optional) – User email.
• shipping_address (telegram.ShippingAddress, optional) – User ship-
ping address.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.ShippingOption

class telegram.ShippingOption(id, title, prices, **kwargs)

Bases: telegram.base.TelegramObject
This object represents one shipping option.
id
Shipping option identifier.
Type str
title
Option title.
Type str
prices
List of price portions.
Type List[telegram.LabeledPrice]

Parameters
• id (str) – Shipping option identifier.
• title (str) – Option title.
• prices (List[telegram.LabeledPrice]) – List of price portions.

212 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• **kwargs (dict) – Arbitrary keyword arguments.

telegram.SuccessfulPayment

class telegram.SuccessfulPayment(currency, total_amount, invoice_payload, tele-

gram_payment_charge_id, provider_payment_charge_id,
shipping_option_id=None, order_info=None, **kwargs)
Bases: telegram.base.TelegramObject
This object contains basic information about a successful payment.
currency
Three-letter ISO 4217 currency code.
Type str
total_amount
Total price in the smallest units of the currency.
Type int
invoice_payload
Bot specified invoice payload.
Type str
shipping_option_id
Optional. Identifier of the shipping option chosen by the user.
Type str
order_info
Optional. Order info provided by the user.
Type telegram.OrderInfo
telegram_payment_charge_id
Telegram payment identifier.
Type str
provider_payment_charge_id
Provider payment identifier.
Type str

Parameters
• currency (str) – Three-letter ISO 4217 currency code.
• total_amount (int) – Total price in the smallest units of the currency (integer, not
float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp
parameter in currencies.json, it shows the number of digits past the decimal point for
each currency (2 for the majority of currencies).
• invoice_payload (str) – Bot specified invoice payload.
• shipping_option_id (str, optional) – Identifier of the shipping option chosen
by the user.
• order_info (telegram.OrderInfo, optional) – Order info provided by the user
• telegram_payment_charge_id (str) – Telegram payment identifier.
• provider_payment_charge_id (str) – Provider payment identifier.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2. telegram package 213

Python Telegram Bot Documentation, Release 12.8

telegram.ShippingQuery

class telegram.ShippingQuery(id, from_user, invoice_payload, shipping_address, bot=None,

**kwargs)
Bases: telegram.base.TelegramObject
This object contains information about an incoming shipping query.

Note:
• In Python from is a reserved word, use from_user instead.

id
Unique query identifier.
Type str
from_user
User who sent the query.
Type telegram.User
invoice_payload
Bot specified invoice payload.
Type str
shipping_address
User specified shipping address.
Type telegram.ShippingAddress
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot

Parameters
• id (str) – Unique query identifier.
• from_user (telegram.User) – User who sent the query.
• invoice_payload (str) – Bot specified invoice payload.
• shipping_address (telegram.ShippingAddress) – User specified ship-
ping address.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• **kwargs (dict) – Arbitrary keyword arguments.

answer(*args, **kwargs)
Shortcut for:

bot.answer_shipping_query(update.shipping_query.id, *args, **kwargs)

Parameters
• 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 possi-
ble).
• shipping_options (List[telegram.ShippingOption], optional) – Re-
quired if ok is True. A JSON-serialized array of available shipping options.

214 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

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

telegram.PreCheckoutQuery

class telegram.PreCheckoutQuery(id, from_user, currency, total_amount, invoice_payload,

shipping_option_id=None, order_info=None, bot=None,
**kwargs)
Bases: telegram.base.TelegramObject
This object contains information about an incoming pre-checkout query.

Note:
• In Python from is a reserved word, use from_user instead.

id
Unique query identifier.
Type str
from_user
User who sent the query.
Type telegram.User
currency
Three-letter ISO 4217 currency code.
Type str
total_amount
Total price in the smallest units of the currency.
Type int
invoice_payload
Bot specified invoice payload.
Type str
shipping_option_id
Optional. Identifier of the shipping option chosen by the user.
Type str
order_info
Optional. Order info provided by the user.
Type telegram.OrderInfo
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot

Parameters
• id (str) – Unique query identifier.
• from_user (telegram.User) – User who sent the query.
• currency (str) – Three-letter ISO 4217 currency code

3.2. telegram package 215

Python Telegram Bot Documentation, Release 12.8

• total_amount (int) – Total price in the smallest units of the currency (integer, not
float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp
parameter in currencies.json, it shows the number of digits past the decimal point for
each currency (2 for the majority of currencies).
• invoice_payload (str) – Bot specified invoice payload.
• shipping_option_id (str, optional) – Identifier of the shipping option chosen
by the user.
• order_info (telegram.OrderInfo, optional) – Order info provided by the user.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• **kwargs (dict) – Arbitrary keyword arguments.

answer(*args, **kwargs)
Shortcut for:

bot.answer_pre_checkout_query(update.pre_checkout_query.id, *args,
˓→**kwargs)

Parameters
• 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.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2.53 Games

telegram.Game

class telegram.Game(title, description, photo, text=None, text_entities=None, animation=None,

**kwargs)
Bases: telegram.base.TelegramObject
This object represents a game. Use BotFather to create and edit games, their short names will act as unique
identifiers.
title
Title of the game.
Type str
description
Description of the game.
Type str
photo
Photo that will be displayed in the game message in chats.
Type List[telegram.PhotoSize]
text
Optional. Brief description of the game or high scores included in the game message. Can be auto-
matically edited to include current high scores for the game when the bot calls set_game_score, or
manually edited using edit_message_text.

216 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Type str
text_entities
Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
Type List[telegram.MessageEntity]
animation
Optional. Animation that will be displayed in the game message in chats. Upload via BotFather.
Type telegram.Animation

Parameters
• title (str) – Title of the game.
• description (str) – Description of the game.
• photo (List[telegram.PhotoSize]) – Photo that will be displayed in the game
message in chats.
• text (str, optional) – Brief description of the game or high scores included in the
game message. Can be automatically edited to include current high scores for the game
when the bot calls set_game_score, or manually edited using edit_message_text. 0-4096
characters. Also found as telegram.constants.MAX_MESSAGE_LENGTH.
• text_entities (List[telegram.MessageEntity], optional) – Special entities
that appear in text, such as usernames, URLs, bot commands, etc.
• animation (telegram.Animation, optional) – Animation that will be displayed
in the game message in chats. Upload via BotFather.

parse_text_entities(types=None)
Returns a dict that maps telegram.MessageEntity to str. It contains entities from this
message filtered by their type attribute as the key, and the text that each entity belongs to as the value
of the dict.

Note: This method should always be used instead of the text_entities attribute, since
it calculates the correct substring from the message text based on UTF-16 codepoints. See
parse_text_entity for more info.

Parameters types (List[str], optional) – List of MessageEntity types as strings. If

the type attribute of an entity is contained in this list, it will be returned. Defaults to
telegram.MessageEntity.ALL_TYPES.
Returns A dictionary of entities mapped to the text that belongs to them, calculated based
on UTF-16 codepoints.
Return type Dict[telegram.MessageEntity, str]

parse_text_entity(entity)
Returns the text from a given telegram.MessageEntity.

Note: This method is present because Telegram calculates the offset and length in UTF-16 code-
point pairs, which some versions of Python don’t handle automatically. (That is, you can’t just slice
Message.text with the offset and length.)

Parameters entity (telegram.MessageEntity) – The entity to extract the text

from. It must be an entity that belongs to this message.
Returns The text of the given entity.

3.2. telegram package 217

Python Telegram Bot Documentation, Release 12.8

Return type str

telegram.Callbackgame

class telegram.CallbackGame
Bases: telegram.base.TelegramObject
A placeholder, currently holds no information. Use BotFather to set up your game.

telegram.GameHighScore

class telegram.GameHighScore(position, user, score)

Bases: telegram.base.TelegramObject
This object represents one row of the high scores table for a game.
position
Position in high score table for the game.
Type int
user
User.
Type telegram.User
score
Score.
Type int

Parameters
• position (int) – Position in high score table for the game.
• user (telegram.User) – User.
• score (int) – Score.

3.2.54 Passport

telegram.PassportElementError

class telegram.PassportElementError(source, type, message, **kwargs)

Bases: telegram.base.TelegramObject
Baseclass for the PassportElementError* classes.
source
Error source.
Type str
type
The section of the user’s Telegram Passport which has the error.
Type str
message
Error message
Type str

Parameters

218 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• source (str) – Error source.

• type (str) – The section of the user’s Telegram Passport which has the error.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.PassportElementErrorFile

class telegram.PassportElementErrorFile(type, file_hash, message, **kwargs)

Bases: telegram.passport.passportelementerrors.PassportElementError
Represents an issue with a document scan. The error is considered resolved when the file with the document
scan changes.
type
The section of the user’s Telegram Passport which has the issue, one of “utility_bill”,
“bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”.
Type str
file_hash
Base64-encoded file hash.
Type str
message
Error message.
Type str

Parameters
• type (str) – The section of the user’s Telegram Passport which has the issue, one of
“utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “tempo-
rary_registration”.
• file_hash (str) – Base64-encoded file hash.
• message (str) – Error message.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.PassportElementErrorReverseSide

class telegram.PassportElementErrorReverseSide(type, file_hash, message, **kwargs)

Bases: telegram.passport.passportelementerrors.PassportElementError
Represents an issue with the front side of a document. The error is considered resolved when the file with
the reverse side of the document changes.
type
The section of the user’s Telegram Passport which has the issue, one of “passport”, “driver_license”,
“identity_card”, “internal_passport”.
Type str
file_hash
Base64-encoded hash of the file with the reverse side of the document.
Type str
message
Error message.
Type str

Parameters

3.2. telegram package 219

Python Telegram Bot Documentation, Release 12.8

• type (str) – The section of the user’s Telegram Passport which has the issue, one of
“driver_license”, “identity_card”.
• file_hash (str) – Base64-encoded hash of the file with the reverse side of the
document.
• message (str) – Error message.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.PassportElementErrorFrontSide

class telegram.PassportElementErrorFrontSide(type, file_hash, message, **kwargs)

Bases: telegram.passport.passportelementerrors.PassportElementError
Represents an issue with the front side of a document. The error is considered resolved when the file with
the front side of the document changes.
type
The section of the user’s Telegram Passport which has the issue, one of “passport”, “driver_license”,
“identity_card”, “internal_passport”.
Type str
file_hash
Base64-encoded hash of the file with the front side of the document.
Type str
message
Error message.
Type str

Parameters
• type (str) – The section of the user’s Telegram Passport which has the issue, one of
“passport”, “driver_license”, “identity_card”, “internal_passport”.
• file_hash (str) – Base64-encoded hash of the file with the front side of the docu-
ment.
• message (str) – Error message.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.PassportElementErrorFiles

class telegram.PassportElementErrorFiles(type, file_hashes, message, **kwargs)

Bases: telegram.passport.passportelementerrors.PassportElementError
Represents an issue with a list of scans. The error is considered resolved when the file with the document
scan changes.
type
The section of the user’s Telegram Passport which has the issue, one of “utility_bill”,
“bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”.
Type str
file_hash
Base64-encoded file hash.
Type str
message
Error message.

220 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Type str

Parameters
• type (str) – The section of the user’s Telegram Passport which has the issue, one of
“utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “tempo-
rary_registration”.
• file_hashes (List[str]) – List of base64-encoded file hashes.
• message (str) – Error message.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.PassportElementErrorDataField

class telegram.PassportElementErrorDataField(type, field_name, data_hash, message,

**kwargs)
Bases: telegram.passport.passportelementerrors.PassportElementError
Represents an issue in one of the data fields that was provided by the user. The error is considered resolved
when the field’s value changes.
type
The section of the user’s Telegram Passport which has the error, one of “personal_details”, “passport”,
“driver_license”, “identity_card”, “internal_passport”, “address”.
Type str
field_name
Name of the data field which has the error.
Type str
data_hash
Base64-encoded data hash.
Type str
message
Error message.
Type str

Parameters
• type (str) – The section of the user’s Telegram Passport which has the error, one of
“personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”,
“address”.
• field_name (str) – Name of the data field which has the error.
• data_hash (str) – Base64-encoded data hash.
• message (str) – Error message.
• **kwargs (dict) – Arbitrary keyword arguments.

telegram.Credentials

class telegram.Credentials(secure_data, nonce, bot=None, **kwargs)

Bases: telegram.base.TelegramObject
secure_data
Credentials for encrypted data
Type telegram.SecureData

3.2. telegram package 221

Python Telegram Bot Documentation, Release 12.8

nonce
Bot-specified nonce
Type str

telegram.DataCredentials

class telegram.DataCredentials(data_hash, secret, **kwargs)

Bases: telegram.passport.credentials._CredentialsBase
These credentials can be used to decrypt encrypted data from the data field in EncryptedPassportData.
Parameters
• data_hash (str) – Checksum of encrypted data
• secret (str) – Secret of encrypted data
hash
Checksum of encrypted data
Type str
secret
Secret of encrypted data
Type str

telegram.SecureData

class telegram.SecureData(personal_details=None, passport=None, internal_passport=None,

driver_license=None, identity_card=None, address=None, util-
ity_bill=None, bank_statement=None, rental_agreement=None,
passport_registration=None, temporary_registration=None,
bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents the credentials that were used to decrypt the encrypted data. All fields are optional
and depend on fields that were requested.
personal_details
Credentials for encrypted personal details.
Type telegram.SecureValue, optional
passport
Credentials for encrypted passport.
Type telegram.SecureValue, optional
internal_passport
Credentials for encrypted internal passport.
Type telegram.SecureValue, optional
driver_license
Credentials for encrypted driver license.
Type telegram.SecureValue, optional
identity_card
Credentials for encrypted ID card
Type telegram.SecureValue, optional
address
Credentials for encrypted residential address.

222 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Type telegram.SecureValue, optional

utility_bill
Credentials for encrypted utility bill.
Type telegram.SecureValue, optional
bank_statement
Credentials for encrypted bank statement.
Type telegram.SecureValue, optional
rental_agreement
Credentials for encrypted rental agreement.
Type telegram.SecureValue, optional
passport_registration
Credentials for encrypted registration from internal passport.
Type telegram.SecureValue, optional
temporary_registration
Credentials for encrypted temporary registration.
Type telegram.SecureValue, optional

telegram.FileCredentials

class telegram.FileCredentials(file_hash, secret, **kwargs)

Bases: telegram.passport.credentials._CredentialsBase
These credentials can be used to decrypt encrypted files from the front_side, reverse_side, selfie and files
fields in EncryptedPassportData.
Parameters
• file_hash (str) – Checksum of encrypted file
• secret (str) – Secret of encrypted file
hash
Checksum of encrypted file
Type str
secret
Secret of encrypted file
Type str

telegram.IdDocumentData

class telegram.IdDocumentData(document_no, expiry_date, bot=None, **kwargs)

Bases: telegram.base.TelegramObject
This object represents the data of an identity document.
document_no
Document number.
Type str
expiry_date
Optional. Date of expiry, in DD.MM.YYYY format.
Type str

3.2. telegram package 223

Python Telegram Bot Documentation, Release 12.8

telegram.PersonalDetails

class telegram.PersonalDetails(first_name, last_name, birth_date, gender, country_code,

residence_country_code, first_name_native=None,
last_name_native=None, middle_name=None, mid-
dle_name_native=None, bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents personal details.
first_name
First Name.
Type str
middle_name
Optional. First Name.
Type str
last_name
Last Name.
Type str
birth_date
Date of birth in DD.MM.YYYY format.
Type str
gender
Gender, male or female.
Type str
country_code
Citizenship (ISO 3166-1 alpha-2 country code).
Type str
residence_country_code
Country of residence (ISO 3166-1 alpha-2 country code).
Type str
first_name_native
First Name in the language of the user’s country of residence.
Type str
middle_name_native
Optional. Middle Name in the language of the user’s country of residence.
Type str
last_name_native
Last Name in the language of the user’s country of residence.
Type str

telegram.ResidentialAddress

class telegram.ResidentialAddress(street_line1, street_line2, city, state, country_code,

post_code, bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a residential address.

224 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

street_line1
First line for the address.
Type str
street_line2
Optional. Second line for the address.
Type str
city
City.
Type str
state
Optional. State.
Type str
country_code
ISO 3166-1 alpha-2 country code.
Type str
post_code
Address post code.
Type str

telegram.PassportData

class telegram.PassportData(data, credentials, bot=None, **kwargs)

Bases: telegram.base.TelegramObject
Contains information about Telegram Passport data shared with the bot by the user.
data
Array with encrypted information about documents and other Telegram Passport elements that was
shared with the bot.
Type List[telegram.EncryptedPassportElement]
credentials
Encrypted credentials.
Type telegram.EncryptedCredentials
bot
The Bot to use for instance methods.
Type telegram.Bot, optional

Parameters
• data (List[telegram.EncryptedPassportElement]) – Array with encrypted
information about documents and other Telegram Passport elements that was shared
with the bot.
• credentials (str) – Encrypted credentials.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2. telegram package 225

Python Telegram Bot Documentation, Release 12.8

Note: To be able to decrypt this object, you must pass your private_key to either telegram.Updater
or telegram.Bot. Decrypted data is then found in decrypted_data and the payload can be found
in decrypted_credentials’s attribute telegram.Credentials.payload.

decrypted_credentials
Lazily decrypt and return credentials that were used to decrypt the data. This object also contains
the user specified payload as decrypted_data.payload.

Raises telegram.TelegramDecryptionError – Decryption failed. Usually due to

bad private/public key but can also suggest malformed/tampered data.
Type telegram.Credentials

decrypted_data
Lazily decrypt and return information about documents and other Telegram Passport elements
which were shared with the bot.

Raises telegram.TelegramDecryptionError – Decryption failed. Usually due to

bad private/public key but can also suggest malformed/tampered data.
Type List[telegram.EncryptedPassportElement]

telegram.PassportFile

class telegram.PassportFile(file_id, file_unique_id, file_date, file_size=None, bot=None, cre-

dentials=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in
JPEG format when decrypted and don’t exceed 10MB.
file_id
Unique identifier for this file.
Type str
file_unique_id
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t
be used to download or reuse the file.
Type str
file_size
File size.
Type int
file_date
Unix time when the file was uploaded.
Type int
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot

Parameters
• file_id (str) – Identifier for this file, which can be used to download or reuse the
file.

226 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• file_unique_id (str) – Unique and the same over time and for different bots file
identifier.
• file_size (int) – File size.
• file_date (int) – Unix time when the file was uploaded.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• **kwargs (dict) – Arbitrary keyword arguments.

get_file(timeout=None, **kwargs)
Wrapper over telegram.Bot.get_file. Will automatically assign the correct creden-
tials to the returned telegram.File if originating from telegram.PassportData.
decrypted_data.
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.File
Raises telegram.TelegramError

telegram.EncryptedPassportElement

class telegram.EncryptedPassportElement(type, data=None, phone_number=None,

email=None, files=None, front_side=None,
reverse_side=None, selfie=None, transla-
tion=None, hash=None, bot=None, creden-
tials=None, **kwargs)
Bases: telegram.base.TelegramObject
Contains information about documents or other Telegram Passport elements shared with the bot by the user.
The data has been automatically decrypted by python-telegram-bot.
type
Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”,
“internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “pass-
port_registration”, “temporary_registration”, “phone_number”, “email”.
Type str
data
Optional. Decrypted or encrypted data, available for “personal_details”, “passport”, “driver_license”,
“identity_card”, “identity_passport” and “address” types.
Type telegram.PersonalDetails or telegram.IdDocument or telegram.
ResidentialAddress or str
phone_number
Optional. User’s verified phone number, available only for “phone_number” type.
Type str
email
Optional. User’s verified email address, available only for “email” type.
Type str

3.2. telegram package 227

Python Telegram Bot Documentation, Release 12.8

files
Optional. Array of encrypted/decrypted files with documents provided by the user, avail-
able for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “tempo-
rary_registration” types.
Type List[telegram.PassportFile]
front_side
Optional. Encrypted/decrypted file with the front side of the document, provided by the user. Available
for “passport”, “driver_license”, “identity_card” and “internal_passport”.
Type telegram.PassportFile
reverse_side
Optional. Encrypted/decrypted file with the reverse side of the document, provided by the user. Avail-
able for “driver_license” and “identity_card”.
Type telegram.PassportFile
selfie
Optional. Encrypted/decrypted file with the selfie of the user holding a document, provided by the
user; available for “passport”, “driver_license”, “identity_card” and “internal_passport”.
Type telegram.PassportFile
translation
Optional. Array of encrypted/decrypted files with translated versions of documents provided
by the user. Available if requested for “passport”, “driver_license”, “identity_card”, “inter-
nal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and
“temporary_registration” types.
Type List[telegram.PassportFile]
hash
Base64-encoded element hash for using in telegram.PassportElementErrorUnspecified.
Type str
bot
Optional. The Bot to use for instance methods.
Type telegram.Bot

Parameters
• type (str) – Element type. One of “personal_details”, “passport”,
“driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”,
“bank_statement”, “rental_agreement”, “passport_registration”, “tempo-
rary_registration”, “phone_number”, “email”.
• data (telegram.PersonalDetails or telegram.IdDocument or
telegram.ResidentialAddress or str, optional) – Decrypted or encrypted
data, available for “personal_details”, “passport”, “driver_license”, “identity_card”,
“identity_passport” and “address” types.
• phone_number (str, optional) – User’s verified phone number, available only for
“phone_number” type.
• email (str, optional) – User’s verified email address, available only for “email” type.
• files (List[telegram.PassportFile], optional) – Array of en-
crypted/decrypted files with documents provided by the user, available for “util-
ity_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “tempo-
rary_registration” types.
• front_side (telegram.PassportFile, optional) – Encrypted/decrypted file
with the front side of the document, provided by the user. Available for “passport”,
“driver_license”, “identity_card” and “internal_passport”.

228 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• reverse_side (telegram.PassportFile, optional) – Encrypted/decrypted

file with the reverse side of the document, provided by the user. Available for
“driver_license” and “identity_card”.
• selfie (telegram.PassportFile, optional) – Encrypted/decrypted file with
the selfie of the user holding a document, provided by the user; available for “pass-
port”, “driver_license”, “identity_card” and “internal_passport”.
• translation (List[telegram.PassportFile], optional) – Array of en-
crypted/decrypted files with translated versions of documents provided by the
user. Available if requested for “passport”, “driver_license”, “identity_card”,
“internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “pass-
port_registration” and “temporary_registration” types.
• hash (str) – Base64-encoded element hash for using in telegram.
PassportElementErrorUnspecified.
• bot (telegram.Bot, optional) – The Bot to use for instance methods.
• **kwargs (dict) – Arbitrary keyword arguments.

Note: This object is decrypted only when originating from telegram.PassportData.

decrypted_data.

telegram.EncryptedCredentials

class telegram.EncryptedCredentials(data, hash, secret, bot=None, **kwargs)

Bases: telegram.base.TelegramObject
Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram
Passport Documentation for a complete description of the data decryption and authentication processes.
data
Decrypted data with unique user’s nonce, data hashes and secrets used for EncryptedPassportElement
decryption and authentication or base64 encrypted data.
Type telegram.Credentials or str
hash
Base64-encoded data hash for data authentication.
Type str
secret
Decrypted or encrypted secret used for decryption.
Type str

Parameters
• data (telegram.Credentials or str) – Decrypted data with unique user’s
nonce, data hashes and secrets used for EncryptedPassportElement decryption and au-
thentication or base64 encrypted data.
• hash (str) – Base64-encoded data hash for data authentication.
• secret (str) – Decrypted or encrypted secret used for decryption.
• **kwargs (dict) – Arbitrary keyword arguments.

3.2. telegram package 229

Python Telegram Bot Documentation, Release 12.8

Note: This object is decrypted only when originating from telegram.PassportData.

decrypted_credentials.

decrypted_data
Lazily decrypt and return credentials data. This object also contains the user specified nonce as
decrypted_data.nonce.

Raises telegram.TelegramDecryptionError – Decryption failed. Usually due to

bad private/public key but can also suggest malformed/tampered data.
Type telegram.Credentials

decrypted_secret
Lazily decrypt and return secret.
Raises telegram.TelegramDecryptionError – Decryption failed. Usually due to
bad private/public key but can also suggest malformed/tampered data.
Type str

3.3 telegram.utils package

3.3.1 telegram.utils.helpers Module

This module contains helper functions.

telegram.utils.helpers.DEFAULT_NONE = <telegram.utils.helpers.DefaultValue object>
Default None
Type DefaultValue
class telegram.utils.helpers.DefaultValue(value=None)
Bases: object
Wrapper for immutable default arguments that allows to check, if the default value was set explicitly. Usage:

DefaultOne = DefaultValue(1)
def f(arg=DefaultOne):
if arg is DefaultOne:
print('`arg` is the default')
arg = arg.value
else:
print('`arg` was set explicitly')
print('`arg` = ' + str(arg))

This yields:

>>> f()
`arg` is the default
`arg` = 1
>>> f(1)
`arg` was set explicitly
`arg` = 1
>>> f(2)
`arg` was set explicitly
`arg` = 2

Also allows to evaluate truthiness:

230 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

default = DefaultValue(value)
if default:
...

is equivalent to:

default = DefaultValue(value)
if value:
...

value
The value of the default argument
Type obj

Parameters value (obj) – The value of the default argument

telegram.utils.helpers.create_deep_linked_url(bot_username, payload=None,
group=False)
Creates a deep-linked URL for this bot_username with the specified payload. See https://core.
telegram.org/bots#deep-linking to learn more.
The payload may consist of the following characters: A-Z, a-z, 0-9, _, -

Note: Works well in conjunction with CommandHandler("start", callback, filters =

Filters.regex('payload'))

Examples
create_deep_linked_url(bot.get_me().username, "some-params")

Parameters
• bot_username (str) – The username to link to
• payload (str, optional) – Parameters to encode in the created URL
• group (bool, optional) – If True the user is prompted to select a group to add the bot
to. If False, opens a one-on-one conversation with the bot. Defaults to False.
Returns An URL to start the bot with specific parameters
Return type str

telegram.utils.helpers.decode_conversations_from_json(json_string)
Helper method to decode a conversations dict (that uses tuples as keys) from a JSON-string created with
_encode_conversations_to_json.
Parameters json_string (str) – The conversations dict as JSON string.
Returns The conversations dict after decoding
Return type dict
telegram.utils.helpers.decode_user_chat_data_from_json(data)
Helper method to decode chat or user data (that uses ints as keys) from a JSON-string.
Parameters data (str) – The user/chat_data dict as JSON string.
Returns The user/chat_data defaultdict after decoding
Return type dict

3.3. telegram.utils package 231

Python Telegram Bot Documentation, Release 12.8

telegram.utils.helpers.effective_message_type(entity)
Extracts the type of message as a string identifier from a telegram.Message or a telegram.Update.
Parameters entity (Update | Message) –
Returns One of Message.MESSAGE_TYPES
Return type str
telegram.utils.helpers.encode_conversations_to_json(conversations)
Helper method to encode a conversations dict (that uses tuples as keys) to a JSON-serializable way. Use
_decode_conversations_from_json to decode.
Parameters conversations (dict) – The conversations dict to transofrm to JSON.
Returns The JSON-serialized conversations dict
Return type str
telegram.utils.helpers.escape_markdown(text, version=1, entity_type=None)
Helper function to escape telegram markup symbols.
Parameters
• text (str) – The text.
• version (int | str) – Use to specify the version of telegrams Markdown. Either 1
or 2. Defaults to 1.
• entity_type (str, optional) – For the entity types PRE, CODE and the link part of
TEXT_LINKS, only certain characters need to be escaped in MarkdownV2. See the
official API documentation for details. Only valid in combination with version=2,
will be ignored else.
telegram.utils.helpers.from_timestamp(unixtime, tzinfo=datetime.timezone.utc)
Converts an (integer) unix timestamp to a timezone aware datetime object. None s are left alone (i.e.
from_timestamp(None) is None).
Parameters
• unixtime (int) – integer POSIX timestamp
• tzinfo (datetime.tzinfo, optional) – The timezone, the timestamp is to be con-
verted to. Defaults to UTC.
Returns timezone aware equivalent datetime.datetime value if timestamp is not
None; else None
telegram.utils.helpers.get_signal_name(signum)
Returns the signal name of the given signal number.
telegram.utils.helpers.mention_html(user_id, name)
Parameters
• user_id (int) –
• name (str) –
Returns The inline mention for the user as html.
Return type str
telegram.utils.helpers.mention_markdown(user_id, name, version=1)
Parameters
• user_id (int) –
• name (str) –
• version (int | str) – Use to specify the version of telegrams Markdown. Either 1
or 2. Defaults to 1

232 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Returns The inline mention for the user as markdown.

Return type str
telegram.utils.helpers.to_float_timestamp(t, reference_timestamp=None)
Converts a given time object to a float POSIX timestamp. Used to convert different time specifications to
a common format. The time object can be relative (i.e. indicate a time increment, or a time of day) or
absolute. Any objects from the datetime module that are timezone-naive will be assumed to be in UTC.
None s are left alone (i.e. to_float_timestamp(None) is None).
Parameters
• t (int | float | datetime.timedelta | datetime.datetime |
datetime.time) – Time value to convert. The semantics of this parameter will
depend on its type:
– int or float will be interpreted as “seconds from reference_t”
– datetime.timedelta will be interpreted as “time increment from
reference_t”
– datetime.datetime will be interpreted as an absolute date/time value
– datetime.time will be interpreted as a specific time of day
• reference_timestamp (float, optional) – POSIX timestamp that indicates
the absolute time from which relative calculations are to be performed (e.g. when t is
given as an int, indicating “seconds from reference_t”). Defaults to now (the
time at which this function is called).
If t is given as an absolute representation of date & time (i.e. a datetime.
datetime object), reference_timestamp is not relevant and so its value should
be None. If this is not the case, a ValueError will be raised.
Returns
(float | None) The return value depends on the type of argument t. If t is given as a
time increment (i.e. as a obj:int, float or datetime.timedelta), then the re-
turn value will be reference_t + t.
Else if it is given as an absolute date/time value (i.e. a datetime.datetime object),
the equivalent value as a POSIX timestamp will be returned.
Finally, if it is a time of the day without date (i.e. a datetime.time object), the
return value is the nearest future occurrence of that time of day.
Raises TypeError – if t’s type is not one of those described above
telegram.utils.helpers.to_timestamp(dt_obj, reference_timestamp=None)
Wrapper over to_float_timestamp() which returns an integer (the float value truncated down to the
nearest integer).
See the documentation for to_float_timestamp() for more details.

3.3.2 telegram.utils.promise.Promise

class telegram.utils.promise.Promise(pooled_function, args, kwargs)

Bases: object
A simple Promise implementation for use with the run_async decorator, DelayQueue etc.
Parameters
• pooled_function (callable) – The callable that will be called concurrently.
• args (list | tuple) – Positional arguments for pooled_function.
• kwargs (dict) – Keyword arguments for pooled_function.

3.3. telegram.utils package 233

Python Telegram Bot Documentation, Release 12.8

pooled_function
The callable that will be called concurrently.
Type callable
args
Positional arguments for pooled_function.
Type list | tuple
kwargs
Keyword arguments for pooled_function.
Type dict
done
Is set when the result is available.
Type threading.Event
exception
The exception raised by pooled_function or None if no exception has been raised (yet).
result(timeout=None)
Return the result of the Promise.
Parameters timeout (float, optional) – Maximum time in seconds to wait for the result
to be calculated. None means indefinite. Default is None.
Returns Returns the return value of pooled_function or None if the timeout ex-
pires.
Raises Any exception raised by pooled_function.
run()
Calls the pooled_function callable.

3.3.3 telegram.utils.request.Request

class telegram.utils.request.Request(con_pool_size=1, proxy_url=None, url-

lib3_proxy_kwargs=None, connect_timeout=5.0,
read_timeout=5.0)
Bases: object
Helper class for python-telegram-bot which provides methods to perform POST & GET towards telegram
servers.
Parameters
• con_pool_size (int) – Number of connections to keep in the connection pool.
• proxy_url (str) – The URL to the proxy server. For example:
http://127.0.0.1:3128.
• urllib3_proxy_kwargs (dict) – Arbitrary arguments passed as-is to url-
lib3.ProxyManager. This value will be ignored if proxy_url is not set.
• connect_timeout (int|float) – The maximum amount of time (in seconds) to
wait for a connection attempt to a server to succeed. None will set an infinite timeout
for connection attempts. (default: 5.)
• read_timeout (int|float) – The maximum amount of time (in seconds) to wait
between consecutive read operations for a response from the server. None will set an
infinite timeout. This value is usually overridden by the various telegram.Bot meth-
ods. (default: 5.)
con_pool_size
The size of the connection pool used.

234 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

download(url, filename, timeout=None)

Download a file by its URL.
Parameters
• url (str) – The web location we want to retrieve.
• timeout – 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).
get(url, timeout=None)
Request an URL.
Parameters
• url (str) – The web location we want to retrieve.
• timeout (int | float) – 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 JSON object.
post(url, data, timeout=None)
Request an URL.
Parameters
• url (str) – The web location we want to retrieve.
• data (dict[str, str|int]) – A dict of key/value pairs.
• timeout (int | float) – 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 JSON object.
retrieve(url, timeout=None)
Retrieve the contents of a file by its URL.
Parameters
• url (str) – The web location we want to retrieve.
• timeout (int | float) – 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).

3.4 Changelog

3.4.1 Changelog

Version 12.8

Released 2020-06-22
Major Changes:
• Remove Python 2 support (#1715)
• Bot API 4.9 support (#1980)
• IDs/Usernames of Filters.user and Filters.chat can now be updated (#1757)
Minor changes, CI improvements, doc fixes or bug fixes:
• Update contribution guide and stale bot (#1937)
• Remove NullHandlers (#1913)
• Improve and expand examples (#1943, #1995, #1983, #1997)

3.4. Changelog 235

Python Telegram Bot Documentation, Release 12.8

• Doc fixes (#1940, #1962)

• Add User.send_poll() shortcut (#1968)
• Ignore private attributes en TelegramObject.to_dict() (#1989)
• Stabilize CI (#2000)

Version 12.7

Released 2020-05-02
Major Changes:
• Bot API 4.8 support. Note: The Dice object now has a second positional argument emoji. This is
relevant, if you instantiate Dice objects manually. (#1917)
New Features:
• New method run_mothly for the JobQueue (#1705)
• Job.next_t now gives the datetime of the jobs next execution (#1685)
Minor changes, CI improvements, doc fixes or bug fixes:
• Added tzinfo argument to helpers.from_timestamp (#1621)
• Stabalize CI (#1919, #1931)
• Use ABCs @abstractmethod instead of raising NotImplementedError for Handler,
BasePersistence and BaseFilter (#1905)
• Doc fixes (#1914, #1902, #1910)

Version 12.6.1

Released 2020-04-11
Bug fixes:
• Fix serialization of reply_markup in media messages (#1889)

Version 12.6

Released 2020-04-10
Major Changes:
• Bot API 4.7 support. Note: In Bot.create_new_sticker_set and Bot.
add_sticker_to_set, the order of the parameters had be changed, as the png_sticker parameter
is now optional. (#1858)
Minor changes, CI improvements or bug fixes:
• Add tests for swtich_inline_query(_current_chat) with empty string (#1635)
• Doc fixes (#1854, #1874, #1884)
• Update issue templates (#1880)
• Favor concrete types over “Iterable” (#1882)
• Pass last valid CallbackContext to TIMEOUT handlers of ConversationHandler (#1826)
• Tweak handling of persistence and update persistence after job calls (#1827)
• Use checkout@v2 for GitHub actions (#1887)

236 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Version 12.5.1

Released 2020-03-30
Minor changes, doc fixes or bug fixes:
• Add missing docs for PollHandler and PollAnswerHandler (#1853)
• Fix wording in Filters docs (#1855)
• Reorder tests to make them more stable (#1835)
• Make ConversationHandler attributes immutable (#1756)
• Make PrefixHandler attributes command and prefix editable (#1636)
• Fix UTC as default tzinfo for Job (#1696)

Version 12.5

Released 2020-03-29
New Features:
• Bot.link gives the t.me link of the bot (#1770)
Major Changes:
• Bot API 4.5 and 4.6 support. (#1508, #1723)
Minor changes, CI improvements or bug fixes:
• Remove legacy CI files (#1783, #1791)
• Update pre-commit config file (#1787)
• Remove builtin names (#1792)
• CI improvements (#1808, #1848)
• Support Python 3.8 (#1614, #1824)
• Use stale bot for auto closing stale issues (#1820, #1829, #1840)
• Doc fixes (#1778, #1818)
• Fix typo in edit_message_media (#1779)
• In examples, answer CallbackQueries and use edit_message_text shortcut (#1721)
• Revert accidental change in vendored urllib3 (#1775)

Version 12.4.2

Released 2020-02-10
Bug Fixes
• Pass correct parse_mode to InlineResults if bot.defaults is None (#1763)
• Make sure PP can read files that dont have bot_data (#1760)

Version 12.4.1

Released 2020-02-08
This is a quick release for #1744 which was accidently left out of v12.4.0 though mentioned in the release notes.

3.4. Changelog 237

Python Telegram Bot Documentation, Release 12.8

Version 12.4.0

Released 2020-02-08
New features:
• Set default values for arguments appearing repeatedly. We also have a wiki page for the new defaults.
(#1490)
• Store data in CallbackContext.bot_data to access it in every callback. Also persists. (#1325)
• Filters.poll allows only messages containing a poll (#1673)
Major changes:
• Filters.text now accepts messages that start with a slash, because CommandHandler checks for
MessageEntity.BOT_COMMAND since v12. This might lead to your MessageHandlers receiving more
updates than before (#1680).
• Filters.command new checks for MessageEntity.BOT_COMMAND instead of just a leading slash.
Also by Filters.command(False) you can now filters for messages containing a command anywhere
in the text (#1744).
Minor changes, CI improvements or bug fixes:
• Add disptacher argument to Updater to allow passing a customized Dispatcher (#1484)
• Add missing names for Filters (#1632)
• Documentation fixes (#1624, #1647, #1669, #1703, #1718, #1734, #1740, #1642, #1739, #1746)
• CI improvements (#1716, #1731, #1738, #1748, #1749, #1750, #1752)
• Fix spelling issue for encode_conversations_to_json (#1661)
• Remove double assignement of Dispatcher.job_queue (#1698)
• Expose dispatcher as property for CallbackContext (#1684)
• Fix None check in JobQueue._put() (#1707)
• Log datetimes correctly in JobQueue (#1714)
• Fix false Message.link creation for private groups (#1741)
• Add option --with-upstream-urllib3 to setup.py to allow using non-vendored version (#1725)
• Fix persistence for nested ConversationHandlers (#1679)
• Improve handling of non-decodable server responses (#1623)
• Fix download for files without file_path (#1591)
• test_webhook_invalid_posts is now considered flaky and retried on failure (#1758)

Version 12.3.0

Released 2020-01-11
New features:
• Filters.caption allows only messages with caption (#1631).
• Filter for exact messages/captions with new capability of Filters.text and Filters.caption. Especially useful
in combination with ReplyKeyboardMarkup. (#1631).
Major changes:
• Fix inconsistent handling of naive datetimes (#1506).
Minor changes, CI improvements or bug fixes:

238 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• Documentation fixes (#1558, #1569, #1579, #1572, #1566, #1577, #1656).

• Add mutex protection on ConversationHandler (#1533).
• Add MAX_PHOTOSIZE_UPLOAD constant (#1560).
• Add args and kwargs to Message.forward() (#1574).
• Transfer to GitHub Actions CI (#1555, #1556, #1605, #1606, #1607, #1612, #1615, #1645).
• Fix deprecation warning with Py3.8 by vendored urllib3 (#1618).
• Simplify assignements for optional arguments (#1600)
• Allow private groups for Message.link (#1619).
• Fix wrong signature call for ConversationHandler.TIMEOUT handlers (#1653).

Version 12.2.0

Released 2019-10-14
New features:
• Nested ConversationHandlers (#1512).
Minor changes, CI improvments or bug fixes:
• Fix CI failures due to non-backward compat attrs depndency (#1540).
• travis.yaml: TEST_OFFICIAL removed from allowed_failures.
• Fix typos in examples (#1537).
• Fix Bot.to_dict to use proper first_name (#1525).
• Refactor test_commandhandler.py (#1408).
• Add Python 3.8 (RC version) to Travis testing matrix (#1543).
• test_bot.py: Add to_dict test (#1544).
• Flake config moved into setup.cfg (#1546).

Version 12.1.1

Released 2019-09-18
Hot fix release
Fixed regression in the vendored urllib3 (#1517).

Version 12.1.0

Released 2019-09-13
Major changes:
• Bot API 4.4 support (#1464, #1510)
• Add get_file method to Animation & ChatPhoto. Add, get_small_file & get_big_file methods to ChatPhoto
(#1489)
• Tools for deep linking (#1049)
Minor changes and/or bug fixes:
• Documentation fixes (#1500, #1499)
• Improved examples (#1502)

3.4. Changelog 239

Python Telegram Bot Documentation, Release 12.8

Version 12.0.0

Released 2019-08-29
Well. . . This felt like decades. But here we are with a new release.
Expect minor releases soon (mainly complete Bot API 4.4 support)
Major and/or breaking changes:
• Context based callbacks
• Persistence
• PrefixHandler added (Handler overhaul)
• Deprecation of RegexHandler and edited_messages, channel_post, etc. arguments (Filter overhaul)
• Various ConversationHandler changes and fixes
• Bot API 4.1, 4.2, 4.3 support
• Python 3.4 is no longer supported
• Error Handler now handles all types of exceptions (#1485)
• Return UTC from from_timestamp() (#1485)
See the wiki page at https://git.io/fxJuV for a detailed guide on how to migrate from version 11 to version
12.

Context based callbacks (#1100)

• Use of pass_ in handlers is deprecated.

• Instead use use_context=True on Updater or Dispatcher and change callback from (bot, update,
others. . . ) to (update, context).
• This also applies to error handlers Dispatcher.add_error_handler and JobQueue jobs (change
(bot, job) to (context) here).
• For users with custom handlers subclassing Handler, this is mostly backwards compatible, but to use the
new context based callbacks you need to implement the new collect_additional_context method.
• Passing bot to JobQueue.__init__ is deprecated. Use JobQueue.set_dispatcher with a dispatcher in-
stead.
• Dispatcher makes sure to use a single CallbackContext for a entire update. This means that if an update is
handled by multiple handlers (by using the group argument), you can add custom arguments to the Callback-
Context in a lower group handler and use it in higher group handler. NOTE: Never use with @run_async,
see docs for more info. (#1283)
• If you have custom handlers they will need to be updated to support the changes in this release.
• Update all examples to use context based callbacks.

Persistence (#1017)

• Added PicklePersistence and DictPersistence for adding persistence to your bots.

• BasePersistence can be subclassed for all your persistence needs.
• Add a new example that shows a persistent ConversationHandler bot

240 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

Handler overhaul (#1114)

• CommandHandler now only triggers on actual commands as defined by telegram servers (everything that
the clients mark as a tabable link).
• PrefixHandler can be used if you need to trigger on prefixes (like all messages starting with a “/” (old
CommandHandler behaviour) or even custom prefixes like “#” or “!”).

Filter overhaul (#1221)

• RegexHandler is deprecated and should be replaced with a MessageHandler with a regex filter.
• Use update filters to filter update types instead of arguments (message_updates, channel_post_updates and
edited_updates) on the handlers.
• Completely remove allow_edited argument - it has been deprecated for a while.
• data_filters now exist which allows filters that return data into the callback function. This is how the regex
filter is implemented.
• All this means that it no longer possible to use a list of filters in a handler. Use bitwise operators instead!

ConversationHandler

• Remove run_async_timeout and timed_out_behavior arguments (#1344)

• Replace with WAITING constant and behavior from states (#1344)
• Only emit one warning for multiple CallbackQueryHandlers in a ConversationHandler (#1319)
• Use warnings.warn for ConversationHandler warnings (#1343)
• Fix unresolvable promises (#1270)

Bug fixes & improvements

• Handlers should be faster due to deduped logic.

• Avoid compiling compiled regex in regex filter. (#1314)
• Add missing left_chat_member to Message.MESSAGE_TYPES (#1336)
• Make custom timeouts actually work properly (#1330)
• Add convenience classmethods (from_button, from_row and from_column) to InlineKeyboardMarkup
• Small typo fix in setup.py (#1306)
• Add Conflict error (HTTP error code 409) (#1154)
• Change MAX_CAPTION_LENGTH to 1024 (#1262)
• Remove some unnecessary clauses (#1247, #1239)
• Allow filenames without dots in them when sending files (#1228)
• Fix uploading files with unicode filenames (#1214)
• Replace http.server with Tornado (#1191)
• Allow SOCKSConnection to parse username and password from URL (#1211)
• Fix for arguments in passport/data.py (#1213)
• Improve message entity parsing by adding text_mention (#1206)
• Documentation fixes (#1348, #1397, #1436)

3.4. Changelog 241

Python Telegram Bot Documentation, Release 12.8

• Merged filters short-circuit (#1350)

• Fix webhook listen with tornado (#1383)
• Call task_done() on update queue after update processing finished (#1428)
• Fix send_location() - latitude may be 0 (#1437)
• Make MessageEntity objects comparable (#1465)
• Add prefix to thread names (#1358)

Buf fixes since v12.0.0b1

• Fix setting bot on ShippingQuery (#1355)

• Fix _trigger_timeout() missing 1 required positional argument: ‘job’ (#1367)
• Add missing message.text check in PrefixHandler check_update (#1375)
• Make updates persist even on DispatcherHandlerStop (#1463)
• Dispatcher force updating persistence object’s chat data attribute(#1462)

Internal improvements

• Finally fix our CI builds mostly (too many commits and PRs to list)
• Use multiple bots for CI to improve testing times significantly.
• Allow pypy to fail in CI.
• Remove the last CamelCase CheckUpdate methods from the handlers we missed earlier.
• test_official is now executed in a different job

Version 11.1.0

Released 2018-09-01
Fixes and updates for Telegram Passport: (#1198)
• Fix passport decryption failing at random times
• Added support for middle names.
• Added support for translations for documents
• Add errors for translations for documents
• Added support for requesting names in the language of the user’s country of residence
• Replaced the payload parameter with the new parameter nonce
• Add hash to EncryptedPassportElement

Version 11.0.0

Released 2018-08-29
Fully support Bot API version 4.0! (also some bugfixes :))
Telegram Passport (#1174):
• Add full support for telegram passport.

242 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

– New types: PassportData, PassportFile, EncryptedPassportElement, EncryptedCredentials,

PassportElementError, PassportElementErrorDataField, PassportElementErrorFrontSide, Pass-
portElementErrorReverseSide, PassportElementErrorSelfie, PassportElementErrorFile and Pass-
portElementErrorFiles.
– New bot method: set_passport_data_errors
– New filter: Filters.passport_data
– Field passport_data field on Message
– PassportData can be easily decrypted.
– PassportFiles are automatically decrypted if originating from decrypted PassportData.
• See new passportbot.py example for details on how to use, or go to our telegram passport wiki page for
more info
• NOTE: Passport decryption requires new dependency cryptography.
Inputfile rework (#1184):
• Change how Inputfile is handled internally
• This allows support for specifying the thumbnails of photos and videos using the thumb= argument in the
different send_ methods.
• Also allows Bot.send_media_group to actually finally send more than one media.
• Add thumb to Audio, Video and Videonote
• Add Bot.edit_message_media together with InputMediaAnimation, InputMediaAudio, and inputMedi-
aDocument.
Other Bot API 4.0 changes:
• Add forusquare_type to Venue, InlineQueryResultVenue, InputVenueMessageContent, and
Bot.send_venue. (#1170)
• Add vCard support by adding vcard field to Contact, InlineQueryResultContact, InputContactMessageCon-
tent, and Bot.send_contact. (#1166)
• Support new message entities: CASHTAG and PHONE_NUMBER. (#1179)
– Cashtag seems to be things like $USD and $GBP, but it seems telegram doesn’t currently send
them to bots.
– Phone number also seems to have limited support for now
• Add Bot.send_animation, add width, height, and duration to Animation, and add Filters.animation. (#1172)
Non Bot API 4.0 changes:
• Minor integer comparison fix (#1147)
• Fix Filters.regex failing on non-text message (#1158)
• Fix ProcessLookupError if process finishes before we kill it (#1126)
• Add t.me links for User, Chat and Message if available and update User.mention_* (#1092)
• Fix mention_markdown/html on py2 (#1112)

Version 10.1.0

Released 2018-05-02
Fixes changing previous behaviour:
• Add urllib3 fix for socks5h support (#1085)
• Fix send_sticker() timeout=20 (#1088)

3.4. Changelog 243

Python Telegram Bot Documentation, Release 12.8

Fixes:
• Add a caption_entity filter for filtering caption entities (#1068)
• Inputfile encode filenames (#1086)
• InputFile: Fix proper naming of file when reading from subprocess.PIPE (#1079)
• Remove pytest-catchlog from requirements (#1099)
• Documentation fixes (#1061, #1078, #1081, #1096)

Version 10.0.2

Released 2018-04-17
Important fix:
• Handle utf8 decoding errors (#1076)
New features:
• Added Filter.regex (#1028)
• Filters for Category and file types (#1046)
• Added video note filter (#1067)
Fixes:
• Fix in telegram.Message (#1042)
• Make chat_id a positional argument inside shortcut methods of Chat and User classes (#1050)
• Make Bot.full_name return a unicode object. (#1063)
• CommandHandler faster check (#1074)
• Correct documentation of Dispatcher.add_handler (#1071)
• Various small fixes to documentation.

Version 10.0.1

Released 2018-03-05
Fixes:
• Fix conversationhandler timeout (PR #1032)
• Add missing docs utils (PR #912)

Version 10.0.0

Released 2018-03-02
Non backward compatabile changes and changed defaults
• JobQueue: Remove deprecated prevent_autostart & put() (PR #1012)
• Bot, Updater: Remove deprecated network_delay (PR #1012)
• Remove deprecated Message.new_chat_member (PR #1012)
• Retry bootstrap phase indefinitely (by default) on network errors (PR #1018)
New Features
• Support v3.6 API (PR #1006)

244 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• User.full_name convinience property (PR #949)

• Add send_phone_number_to_provider and send_email_to_provider arguments to send_invoice (PR #986)
• Bot: Add shortcut methods reply_{markdown,html} (PR #827)
• Bot: Add shortcut method reply_media_group (PR #994)
• Added utils.helpers.effective_message_type (PR #826)
• Bot.get_file now allows passing a file in addition to file_id (PR #963)
• Add .get_file() to Audio, Document, PhotoSize, Sticker, Video, VideoNote and Voice (PR #963)
• Add .send_*() methods to User and Chat (PR #963)
• Get jobs by name (PR #1011)
• Add Message caption html/markdown methods (PR #1013)
• File.download_as_bytearray - new method to get a d/led file as bytearray (PR #1019)
• File.download(): Now returns a meaningful return value (PR #1019)
• Added conversation timeout in ConversationHandler (PR #895)
Changes
• Store bot in PreCheckoutQuery (PR #953)
• Updater: Issue INFO log upon received signal (PR #951)
• JobQueue: Thread safety fixes (PR #977)
• WebhookHandler: Fix exception thrown during error handling (PR #985)
• Explicitly check update.effective_chat in ConversationHandler.check_update (PR #959)
• Updater: Better handling of timeouts during get_updates (PR #1007)
• Remove unnecessary to_dict() (PR #834)
• CommandHandler - ignore strings in entities and “/” followed by whitespace (PR #1020)
• Documentation & style fixes (PR #942, PR #956, PR #962, PR #980, PR #983)

Version 9.0.0

Released 2017-12-08
Breaking changes (possibly)
• Drop support for python 3.3 (PR #930)
New Features
• Support Bot API 3.5 (PR #920)
Changes
• Fix race condition in dispatcher start/stop (#887)
• Log error trace if there is no error handler registered (#694)
• Update examples with consistent string formatting (#870)
• Various changes and improvements to the docs.

Version 8.1.1

Released 2017-10-15
• Fix Commandhandler crashing on single character messages (PR #873).

3.4. Changelog 245

Python Telegram Bot Documentation, Release 12.8

Version 8.1.0

Released 2017-10-14
New features - Support Bot API 3.4 (PR #865).
Changes - MessageHandler & RegexHandler now consider channel_updates. - Fix command not recognized if it
is directly followed by a newline (PR #869). - Removed Bot._message_wrapper (PR #822). - Unitests are now
also running on AppVeyor (Windows VM). - Various unitest improvements. - Documentation fixes.

Version 8.0.0

Released 2017-09-01
New features
• Fully support Bot Api 3.3 (PR #806).
• DispatcherHandlerStop (see docs).
• Regression fix for text_html & text_markdown (PR #777).
• Added effective_attachment to message (PR #766).
Non backward compatible changes
• Removed Botan support from the library (PR #776).
• Fully support Bot Api 3.3 (PR #806).
• Remove de_json() (PR #789).
Changes
• Sane defaults for tcp socket options on linux (PR #754).
• Add RESTRICTED as constant to ChatMember (PR #761).
• Add rich comparison to CallbackQuery (PR #764).
• Fix get_game_high_scores (PR #771).
• Warn on small con_pool_size during custom initalization of Updater (PR #793).
• Catch exceptions in error handlerfor errors that happen during polling (PR #810).
• For testing we switched to pytest (PR #788).
• Lots of small improvements to our tests and documentation.

Version 7.0.1

Released 2017-07-28
• Fix TypeError exception in RegexHandler (PR #751).
• Small documentation fix (PR #749).

Version 7.0.0

Released 2017-07-25
• Fully support Bot API 3.2.
• New filters for handling messages from specific chat/user id (PR #677).
• Add the possibility to add objects as arguments to send_* methods (PR #742).
• Fixed download of URLs with UTF-8 chars in path (PR #688).

246 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• Fixed URL parsing for Message text properties (PR #689).

• Fixed args dispatching in MessageQueue’s decorator (PR #705).
• Fixed regression preventing IPv6 only hosts from connnecting to Telegram servers (Issue #720).
• ConvesationHandler - check if a user exist before using it (PR #699).
• Removed deprecated telegram.Emoji.
• Removed deprecated Botan import from utils (Botan is still available through contrib).
• Removed deprecated ReplyKeyboardHide.
• Removed deprecated edit_message argument of bot.set_game_score.
• Internal restructure of files.
• Improved documentation.
• Improved unitests.

Pre-version 7.0

2017-06-18
Released 6.1.0
• Fully support Bot API 3.0
• Add more fine-grained filters for status updates
• Bug fixes and other improvements
2017-05-29
Released 6.0.3
• Faulty PyPI release
2017-05-29
Released 6.0.2
• Avoid confusion with user’s urllib3 by renaming vendored urllib3 to ptb_urllib3
2017-05-19
Released 6.0.1
• Add support for User.language_code
• Fix Message.text_html and Message.text_markdown for messages with emoji
2017-05-19
Released 6.0.0
• Add support for Bot API 2.3.1
• Add support for deleteMessage API method
• New, simpler API for JobQueue - https://github.com/python-telegram-bot/python-telegram-bot/pull/484
• Download files into file-like objects - https://github.com/python-telegram-bot/python-telegram-bot/pull/
459
• Use vendor urllib3 to address issues with timeouts - The default timeout for messages is now 5 seconds.
For sending media, the default timeout is now 20 seconds.
• String attributes that are not set are now None by default, instead of empty strings
• Add text_markdown and text_html properties to Message - https://github.com/
python-telegram-bot/python-telegram-bot/pull/507

3.4. Changelog 247

Python Telegram Bot Documentation, Release 12.8

• Add support for Socks5 proxy - https://github.com/python-telegram-bot/python-telegram-bot/pull/518

• Add support for filters in CommandHandler - https://github.com/python-telegram-bot/
python-telegram-bot/pull/536
• Add the ability to invert (not) filters - https://github.com/python-telegram-bot/python-telegram-bot/pull/552
• Add Filters.group and Filters.private
• Compatibility with GAE via urllib3.contrib package - https://github.com/python-telegram-bot/
python-telegram-bot/pull/583
• Add equality rich comparision operators to telegram objects - https://github.com/python-telegram-bot/
python-telegram-bot/pull/604
• Several bugfixes and other improvements
• Remove some deprecated code
2017-04-17
Released 5.3.1
• Hotfix release due to bug introduced by urllib3 version 1.21
2016-12-11
Released 5.3
• Implement API changes of November 21st (Bot API 2.3)
• JobQueue now supports datetime.timedelta in addition to seconds
• JobQueue now supports running jobs only on certain days
• New Filters.reply filter
• Bugfix for Message.edit_reply_markup
• Other bugfixes
2016-10-25
Released 5.2
• Implement API changes of October 3rd (games update)
• Add Message.edit_* methods
• Filters for the MessageHandler can now be combined using bitwise operators (& and |)
• Add a way to save user- and chat-related data temporarily
• Other bugfixes and improvements
2016-09-24
Released 5.1
• Drop Python 2.6 support
• Deprecate telegram.Emoji
• Use ujson if available
• Add instance methods to Message, Chat, User, InlineQuery and CallbackQuery
• RegEx filtering for CallbackQueryHandler and InlineQueryHandler
• New MessageHandler filters: forwarded and entity
• Add Message.get_entity to correctly handle UTF-16 codepoints and MessageEntity offsets
• Fix bug in ConversationHandler when first handler ends the conversation
• Allow multiple Dispatcher instances

248 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• Add ChatMigrated Exception

• Properly split and handle arguments in CommandHandler
2016-07-15
Released 5.0
• Rework JobQueue
• Introduce ConversationHandler
• Introduce telegram.constants - https://github.com/python-telegram-bot/python-telegram-bot/pull/
342
2016-07-12
Released 4.3.4
• Fix proxy support with urllib3 when proxy requires auth
2016-07-08
Released 4.3.3
• Fix proxy support with urllib3
2016-07-04
Released 4.3.2
• Fix: Use timeout parameter in all API methods
2016-06-29
Released 4.3.1
• Update wrong requirement: urllib3>=1.10
2016-06-28
Released 4.3
• Use urllib3.PoolManager for connection re-use
• Rewrite run_async decorator to re-use threads
• New requirements: urllib3 and certifi
2016-06-10
Released 4.2.1
• Fix CallbackQuery.to_dict() bug (thanks to @jlmadurga)
• Fix editMessageText exception when receiving a CallbackQuery
2016-05-28
Released 4.2
• Implement Bot API 2.1
• Move botan module to telegram.contrib
• New exception type: BadRequest
2016-05-22
Released 4.1.2
• Fix MessageEntity decoding with Bot API 2.1 changes
2016-05-16
Released 4.1.1

3.4. Changelog 249

Python Telegram Bot Documentation, Release 12.8

• Fix deprecation warning in Dispatcher

2016-05-15
Released 4.1
• Implement API changes from May 6, 2016
• Fix bug when start_polling with clean=True
• Methods now have snake_case equivalent, for example telegram.Bot.send_message is the same as
telegram.Bot.sendMessage
2016-05-01
Released 4.0.3
• Add missing attribute location to InlineQuery
2016-04-29
Released 4.0.2
• Bugfixes
• KeyboardReplyMarkup now accepts str again
2016-04-27
Released 4.0.1
• Implement Bot API 2.0
• Almost complete recode of Dispatcher
• Please read the Transition Guide to 4.0
• Changes from 4.0rc1
– The syntax of filters for MessageHandler (upper/lower cases)
– Handler groups are now identified by int only, and ordered
• Note: v4.0 has been skipped due to a PyPI accident
2016-04-22
Released 4.0rc1
• Implement Bot API 2.0
• Almost complete recode of Dispatcher
• Please read the Transistion Guide to 4.0
2016-03-22
Released 3.4
• Move Updater, Dispatcher and JobQueue to new telegram.ext submodule (thanks to @rahiel)
• Add disable_notification parameter (thanks to @aidarbiktimirov)
• Fix bug where commands sent by Telegram Web would not be recognized (thanks to @shelomentsevd)
• Add option to skip old updates on bot startup
• Send files from BufferedReader
2016-02-28
Released 3.3
• Inline bots
• Send any file by URL

250 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• Specialized exceptions: Unauthorized, InvalidToken, NetworkError and TimedOut

• Integration for botan.io (thanks to @ollmer)
• HTML Parsemode (thanks to @jlmadurga)
• Bugfixes and under-the-hood improvements
Very special thanks to Noam Meltzer (@tsnoam) for all of his work!
2016-01-09
Released 3.3b1
• Implement inline bots (beta)
2016-01-05
Released 3.2.0
• Introducing JobQueue (original author: @franciscod)
• Streamlining all exceptions to TelegramError (Special thanks to @tsnoam)
• Proper locking of Updater and Dispatcher start and stop methods
• Small bugfixes
2015-12-29
Released 3.1.2
• Fix custom path for file downloads
• Don’t stop the dispatcher thread on uncaught errors in handlers
2015-12-21
Released 3.1.1
• Fix a bug where asynchronous handlers could not have additional arguments
• Add groups and groupdict as additional arguments for regex-based handlers
2015-12-16
Released 3.1.0
• The chat-field in Message is now of type Chat. (API update Oct 8 2015)
• Message now contains the optional fields supergroup_chat_created, migrate_to_chat_id,
migrate_from_chat_id and channel_chat_created. (API update Nov 2015)
2015-12-08
Released 3.0.0
• Introducing the Updater and Dispatcher classes
2015-11-11
Released 2.9.2
• Error handling on request timeouts has been improved
2015-11-10
Released 2.9.1
• Add parameter network_delay to Bot.getUpdates for slow connections
2015-11-10
Released 2.9
• Emoji class now uses bytes_to_native_str from future 3rd party lib

3.4. Changelog 251

Python Telegram Bot Documentation, Release 12.8

• Make user_from optional to work with channels

• Raise exception if Telegram times out on long-polling
Special thanks to @jh0ker for all hard work
2015-10-08
Released 2.8.7
• Type as optional for GroupChat class
2015-10-08
Released 2.8.6
• Adds type to User and GroupChat classes (pre-release Telegram feature)
2015-09-24
Released 2.8.5
• Handles HTTP Bad Gateway (503) errors on request
• Fixes regression on Audio and Document for unicode fields
2015-09-20
Released 2.8.4
• getFile and File.download is now fully supported
2015-09-10
Released 2.8.3
• Moved Bot._requestURL to its own class (telegram.utils.request)
• Much better, such wow, Telegram Objects tests
• Add consistency for str properties on Telegram Objects
• Better design to test if chat_id is invalid
• Add ability to set custom filename on Bot.sendDocument(..,filename='')
• Fix Sticker as InputFile
• Send JSON requests over urlencoded post data
• Markdown support for Bot.sendMessage(..., parse_mode=ParseMode.MARKDOWN)
• Refactor of TelegramError class (no more handling IOError or URLError)
2015-09-05
Released 2.8.2
• Fix regression on Telegram ReplyMarkup
• Add certificate to is_inputfile method
2015-09-05
Released 2.8.1
• Fix regression on Telegram objects with thumb properties
2015-09-04
Released 2.8
• TelegramError when chat_id is empty for send* methods
• setWebhook now supports sending self-signed certificate
• Huge redesign of existing Telegram classes

252 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• Added support for PyPy

• Added docstring for existing classes
2015-08-19
Released 2.7.1
• Fixed JSON serialization for message
2015-08-17
Released 2.7
• Added support for Voice object and sendVoice method
• Due backward compatibility performer or/and title will be required for sendAudio
• Fixed JSON serialization when forwarded message
2015-08-15
Released 2.6.1
• Fixed parsing image header issue on < Python 2.7.3
2015-08-14
Released 2.6.0
• Depreciation of require_authentication and clearCredentials methods
• Giving AUTHORS the proper credits for their contribution for this project
• Message.date and Message.forward_date are now datetime objects
2015-08-12
Released 2.5.3
• telegram.Bot now supports to be unpickled
2015-08-11
Released 2.5.2
• New changes from Telegram Bot API have been applied
• telegram.Bot now supports to be pickled
• Return empty str instead None when message.text is empty
2015-08-10
Released 2.5.1
• Moved from GPLv2 to LGPLv3
2015-08-09
Released 2.5
• Fixes logging calls in API
2015-08-08
Released 2.4
• Fixes Emoji class for Python 3
• PEP8 improvements
2015-08-08
Released 2.3
• Fixes ForceReply class

3.4. Changelog 253

Python Telegram Bot Documentation, Release 12.8

• Remove logging.basicConfig from library

2015-07-25
Released 2.2
• Allows debug=True when initializing telegram.Bot
2015-07-20
Released 2.1
• Fix to_dict for Document and Video
2015-07-19
Released 2.0
• Fixes bugs
• Improves __str__ over to_json()
• Creates abstract class TelegramObject
2015-07-15
Released 1.9
• Python 3 officially supported
• PEP8 improvements
2015-07-12
Released 1.8
• Fixes crash when replying an unicode text message (special thanks to JRoot3D)
2015-07-11
Released 1.7
• Fixes crash when username is not defined on chat (special thanks to JRoot3D)
2015-07-10
Released 1.6
• Improvements for GAE support
2015-07-10
Released 1.5
• Fixes randomly unicode issues when using InputFile
2015-07-10
Released 1.4
• requests lib is no longer required
• Google App Engine (GAE) is supported
2015-07-10
Released 1.3
• Added support to setWebhook (special thanks to macrojames)
2015-07-09
Released 1.2
• CustomKeyboard classes now available
• Emojis available

254 Chapter 3. Reference

 Python Telegram Bot Documentation, Release 12.8

• PEP8 improvements
2015-07-08
Released 1.1
• PyPi package now available
2015-07-08
Released 1.0
• Initial checkin of python-telegram-bot

3.4. Changelog 255

Python Telegram Bot Documentation, Release 12.8

256 Chapter 3. Reference

 Python Module Index

t
telegram.constants, 122
telegram.error, 126
telegram.ext.filters, 11
telegram.utils.helpers, 230

257
Python Telegram Bot Documentation, Release 12.8

258 Python Module Index

 Index

Symbols allow_reentry (telegram.ext.ConversationHandler

__call__() (telegram.ext.DelayQueue method), 28 attribute), 37
__call__() (telegram.ext.MessageQueue method), allowed_updates (telegram.WebhookInfo at-
26 tribute), 175
__init__() (telegram.ext.DelayQueue method), 28 allows_multiple_answers (telegram.Poll at-
__init__() (telegram.ext.MessageQueue method), tribute), 158
26 amount (telegram.LabeledPrice attribute), 210
__weakref__ (telegram.ext.MessageQueue at- Animation (class in telegram), 64
tribute), 27 animation (telegram.ext.filters.Filters attribute), 11
_queue (telegram.ext.JobQueue attribute), 23 animation (telegram.Game attribute), 217
animation (telegram.Message attribute), 140
A answer() (telegram.CallbackQuery method), 110
add_chat_ids() (telegram.ext.filters.Filters.chat answer() (telegram.InlineQuery method), 179
method), 12 answer() (telegram.PreCheckoutQuery method),
add_error_handler() (telegram.ext.Dispatcher 216
method), 9 answer() (telegram.ShippingQuery method), 214
add_handler() (telegram.ext.Dispatcher method), answer_callback_query() (telegram.Bot
9 method), 68
add_sticker_to_set() (telegram.Bot method), answer_inline_query() (telegram.Bot method),
67 69
add_user_ids() (telegram.ext.filters.Filters.user answer_pre_checkout_query() (telegram.Bot
method), 19 method), 70
add_usernames() (telegram.ext.filters.Filters.chat answer_shipping_query() (telegram.Bot
method), 12 method), 70
add_usernames() (telegram.ext.filters.Filters.user answerCallbackQuery() (telegram.Bot method),
method), 19 68
address (telegram.InlineQueryResultVenue at- answerInlineQuery() (telegram.Bot method), 68
tribute), 202 answerPreCheckoutQuery() (telegram.Bot
address (telegram.InputVenueMessageContent at- method), 68
tribute), 208 answerShippingQuery() (telegram.Bot method),
address (telegram.SecureData attribute), 222 68
address (telegram.Venue attribute), 170 apk (telegram.ext.filters.Filters attribute), 14
addStickerToSet() (telegram.Bot method), 67 application (telegram.ext.filters.Filters attribute),
ADMINISTRATOR (telegram.ChatMember attribute), 14
119 args (telegram.ext.CallbackContext attribute), 29
all (telegram.ext.filters.Filters attribute), 11 args (telegram.utils.promise.Promise attribute), 234
ALL_EMOJI (telegram.Dice attribute), 124 attach (telegram.InputFile attribute), 131
ALL_TYPES (telegram.MessageEntity attribute), 155 Audio (class in telegram), 66
allow_edited (telegram.ext.CommandHandler at- audio (telegram.ext.filters.Filters attribute), 11, 14
tribute), 39 audio (telegram.Message attribute), 140
allow_empty (telegram.ext.filters.Filters.chat audio_duration (tele-
attribute), 12 gram.InlineQueryResultAudio attribute),
allow_empty (telegram.ext.filters.Filters.user 182
attribute), 18 audio_file_id (tele-

259
Python Telegram Bot Documentation, Release 12.8

gram.InlineQueryResultCachedAudio at- C
tribute), 183 callback (telegram.ext.CallbackQueryHandler at-
audio_url (telegram.InlineQueryResultAudio tribute), 33
attribute), 182 callback (telegram.ext.ChosenInlineResultHandler
author_signature (telegram.Message attribute), attribute), 35
142 callback (telegram.ext.CommandHandler attribute),
39
B callback (telegram.ext.Handler attribute), 31
BadRequest, 126 callback (telegram.ext.InlineQueryHandler at-
bank_statement (telegram.SecureData attribute), tribute), 41
223 callback (telegram.ext.Job attribute), 21
BaseFilter (class in telegram.ext.filters), 19 callback (telegram.ext.MessageHandler attribute),
BasePersistence (class in telegram.ext), 58 43
BASKETBALL (telegram.Dice attribute), 124 callback (telegram.ext.PollAnswerHandler at-
basketball (telegram.ext.filters.Filters attribute), tribute), 45
13 callback (telegram.ext.PollHandler attribute), 46
big_file_id (telegram.ChatPhoto attribute), 121 callback (telegram.ext.PreCheckoutQueryHandler
big_file_unique_id (telegram.ChatPhoto attribute), 48
attribute), 121 callback (telegram.ext.PrefixHandler attribute), 49
birth_date (telegram.PersonalDetails attribute), callback (telegram.ext.RegexHandler attribute), 51
224 callback (telegram.ext.ShippingQueryHandler at-
BOLD (telegram.MessageEntity attribute), 155 tribute), 53
Bot (class in telegram), 67 callback (telegram.ext.StringCommandHandler at-
bot (telegram.Animation attribute), 65 tribute), 54
bot (telegram.Audio attribute), 66 callback (telegram.ext.StringRegexHandler at-
bot (telegram.CallbackQuery attribute), 109 tribute), 56
bot (telegram.Document attribute), 125 callback (telegram.ext.TypeHandler attribute), 57
bot (telegram.EncryptedPassportElement attribute), callback_data (telegram.InlineKeyboardButton
228 attribute), 129
bot (telegram.ext.CallbackContext attribute), 29 callback_game (telegram.InlineKeyboardButton
bot (telegram.ext.Dispatcher attribute), 8 attribute), 129
bot (telegram.ext.JobQueue attribute), 23 callback_query (telegram.Update attribute), 165
bot (telegram.ext.Updater attribute), 5 CallbackContext (class in telegram.ext), 28
bot (telegram.Message attribute), 143 CallbackGame (class in telegram), 218
bot (telegram.PassportData attribute), 225 CallbackQuery (class in telegram), 108
bot (telegram.PassportFile attribute), 226 CallbackQueryHandler (class in telegram.ext),
bot (telegram.PhotoSize attribute), 157 33
bot (telegram.PreCheckoutQuery attribute), 215 can_add_web_page_previews (tele-
bot (telegram.ShippingQuery attribute), 214 gram.ChatMember attribute), 118
bot (telegram.Sticker attribute), 176 can_add_web_page_previews (tele-
bot (telegram.User attribute), 167 gram.ChatPermissions attribute), 120
bot (telegram.Video attribute), 171 can_be_edited (telegram.ChatMember attribute),
bot (telegram.VideoNote attribute), 173 117
bot (telegram.Voice attribute), 174 can_change_info (telegram.ChatMember at-
BOT_COMMAND (telegram.MessageEntity attribute), tribute), 117
155 can_change_info (telegram.ChatPermissions at-
bot_data (telegram.ext.CallbackContext attribute), tribute), 120
29 can_delete_messages (telegram.ChatMember
bot_data (telegram.ext.DictPersistence attribute), 63 attribute), 117
bot_data (telegram.ext.Dispatcher attribute), 8 can_edit_messages (telegram.ChatMember at-
bot_data_json (telegram.ext.DictPersistence at- tribute), 117
tribute), 63 can_invite_users (telegram.ChatMember at-
bot_username (telegram.LoginUrl attribute), 138 tribute), 118
BotCommand (class in telegram), 108 can_invite_users (telegram.ChatPermissions at-
burst_limit (telegram.ext.DelayQueue attribute), tribute), 120
27 can_join_groups (telegram.Bot attribute), 71
can_join_groups (telegram.User attribute), 167

260 Index
 Python Telegram Bot Documentation, Release 12.8

can_pin_messages (telegram.ChatMember at- tribute), 204

tribute), 118 caption (telegram.InlineQueryResultVoice at-
can_pin_messages (telegram.ChatPermissions at- tribute), 205
tribute), 120 caption (telegram.InputMediaAnimation attribute),
can_post_messages (telegram.ChatMember at- 131
tribute), 117 caption (telegram.InputMediaAudio attribute), 133
can_promote_members (telegram.ChatMember caption (telegram.InputMediaDocument attribute),
attribute), 118 134
can_read_all_group_messages (telegram.Bot caption (telegram.InputMediaPhoto attribute), 135
attribute), 71 caption (telegram.InputMediaVideo attribute), 135
can_read_all_group_messages (tele- caption (telegram.Message attribute), 141
gram.User attribute), 167 caption_entities (telegram.Message attribute),
can_restrict_members (telegram.ChatMember 140
attribute), 118 caption_html (telegram.Message attribute), 145
can_send_media_messages (tele- caption_html_urled (telegram.Message at-
gram.ChatMember attribute), 118 tribute), 145
can_send_media_messages (tele- caption_markdown (telegram.Message attribute),
gram.ChatPermissions attribute), 120 145
can_send_messages (telegram.ChatMember at- caption_markdown_urled (telegram.Message
tribute), 118 attribute), 146
can_send_messages (telegram.ChatPermissions caption_markdown_v2 (telegram.Message at-
attribute), 120 tribute), 146
can_send_other_messages (tele- caption_markdown_v2_urled (tele-
gram.ChatMember attribute), 118 gram.Message attribute), 146
can_send_other_messages (tele- CASHTAG (telegram.MessageEntity attribute), 155
gram.ChatPermissions attribute), 120 category (telegram.ext.filters.Filters attribute), 14
can_send_polls (telegram.ChatMember attribute), CHANNEL (telegram.Chat attribute), 113
118 channel_chat_created (telegram.Message at-
can_send_polls (telegram.ChatPermissions at- tribute), 142
tribute), 120 channel_post (telegram.ext.filters.Filters at-
can_set_sticker_set (telegram.Chat attribute), tribute), 18
112 channel_post (telegram.Update attribute), 164
caption (telegram.ext.filters.Filters attribute), 11 channel_post_updates (tele-
caption (telegram.InlineQueryResultAudio at- gram.ext.MessageHandler attribute), 44
tribute), 182 channel_posts (telegram.ext.filters.Filters at-
caption (telegram.InlineQueryResultCachedAudio tribute), 18
attribute), 183 Chat (class in telegram), 111
caption (telegram.InlineQueryResultCachedDocument chat (telegram.Message attribute), 139
attribute), 184 chat_created (telegram.ext.filters.Filters at-
caption (telegram.InlineQueryResultCachedGif at- tribute), 17
tribute), 186 chat_data (telegram.ext.CallbackContext attribute),
caption (telegram.InlineQueryResultCachedMpeg4Gif 29
attribute), 187 chat_data (telegram.ext.DictPersistence attribute),
caption (telegram.InlineQueryResultCachedPhoto 63
attribute), 188 chat_data (telegram.ext.Dispatcher attribute), 8
caption (telegram.InlineQueryResultCachedVideo chat_data_json (telegram.ext.DictPersistence at-
attribute), 190 tribute), 63
caption (telegram.InlineQueryResultCachedVoice chat_id (telegram.Message attribute), 146
attribute), 191 chat_ids (telegram.ext.filters.Filters.chat attribute),
caption (telegram.InlineQueryResultDocument at- 12
tribute), 193 chat_instance (telegram.CallbackQuery at-
caption (telegram.InlineQueryResultGif attribute), tribute), 109
196 ChatAction (class in telegram), 116
caption (telegram.InlineQueryResultMpeg4Gif at- ChatMember (class in telegram), 117
tribute), 199 ChatMigrated, 126
caption (telegram.InlineQueryResultPhoto at- ChatPermissions (class in telegram), 120
tribute), 201 ChatPhoto (class in telegram), 121
caption (telegram.InlineQueryResultVideo at- check_update() (tele-

Index 261
Python Telegram Bot Documentation, Release 12.8

gram.ext.CallbackQueryHandler method), gram.ext.MessageHandler method), 45

34 collect_additional_context() (tele-
check_update() (tele- gram.ext.PrefixHandler method), 51
gram.ext.ChosenInlineResultHandler collect_additional_context() (tele-
method), 36 gram.ext.StringCommandHandler method),
check_update() (telegram.ext.CommandHandler 55
method), 40 collect_additional_context() (tele-
check_update() (tele- gram.ext.StringRegexHandler method),
gram.ext.ConversationHandler method), 57
38 collect_optional_args() (tele-
check_update() (telegram.ext.Handler method), gram.ext.CallbackQueryHandler method),
32 34
check_update() (tele- collect_optional_args() (tele-
gram.ext.InlineQueryHandler method), gram.ext.CommandHandler method), 41
43 collect_optional_args() (tele-
check_update() (telegram.ext.MessageHandler gram.ext.Handler method), 32
method), 45 collect_optional_args() (tele-
check_update() (telegram.ext.PollAnswerHandler gram.ext.InlineQueryHandler method),
method), 46 43
check_update() (telegram.ext.PollHandler collect_optional_args() (tele-
method), 47 gram.ext.RegexHandler method), 53
check_update() (tele- collect_optional_args() (tele-
gram.ext.PreCheckoutQueryHandler gram.ext.StringCommandHandler method),
method), 49 55
check_update() (telegram.ext.PrefixHandler collect_optional_args() (tele-
method), 51 gram.ext.StringRegexHandler method),
check_update() (tele- 57
gram.ext.ShippingQueryHandler method), command (telegram.BotCommand attribute), 108
54 command (telegram.ext.CommandHandler attribute),
check_update() (tele- 39
gram.ext.StringCommandHandler method), command (telegram.ext.filters.Filters attribute), 13
55 command (telegram.ext.PrefixHandler attribute), 49
check_update() (tele- command (telegram.ext.StringCommandHandler at-
gram.ext.StringRegexHandler method), tribute), 54
57 CommandHandler (class in telegram.ext), 39
check_update() (telegram.ext.TypeHandler commands (telegram.Bot attribute), 71
method), 58 con_pool_size (telegram.utils.request.Request at-
CHIN (telegram.MaskPosition attribute), 178 tribute), 234
chosen_inline_result (telegram.Update Conflict, 126
attribute), 165 connected_website (telegram.Message at-
ChosenInlineResult (class in telegram), 209 tribute), 142
ChosenInlineResultHandler (class in tele- Contact (class in telegram), 123
gram.ext), 35 contact (telegram.ext.filters.Filters attribute), 13
city (telegram.ResidentialAddress attribute), 225 contact (telegram.Message attribute), 141
city (telegram.ShippingAddress attribute), 211 contains_masks (telegram.StickerSet attribute),
close_date (telegram.Poll attribute), 159 177
CODE (telegram.MessageEntity attribute), 155 context (telegram.ext.Job attribute), 21
collect_additional_context() (tele- conversation_timeout (tele-
gram.ext.CallbackQueryHandler method), gram.ext.ConversationHandler attribute),
34 37
collect_additional_context() (tele- ConversationHandler (class in telegram.ext), 36
gram.ext.CommandHandler method), 41 conversations (telegram.ext.DictPersistence at-
collect_additional_context() (tele- tribute), 63
gram.ext.Handler method), 32 conversations_json (tele-
collect_additional_context() (tele- gram.ext.DictPersistence attribute), 63
gram.ext.InlineQueryHandler method), correct_option_id (telegram.Poll attribute), 158
43 country_code (telegram.PersonalDetails attribute),
collect_additional_context() (tele- 224

262 Index
 Python Telegram Bot Documentation, Release 12.8

country_code (telegram.ResidentialAddress at- DelayQueue (class in telegram.ext), 27

tribute), 225 delete() (telegram.Message method), 146
country_code (telegram.ShippingAddress at- delete_chat_photo (telegram.ext.filters.Filters
tribute), 211 attribute), 17
create_deep_linked_url() (in module tele- delete_chat_photo (telegram.Message at-
gram.utils.helpers), 231 tribute), 141
create_new_sticker_set() (telegram.Bot delete_chat_photo() (telegram.Bot method), 72
method), 71 delete_chat_sticker_set() (telegram.Bot
createNewStickerSet() (telegram.Bot method), method), 72
71 delete_message() (telegram.Bot method), 73
CREATOR (telegram.ChatMember attribute), 119 delete_sticker_from_set() (telegram.Bot
Credentials (class in telegram), 221 method), 73
credentials (telegram.PassportData attribute), delete_webhook() (telegram.Bot method), 74
225 deleteChatPhoto() (telegram.Bot method), 72
currency (telegram.Invoice attribute), 210 deleteChatStickerSet() (telegram.Bot
currency (telegram.PreCheckoutQuery attribute), method), 72
215 deleteMessage() (telegram.Bot method), 72
currency (telegram.SuccessfulPayment attribute), deleteStickerFromSet() (telegram.Bot
213 method), 72
custom_title (telegram.ChatMember attribute), deleteWebhook() (telegram.Bot method), 72
117 description (telegram.BotCommand attribute),
108
D description (telegram.Chat attribute), 111
DARTS (telegram.Dice attribute), 124 description (telegram.Game attribute), 216
darts (telegram.ext.filters.Filters attribute), 13 description (telegram.InlineQueryResultArticle
data (telegram.CallbackQuery attribute), 109 attribute), 181
data (telegram.EncryptedCredentials attribute), 229 description (tele-
data (telegram.EncryptedPassportElement attribute), gram.InlineQueryResultCachedDocument
227 attribute), 184
data (telegram.PassportData attribute), 225 description (tele-
data_filter (telegram.ext.filters.BaseFilter at- gram.InlineQueryResultCachedPhoto at-
tribute), 20 tribute), 188
data_hash (telegram.PassportElementErrorDataField description (tele-
attribute), 221 gram.InlineQueryResultCachedVideo at-
DataCredentials (class in telegram), 222 tribute), 190
date (telegram.Message attribute), 139 description (tele-
days (telegram.ext.Job attribute), 22 gram.InlineQueryResultDocument attribute),
de_json() (telegram.Update class method), 166 194
de_json() (telegram.User class method), 167 description (telegram.InlineQueryResultPhoto at-
de_list() (telegram.User class method), 167 tribute), 201
decode_conversations_from_json() (in description (telegram.InlineQueryResultVideo at-
module telegram.utils.helpers), 231 tribute), 204
decode_user_chat_data_from_json() (in description (telegram.Invoice attribute), 210
module telegram.utils.helpers), 231 Dice (class in telegram), 124
decrypted_credentials (tele- DICE (telegram.Dice attribute), 124
gram.PassportData attribute), 226 dice (telegram.ext.filters.Filters attribute), 13
decrypted_data (telegram.EncryptedCredentials dice (telegram.Message attribute), 142
attribute), 230 DictPersistence (class in telegram.ext), 62
decrypted_data (telegram.PassportData at- disable_notification (telegram.ext.Defaults
tribute), 226 attribute), 30
decrypted_secret (tele- disable_web_page_preview (tele-
gram.EncryptedCredentials attribute), gram.ext.Defaults attribute), 30
230 disable_web_page_preview (tele-
DEFAULT_NONE (in module telegram.utils.helpers), gram.InputTextMessageContent attribute),
230 207
default_quote (telegram.Message attribute), 143 dispatch_error() (telegram.ext.Dispatcher
Defaults (class in telegram.ext), 30 method), 9
DefaultValue (class in telegram.utils.helpers), 230 Dispatcher (class in telegram.ext), 8

Index 263
Python Telegram Bot Documentation, Release 12.8

dispatcher (telegram.ext.CallbackContext at- edited_channel_post (tele-

tribute), 29 gram.ext.filters.Filters attribute), 18
dispatcher (telegram.ext.Updater attribute), 6 edited_channel_post (telegram.Update at-
DispatcherHandlerStop (class in telegram.ext), tribute), 165
11 edited_message (telegram.ext.filters.Filters
doc (telegram.ext.filters.Filters attribute), 14 attribute), 18
Document (class in telegram), 125 edited_message (telegram.Update attribute), 164
document (telegram.ext.filters.Filters attribute), 13 edited_updates (telegram.ext.MessageHandler
document (telegram.Message attribute), 140 attribute), 44
document_file_id (tele- editMessageCaption() (telegram.Bot method),
gram.InlineQueryResultCachedDocument 74
attribute), 184 editMessageLiveLocation() (telegram.Bot
document_no (telegram.IdDocumentData attribute), method), 74
223 editMessageMedia() (telegram.Bot method), 74
document_url (tele- editMessageReplyMarkup() (telegram.Bot
gram.InlineQueryResultDocument attribute), method), 74
194 editMessageText() (telegram.Bot method), 74
docx (telegram.ext.filters.Filters attribute), 14 effective_attachment (telegram.Message at-
done (telegram.utils.promise.Promise attribute), 234 tribute), 148
download() (telegram.File method), 127 effective_chat (telegram.Update attribute), 166
download() (telegram.utils.request.Request effective_message (telegram.Update attribute),
method), 234 166
download_as_bytearray() (telegram.File effective_message_type() (in module tele-
method), 127 gram.utils.helpers), 231
driver_license (telegram.SecureData attribute), effective_user (telegram.Update attribute), 166
222 email (telegram.EncryptedPassportElement at-
duration (telegram.Animation attribute), 65 tribute), 227
duration (telegram.Audio attribute), 66 EMAIL (telegram.MessageEntity attribute), 155
duration (telegram.InputMediaAnimation attribute), email (telegram.OrderInfo attribute), 212
132 emoji (telegram.Dice attribute), 124
duration (telegram.InputMediaAudio attribute), 133 emoji (telegram.Sticker attribute), 176
duration (telegram.InputMediaVideo attribute), 136 enabled (telegram.ext.Job attribute), 22
duration (telegram.Video attribute), 171 encode_conversations_to_json() (in mod-
duration (telegram.VideoNote attribute), 172 ule telegram.utils.helpers), 232
duration (telegram.Voice attribute), 173 EncryptedCredentials (class in telegram), 229
EncryptedPassportElement (class in tele-
E gram), 227
edit_caption() (telegram.Message method), 146 END (telegram.ext.ConversationHandler attribute), 38
edit_date (telegram.Message attribute), 140 entities (telegram.Message attribute), 140
edit_media() (telegram.Message method), 147 entry_points (telegram.ext.ConversationHandler
edit_message_caption() (telegram.Bot attribute), 36
method), 74 error (telegram.ext.CallbackContext attribute), 29
edit_message_caption() (tele- error_handlers (telegram.ext.Dispatcher at-
gram.CallbackQuery method), 110 tribute), 10
edit_message_live_location() (tele- escape_markdown() (in module tele-
gram.Bot method), 75 gram.utils.helpers), 232
edit_message_media() (telegram.Bot method), exc_route (telegram.ext.DelayQueue attribute), 27
75 exception (telegram.utils.promise.Promise at-
edit_message_reply_markup() (telegram.Bot tribute), 234
method), 76 exe (telegram.ext.filters.Filters attribute), 14
edit_message_reply_markup() (tele- expiry_date (telegram.IdDocumentData attribute),
gram.CallbackQuery method), 110 223
edit_message_text() (telegram.Bot method), 76 explanation (telegram.Poll attribute), 158
edit_message_text() (telegram.CallbackQuery explanation_entities (telegram.Poll attribute),
method), 110 158
edit_reply_markup() (telegram.Message export_chat_invite_link() (telegram.Bot
method), 147 method), 77
edit_text() (telegram.Message method), 147 exportChatInviteLink() (telegram.Bot

264 Index
 Python Telegram Bot Documentation, Release 12.8

method), 77 filename (telegram.ext.PicklePersistence attribute),

EYES (telegram.MaskPosition attribute), 178 60
filename (telegram.InputFile attribute), 131
F files (telegram.EncryptedPassportElement at-
fallbacks (telegram.ext.ConversationHandler at- tribute), 227
tribute), 37 filter() (telegram.ext.filters.BaseFilter method), 20
field_name (telegram.PassportElementErrorDataFieldfilter() (telegram.ext.filters.InvertedFilter
attribute), 221 method), 20
File (class in telegram), 126 filter() (telegram.ext.filters.MergedFilter method),
file_date (telegram.PassportFile attribute), 226 21
file_hash (telegram.PassportElementErrorFile at- Filters (class in telegram.ext.filters), 11
tribute), 219 filters (telegram.ext.CommandHandler attribute),
file_hash (telegram.PassportElementErrorFiles at- 39
tribute), 220 filters (telegram.ext.MessageHandler attribute), 43
file_hash (telegram.PassportElementErrorFrontSide filters (telegram.ext.PrefixHandler attribute), 49
attribute), 220 Filters.caption_entity (class in tele-
file_hash (telegram.PassportElementErrorReverseSide gram.ext.filters), 11
attribute), 219 Filters.chat (class in telegram.ext.filters), 12
file_id (telegram.Animation attribute), 64 Filters.entity (class in telegram.ext.filters), 15
file_id (telegram.Audio attribute), 66 Filters.language (class in telegram.ext.filters),
file_id (telegram.Document attribute), 125 15
file_id (telegram.File attribute), 126 Filters.regex (class in telegram.ext.filters), 16
file_id (telegram.PassportFile attribute), 226 Filters.user (class in telegram.ext.filters), 18
file_id (telegram.PhotoSize attribute), 157 FIND_LOCATION (telegram.ChatAction attribute),
file_id (telegram.Sticker attribute), 175 116
file_id (telegram.Video attribute), 171 first_name (telegram.Bot attribute), 77
file_id (telegram.VideoNote attribute), 172 first_name (telegram.Chat attribute), 111
file_id (telegram.Voice attribute), 173 first_name (telegram.Contact attribute), 123
file_name (telegram.Animation attribute), 65 first_name (telegram.InlineQueryResultContact at-
file_name (telegram.Document attribute), 125 tribute), 192
file_path (telegram.File attribute), 127 first_name (telegram.InputContactMessageContent
file_size (telegram.Animation attribute), 65 attribute), 208
file_size (telegram.Audio attribute), 66 first_name (telegram.PersonalDetails attribute),
file_size (telegram.Document attribute), 125 224
file_size (telegram.File attribute), 127 first_name (telegram.User attribute), 166
file_size (telegram.PassportFile attribute), 226 first_name_native (telegram.PersonalDetails
file_size (telegram.PhotoSize attribute), 157 attribute), 224
file_size (telegram.Sticker attribute), 176 flush() (telegram.ext.BasePersistence method), 59
file_size (telegram.Video attribute), 171 flush() (telegram.ext.PicklePersistence method), 61
file_size (telegram.VideoNote attribute), 172 force_reply (telegram.ForceReply attribute), 128
file_size (telegram.Voice attribute), 174 ForceReply (class in telegram), 128
file_unique_id (telegram.Animation attribute), FOREHEAD (telegram.MaskPosition attribute), 178
64 forward() (telegram.Message method), 148
file_unique_id (telegram.Audio attribute), 66 forward_date (telegram.Message attribute), 140
file_unique_id (telegram.Document attribute), forward_from (telegram.Message attribute), 139
125 forward_from_chat (telegram.Message at-
file_unique_id (telegram.File attribute), 127 tribute), 139
file_unique_id (telegram.PassportFile attribute), forward_from_message_id (telegram.Message
226 attribute), 140
file_unique_id (telegram.PhotoSize attribute), forward_message() (telegram.Bot method), 77
157 forward_sender_name (telegram.Message at-
file_unique_id (telegram.Sticker attribute), 175 tribute), 142
file_unique_id (telegram.Video attribute), 171 forward_signature (telegram.Message at-
file_unique_id (telegram.VideoNote attribute), tribute), 142
172 forward_text (telegram.LoginUrl attribute), 138
file_unique_id (telegram.Voice attribute), 173 forwarded (telegram.ext.filters.Filters attribute), 15
FileCredentials (class in telegram), 223 forwardMessage() (telegram.Bot method), 77
foursquare_id (telegram.InlineQueryResultVenue

Index 265
Python Telegram Bot Documentation, Release 12.8

attribute), 202 get_bot_data() (telegram.ext.PicklePersistence

foursquare_id (tele- method), 61
gram.InputVenueMessageContent attribute), get_chat() (telegram.Bot method), 78
208 get_chat_administrators() (telegram.Bot
foursquare_id (telegram.Venue attribute), 170 method), 79
foursquare_type (tele- get_chat_data() (telegram.ext.BasePersistence
gram.InlineQueryResultVenue attribute), method), 59
202 get_chat_data() (telegram.ext.DictPersistence
foursquare_type (tele- method), 63
gram.InputVenueMessageContent attribute), get_chat_data() (telegram.ext.PicklePersistence
208 method), 61
foursquare_type (telegram.Venue attribute), 170 get_chat_member() (telegram.Bot method), 79
from_button() (telegram.InlineKeyboardMarkup get_chat_members_count() (telegram.Bot
class method), 130 method), 79
from_button() (telegram.ReplyKeyboardMarkup get_conversations() (tele-
class method), 162 gram.ext.BasePersistence method), 59
from_column() (telegram.InlineKeyboardMarkup get_conversations() (tele-
class method), 130 gram.ext.DictPersistence method), 63
from_column() (telegram.ReplyKeyboardMarkup get_conversations() (tele-
class method), 163 gram.ext.PicklePersistence method), 61
from_row() (telegram.InlineKeyboardMarkup class get_file() (telegram.Animation method), 65
method), 130 get_file() (telegram.Audio method), 67
from_row() (telegram.ReplyKeyboardMarkup class get_file() (telegram.Bot method), 79
method), 163 get_file() (telegram.Document method), 125
from_timestamp() (in module tele- get_file() (telegram.PassportFile method), 227
gram.utils.helpers), 232 get_file() (telegram.PhotoSize method), 157
from_user (telegram.CallbackQuery attribute), 109 get_file() (telegram.Sticker method), 177
from_user (telegram.ChosenInlineResult attribute), get_file() (telegram.Video method), 172
209 get_file() (telegram.VideoNote method), 173
from_user (telegram.InlineQuery attribute), 179 get_file() (telegram.Voice method), 174
from_user (telegram.Message attribute), 139 get_game_high_scores() (telegram.Bot
from_user (telegram.PreCheckoutQuery attribute), method), 80
215 get_instance() (telegram.ext.Dispatcher class
from_user (telegram.ShippingQuery attribute), 214 method), 10
front_side (telegram.EncryptedPassportElement get_jobs_by_name() (telegram.ext.JobQueue
attribute), 228 method), 23
full_name (telegram.User attribute), 167 get_me() (telegram.Bot method), 80
get_member() (telegram.Chat method), 113
G get_members_count() (telegram.Chat method),
Game (class in telegram), 216 113
game (telegram.ext.filters.Filters attribute), 15 get_my_commands() (telegram.Bot method), 81
game (telegram.Message attribute), 140 get_profile_photos() (telegram.User method),
game_short_name (telegram.CallbackQuery 167
attribute), 109 get_signal_name() (in module tele-
game_short_name (tele- gram.utils.helpers), 232
gram.InlineQueryResultGame attribute), get_small_file() (telegram.ChatPhoto method),
195 122
GameHighScore (class in telegram), 218 get_sticker_set() (telegram.Bot method), 81
gender (telegram.PersonalDetails attribute), 224 get_updates() (telegram.Bot method), 81
get() (telegram.utils.request.Request method), 235 get_user_data() (telegram.ext.BasePersistence
get_administrators() (telegram.Chat method), method), 60
113 get_user_data() (telegram.ext.DictPersistence
get_big_file() (telegram.ChatPhoto method), method), 63
122 get_user_data() (telegram.ext.PicklePersistence
get_bot_data() (telegram.ext.BasePersistence method), 61
method), 59 get_user_profile_photos() (telegram.Bot
get_bot_data() (telegram.ext.DictPersistence method), 82
method), 63 get_webhook_info() (telegram.Bot method), 82

266 Index
 Python Telegram Bot Documentation, Release 12.8

getChat() (telegram.Bot method), 78 HTML (telegram.ParseMode attribute), 156

getChatAdministrators() (telegram.Bot
method), 78 I
getChatMember() (telegram.Bot method), 78 id (telegram.Bot attribute), 82
getChatMembersCount() (telegram.Bot method), id (telegram.CallbackQuery attribute), 109
78 id (telegram.Chat attribute), 111
getFile() (telegram.Bot method), 78 id (telegram.InlineQuery attribute), 179
getGameHighScores() (telegram.Bot method), 78 id (telegram.InlineQueryResult attribute), 180
getMe() (telegram.Bot method), 78 id (telegram.InlineQueryResultArticle attribute), 180
getMyCommands() (telegram.Bot method), 78 id (telegram.InlineQueryResultAudio attribute), 182
getStickerSet() (telegram.Bot method), 78 id (telegram.InlineQueryResultCachedAudio at-
getUpdates() (telegram.Bot method), 78 tribute), 183
getUserProfilePhotos() (telegram.Bot
id (telegram.InlineQueryResultCachedDocument at-
method), 78 tribute), 184
getWebhookInfo() (telegram.Bot method), 78 id (telegram.InlineQueryResultCachedGif attribute),
gif (telegram.ext.filters.Filters attribute), 15 185
gif_duration (telegram.InlineQueryResultGif at- id (telegram.InlineQueryResultCachedMpeg4Gif at-
tribute), 196 tribute), 186
gif_file_id (tele-
id (telegram.InlineQueryResultCachedPhoto at-
gram.InlineQueryResultCachedGif at- tribute), 188
tribute), 185 id (telegram.InlineQueryResultCachedSticker at-
gif_height (telegram.InlineQueryResultGif at- tribute), 189
tribute), 196 id (telegram.InlineQueryResultCachedVideo at-
gif_url (telegram.InlineQueryResultGif attribute), tribute), 190
196 id (telegram.InlineQueryResultCachedVoice at-
gif_width (telegram.InlineQueryResultGif at- tribute), 191
tribute), 196 id (telegram.InlineQueryResultContact attribute), 192
GROUP (telegram.Chat attribute), 113 id (telegram.InlineQueryResultDocument attribute),
group (telegram.ext.filters.Filters attribute), 15 193
group_chat_created (telegram.Message at- id (telegram.InlineQueryResultGame attribute), 195
tribute), 141 id (telegram.InlineQueryResultGif attribute), 196
groups (telegram.ext.Dispatcher attribute), 10 id (telegram.InlineQueryResultLocation attribute),
197
H id (telegram.InlineQueryResultMpeg4Gif attribute),
handle_update() (tele- 199
gram.ext.ConversationHandler method), id (telegram.InlineQueryResultPhoto attribute), 200
38 id (telegram.InlineQueryResultVenue attribute), 202
handle_update() (telegram.ext.Handler method), id (telegram.InlineQueryResultVideo attribute), 203
32 id (telegram.InlineQueryResultVoice attribute), 205
Handler (class in telegram.ext), 31 id (telegram.Poll attribute), 158
handlers (telegram.ext.Dispatcher attribute), 10 id (telegram.PreCheckoutQuery attribute), 215
has_custom_certificate (tele- id (telegram.ShippingOption attribute), 212
gram.WebhookInfo attribute), 174 id (telegram.ShippingQuery attribute), 214
hash (telegram.DataCredentials attribute), 222 id (telegram.User attribute), 166
hash (telegram.EncryptedCredentials attribute), 229 IdDocumentData (class in telegram), 223
hash (telegram.EncryptedPassportElement attribute), identity_card (telegram.SecureData attribute),
228 222
hash (telegram.FileCredentials attribute), 223 idle() (telegram.ext.Updater method), 7
HASHTAG (telegram.MessageEntity attribute), 155 image (telegram.ext.filters.Filters attribute), 14
height (telegram.Animation attribute), 64 inline_keyboard (tele-
height (telegram.InputMediaAnimation attribute), gram.InlineKeyboardMarkup attribute),
132 130
height (telegram.InputMediaVideo attribute), 136 inline_message_id (telegram.CallbackQuery at-
height (telegram.PhotoSize attribute), 157 tribute), 109
height (telegram.Sticker attribute), 176 inline_message_id (tele-
height (telegram.Video attribute), 171 gram.ChosenInlineResult attribute), 209
hide_url (telegram.InlineQueryResultArticle at- inline_query (telegram.Update attribute), 165
tribute), 181 InlineKeyboardButton (class in telegram), 128

Index 267
Python Telegram Bot Documentation, Release 12.8

InlineKeyboardMarkup (class in telegram), 130 tribute), 186

InlineQuery (class in telegram), 179 input_message_content (tele-
InlineQueryHandler (class in telegram.ext), 41 gram.InlineQueryResultCachedMpeg4Gif
InlineQueryResult (class in telegram), 180 attribute), 187
InlineQueryResultArticle (class in tele- input_message_content (tele-
gram), 180 gram.InlineQueryResultCachedPhoto at-
InlineQueryResultAudio (class in telegram), tribute), 188
182 input_message_content (tele-
InlineQueryResultCachedAudio (class in gram.InlineQueryResultCachedSticker
telegram), 183 attribute), 189
InlineQueryResultCachedDocument (class in input_message_content (tele-
telegram), 184 gram.InlineQueryResultCachedVideo at-
InlineQueryResultCachedGif (class in tele- tribute), 190
gram), 185 input_message_content (tele-
InlineQueryResultCachedMpeg4Gif (class in gram.InlineQueryResultCachedVoice at-
telegram), 186 tribute), 191
InlineQueryResultCachedPhoto (class in input_message_content (tele-
telegram), 187 gram.InlineQueryResultContact attribute),
InlineQueryResultCachedSticker (class in 192
telegram), 189 input_message_content (tele-
InlineQueryResultCachedVideo (class in gram.InlineQueryResultDocument attribute),
telegram), 189 194
InlineQueryResultCachedVoice (class in input_message_content (tele-
telegram), 191 gram.InlineQueryResultGif attribute),
InlineQueryResultContact (class in tele- 196
gram), 192 input_message_content (tele-
InlineQueryResultDocument (class in tele- gram.InlineQueryResultLocation attribute),
gram), 193 198
InlineQueryResultGame (class in telegram), 195 input_message_content (tele-
InlineQueryResultGif (class in telegram), 195 gram.InlineQueryResultMpeg4Gif attribute),
InlineQueryResultLocation (class in tele- 199
gram), 197 input_message_content (tele-
InlineQueryResultMpeg4Gif (class in tele- gram.InlineQueryResultPhoto attribute),
gram), 198 201
InlineQueryResultPhoto (class in telegram), input_message_content (tele-
200 gram.InlineQueryResultVenue attribute),
InlineQueryResultVenue (class in telegram), 202
202 input_message_content (tele-
InlineQueryResultVideo (class in telegram), gram.InlineQueryResultVideo attribute),
203 204
InlineQueryResultVoice (class in telegram), input_message_content (tele-
205 gram.InlineQueryResultVoice attribute),
input_file_content (telegram.InputFile at- 206
tribute), 130 InputContactMessageContent (class in tele-
input_message_content (tele- gram), 208
gram.InlineQueryResultArticle attribute), InputFile (class in telegram), 130
181 InputLocationMessageContent (class in tele-
input_message_content (tele- gram), 207
gram.InlineQueryResultAudio attribute), InputMedia (class in telegram), 131
182 InputMediaAnimation (class in telegram), 131
input_message_content (tele- InputMediaAudio (class in telegram), 132
gram.InlineQueryResultCachedAudio at- InputMediaDocument (class in telegram), 134
tribute), 183 InputMediaPhoto (class in telegram), 134
input_message_content (tele- InputMediaVideo (class in telegram), 135
gram.InlineQueryResultCachedDocument InputMessageContent (class in telegram), 206
attribute), 185 InputTextMessageContent (class in telegram),
input_message_content (tele- 206
gram.InlineQueryResultCachedGif at- InputVenueMessageContent (class in tele-

268 Index
 Python Telegram Bot Documentation, Release 12.8

gram), 207 last_error_message (telegram.WebhookInfo at-

internal_passport (telegram.SecureData at- tribute), 175
tribute), 222 last_name (telegram.Bot attribute), 83
interval (telegram.ext.Job attribute), 22 last_name (telegram.Chat attribute), 111
interval_seconds (telegram.ext.Job attribute), 22 last_name (telegram.Contact attribute), 123
InvalidToken, 126 last_name (telegram.InlineQueryResultContact at-
InvertedFilter (class in telegram.ext.filters), 20 tribute), 192
invite_link (telegram.Chat attribute), 111 last_name (telegram.InputContactMessageContent
Invoice (class in telegram), 210 attribute), 208
invoice (telegram.ext.filters.Filters attribute), 15last_name (telegram.PersonalDetails attribute), 224
invoice (telegram.Message attribute), 142 last_name (telegram.User attribute), 166
invoice_payload (telegram.PreCheckoutQuery last_name_native (telegram.PersonalDetails at-
attribute), 215 tribute), 224
invoice_payload (telegram.ShippingQuerylatitude (telegram.InlineQueryResultLocation at-
attribute), 214 tribute), 197
invoice_payload (telegram.SuccessfulPayment latitude (telegram.InlineQueryResultVenue at-
attribute), 213 tribute), 202
is_animated (telegram.Sticker attribute), 176 latitude (telegram.InputLocationMessageContent
is_animated (telegram.StickerSet attribute), 177 attribute), 207
is_anonymous (telegram.Poll attribute), 158 latitude (telegram.InputVenueMessageContent at-
is_bot (telegram.User attribute), 166 tribute), 207
is_closed (telegram.Poll attribute), 158 latitude (telegram.Location attribute), 138
is_image() (telegram.InputFile static method), 131 leave() (telegram.Chat method), 113
is_member (telegram.ChatMember attribute), 118 leave_chat() (telegram.Bot method), 83
ITALIC (telegram.MessageEntity attribute), 156 leaveChat() (telegram.Bot method), 83
LEFT (telegram.ChatMember attribute), 119
J left_chat_member (telegram.ext.filters.Filters at-
Job (class in telegram.ext), 21 tribute), 17
job (telegram.ext.CallbackContext attribute), 29 left_chat_member (telegram.Message attribute),
job_queue (telegram.ext.CallbackContext attribute), 141
29 length (telegram.MessageEntity attribute), 155
job_queue (telegram.ext.Dispatcher attribute), 8 length (telegram.VideoNote attribute), 172
job_queue (telegram.ext.Job attribute), 22 link (telegram.Bot attribute), 83
job_queue (telegram.ext.Updater attribute), 5 link (telegram.Chat attribute), 114
JobQueue (class in telegram.ext), 23 link (telegram.Message attribute), 148
jobs() (telegram.ext.JobQueue method), 23 link (telegram.User attribute), 168
jpg (telegram.ext.filters.Filters attribute), 15 live_period (telegram.InlineQueryResultLocation
attribute), 197
K Location (class in telegram), 138
keyboard (telegram.ReplyKeyboardMarkup at- location (telegram.ChosenInlineResult attribute),
tribute), 161 209
KeyboardButton (class in telegram), 136 location (telegram.ext.filters.Filters attribute), 16
KeyboardButtonPollType (class in telegram), location (telegram.InlineQuery attribute), 179
137 location (telegram.Message attribute), 141
kick_chat_member() (telegram.Bot method), 82 location (telegram.Venue attribute), 170
kick_member() (telegram.Chat method), 113 login_url (telegram.InlineKeyboardButton at-
kickChatMember() (telegram.Bot method), 82 tribute), 128
KICKED (telegram.ChatMember attribute), 119 LoginUrl (class in telegram), 138
kwargs (telegram.utils.promise.Promise attribute), longitude (telegram.InlineQueryResultLocation at-
234 tribute), 197
longitude (telegram.InlineQueryResultVenue
L attribute), 202
longitude (telegram.InputLocationMessageContent
label (telegram.LabeledPrice attribute), 210
attribute), 207
LabeledPrice (class in telegram), 210
longitude (telegram.InputVenueMessageContent at-
language (telegram.MessageEntity attribute), 155
tribute), 208
language_code (telegram.User attribute), 167
longitude (telegram.Location attribute), 138
last_error_date (telegram.WebhookInfo at-
tribute), 175

Index 269
Python Telegram Bot Documentation, Release 12.8

M message (telegram.PassportElementErrorFiles
map_to_parent (telegram.ext.ConversationHandler attribute), 220
attribute), 37 message (telegram.PassportElementErrorFrontSide
MARKDOWN (telegram.ParseMode attribute), 156 attribute), 220
MARKDOWN_V2 (telegram.ParseMode attribute), 156 message (telegram.PassportElementErrorReverseSide
mask_position (telegram.Sticker attribute), 176 attribute), 219
MaskPosition (class in telegram), 178 message (telegram.Update attribute), 164
match (telegram.ext.CallbackContext attribute), 30 message_id (telegram.Message attribute), 139
matches (telegram.ext.CallbackContext attribute), 29 message_text (telegram.InputTextMessageContent
MAX_CAPTION_LENGTH (in module tele- attribute), 206
gram.constants), 122 message_updates (telegram.ext.MessageHandler
max_connections (telegram.WebhookInfo at- attribute), 44
tribute), 175 MessageEntity (class in telegram), 154
MAX_FILESIZE_DOWNLOAD (in module tele- MessageHandler (class in telegram.ext), 43
gram.constants), 122 MessageQueue (class in telegram.ext), 26
MAX_FILESIZE_UPLOAD (in module tele- messages (telegram.ext.filters.Filters attribute), 18
gram.constants), 123 middle_name (telegram.PersonalDetails attribute),
MAX_INLINE_QUERY_RESULTS (in module tele- 224
gram.constants), 123 middle_name_native (telegram.PersonalDetails
MAX_MESSAGE_ENTITIES (in module tele- attribute), 224
gram.constants), 123 migrate (telegram.ext.filters.Filters attribute), 17
MAX_MESSAGE_LENGTH (in module tele- migrate_from_chat_id (telegram.Message at-
gram.constants), 122 tribute), 142
MAX_MESSAGES_PER_MINUTE_PER_GROUP (in migrate_to_chat_id (telegram.Message at-
module telegram.constants), 123 tribute), 142
MAX_MESSAGES_PER_SECOND (in module tele- mime_type (telegram.Animation attribute), 65
gram.constants), 123 mime_type (telegram.Audio attribute), 66
MAX_MESSAGES_PER_SECOND_PER_CHAT (in mime_type (telegram.Document attribute), 125
module telegram.constants), 123 mime_type (telegram.ext.filters.Filters attribute), 14
MAX_PHOTOSIZE_UPLOAD (in module tele- mime_type (telegram.InlineQueryResultDocument
gram.constants), 123 attribute), 194
media (telegram.InputMediaAnimation attribute), 131 mime_type (telegram.InlineQueryResultVideo
media (telegram.InputMediaAudio attribute), 133 attribute), 204
media (telegram.InputMediaDocument attribute), 134 mime_type (telegram.Video attribute), 171
media (telegram.InputMediaPhoto attribute), 135 mime_type (telegram.Voice attribute), 173
media (telegram.InputMediaVideo attribute), 135 MOUTH (telegram.MaskPosition attribute), 178
media_group_id (telegram.Message attribute), 140 mp3 (telegram.ext.filters.Filters attribute), 15
MEMBER (telegram.ChatMember attribute), 119 mpeg4_duration (tele-
MENTION (telegram.MessageEntity attribute), 156 gram.InlineQueryResultMpeg4Gif attribute),
mention_html() (in module tele- 199
gram.utils.helpers), 232 mpeg4_file_id (tele-
mention_html() (telegram.User method), 168 gram.InlineQueryResultCachedMpeg4Gif
mention_markdown() (in module tele- attribute), 187
gram.utils.helpers), 232 mpeg4_height (tele-
mention_markdown() (telegram.User method), gram.InlineQueryResultMpeg4Gif attribute),
168 199
mention_markdown_v2() (telegram.User mpeg4_url (telegram.InlineQueryResultMpeg4Gif
method), 168 attribute), 199
MergedFilter (class in telegram.ext.filters), 21 mpeg4_width (tele-
Message (class in telegram), 139 gram.InlineQueryResultMpeg4Gif attribute),
message (telegram.CallbackQuery attribute), 109 199
message (telegram.ext.filters.Filters attribute), 18
message (telegram.PassportElementError attribute),
N
218 name (telegram.Bot attribute), 83
message (telegram.PassportElementErrorDataField name (telegram.ext.ConversationHandler attribute), 37
attribute), 221 name (telegram.ext.DelayQueue attribute), 27
message (telegram.PassportElementErrorFile at- name (telegram.ext.filters.BaseFilter attribute), 20
tribute), 219 name (telegram.ext.Job attribute), 21

270 Index
 Python Telegram Bot Documentation, Release 12.8

name (telegram.OrderInfo attribute), 212 parse_mode (telegram.InlineQueryResultCachedPhoto

name (telegram.StickerSet attribute), 177 attribute), 188
name (telegram.User attribute), 168 parse_mode (telegram.InlineQueryResultCachedVideo
NetworkError, 126 attribute), 190
new_chat_members (telegram.ext.filters.Filters at- parse_mode (telegram.InlineQueryResultCachedVoice
tribute), 17 attribute), 191
new_chat_members (telegram.Message attribute), parse_mode (telegram.InlineQueryResultDocument
141 attribute), 194
new_chat_photo (telegram.ext.filters.Filters
parse_mode (telegram.InlineQueryResultGif at-
attribute), 17 tribute), 196
new_chat_photo (telegram.Message attribute), 141 parse_mode (telegram.InlineQueryResultMpeg4Gif
new_chat_title (telegram.ext.filters.Filters attribute), 199
attribute), 17 parse_mode (telegram.InlineQueryResultPhoto at-
new_chat_title (telegram.Message attribute), 141 tribute), 201
next_t (telegram.ext.Job attribute), 22 parse_mode (telegram.InlineQueryResultVideo at-
nonce (telegram.Credentials attribute), 221 tribute), 204
parse_mode (telegram.InlineQueryResultVoice at-
O tribute), 205
offset (telegram.InlineQuery attribute), 179 parse_mode (telegram.InputMediaAnimation at-
offset (telegram.MessageEntity attribute), 154 tribute), 132
on_flush (telegram.ext.PicklePersistence attribute), parse_mode (telegram.InputMediaAudio attribute),
61 133
one_time_keyboard (tele- parse_mode (telegram.InputMediaDocument at-
gram.ReplyKeyboardMarkup attribute), tribute), 134
162 parse_mode (telegram.InputMediaPhoto attribute),
open_period (telegram.Poll attribute), 158 135
option_ids (telegram.PollAnswer attribute), 160 parse_mode (telegram.InputMediaVideo attribute),
options (telegram.Poll attribute), 158 135
order_info (telegram.PreCheckoutQuery attribute), parse_mode (telegram.InputTextMessageContent at-
215 tribute), 207
order_info (telegram.SuccessfulPayment attribute), parse_text_entities() (telegram.Game
213 method), 217
OrderInfo (class in telegram), 212 parse_text_entity() (telegram.Game method),
217
P ParseMode (class in telegram), 156
parse_caption_entities() (tele- pass_args (telegram.ext.CommandHandler at-
gram.Message method), 148 tribute), 39
parse_caption_entity() (telegram.Message pass_args (telegram.ext.PrefixHandler attribute),
method), 148 50
parse_entities() (telegram.Message method), pass_args (telegram.ext.StringCommandHandler
149 attribute), 54
parse_entity() (telegram.Message method), 149 pass_chat_data (tele-
parse_explanation_entities() (tele- gram.ext.CallbackQueryHandler attribute),
gram.Poll method), 159 33
parse_explanation_entity() (telegram.Poll pass_chat_data (tele-
method), 160 gram.ext.ChosenInlineResultHandler at-
parse_mode (telegram.ext.Defaults attribute), 30 tribute), 35
parse_mode (telegram.InlineQueryResultAudio at- pass_chat_data (telegram.ext.CommandHandler
tribute), 182 attribute), 39
parse_mode (telegram.InlineQueryResultCachedAudio pass_chat_data (telegram.ext.Handler attribute),
attribute), 183 31
parse_mode (telegram.InlineQueryResultCachedDocument pass_chat_data (tele-
attribute), 184 gram.ext.InlineQueryHandler attribute),
parse_mode (telegram.InlineQueryResultCachedGif 42
attribute), 186 pass_chat_data (telegram.ext.MessageHandler
parse_mode (telegram.InlineQueryResultCachedMpeg4Gif attribute), 44
attribute), 187 pass_chat_data (telegram.ext.PollAnswerHandler
attribute), 45

Index 271
Python Telegram Bot Documentation, Release 12.8

pass_chat_data (telegram.ext.PollHandler at- gram.ext.ShippingQueryHandler attribute),

tribute), 47 53
pass_chat_data (tele- pass_job_queue (tele-
gram.ext.PreCheckoutQueryHandler at- gram.ext.StringCommandHandler attribute),
tribute), 48 55
pass_chat_data (telegram.ext.PrefixHandler at- pass_job_queue (tele-
tribute), 50 gram.ext.StringRegexHandler attribute),
pass_chat_data (telegram.ext.RegexHandler at- 56
tribute), 52 pass_job_queue (telegram.ext.TypeHandler
pass_chat_data (tele- attribute), 58
gram.ext.ShippingQueryHandler attribute), pass_update_queue (tele-
53 gram.ext.CallbackQueryHandler attribute),
pass_groupdict (tele- 33
gram.ext.CallbackQueryHandler attribute), pass_update_queue (tele-
33 gram.ext.ChosenInlineResultHandler at-
pass_groupdict (tele- tribute), 35
gram.ext.InlineQueryHandler attribute), pass_update_queue (tele-
42 gram.ext.CommandHandler attribute),
pass_groupdict (telegram.ext.RegexHandler at- 39
tribute), 52 pass_update_queue (telegram.ext.Handler
pass_groupdict (tele- attribute), 31
gram.ext.StringRegexHandler attribute), pass_update_queue (tele-
56 gram.ext.InlineQueryHandler attribute),
pass_groups (telegram.ext.CallbackQueryHandler 41
attribute), 33 pass_update_queue (tele-
pass_groups (telegram.ext.InlineQueryHandler at- gram.ext.MessageHandler attribute), 43
tribute), 41 pass_update_queue (tele-
pass_groups (telegram.ext.RegexHandler at- gram.ext.PollAnswerHandler attribute),
tribute), 51 45
pass_groups (telegram.ext.StringRegexHandler at- pass_update_queue (telegram.ext.PollHandler at-
tribute), 56 tribute), 46
pass_job_queue (tele- pass_update_queue (tele-
gram.ext.CallbackQueryHandler attribute), gram.ext.PreCheckoutQueryHandler at-
33 tribute), 48
pass_job_queue (tele- pass_update_queue (telegram.ext.PrefixHandler
gram.ext.ChosenInlineResultHandler at- attribute), 50
tribute), 35 pass_update_queue (telegram.ext.RegexHandler
pass_job_queue (telegram.ext.CommandHandler attribute), 52
attribute), 39 pass_update_queue (tele-
pass_job_queue (telegram.ext.Handler attribute), gram.ext.ShippingQueryHandler attribute),
31 53
pass_job_queue (tele- pass_update_queue (tele-
gram.ext.InlineQueryHandler attribute), gram.ext.StringCommandHandler attribute),
41 54
pass_job_queue (telegram.ext.MessageHandler pass_update_queue (tele-
attribute), 43 gram.ext.StringRegexHandler attribute),
pass_job_queue (telegram.ext.PollAnswerHandler 56
attribute), 45 pass_update_queue (telegram.ext.TypeHandler
pass_job_queue (telegram.ext.PollHandler at- attribute), 58
tribute), 47 pass_user_data (tele-
pass_job_queue (tele- gram.ext.CallbackQueryHandler attribute),
gram.ext.PreCheckoutQueryHandler at- 33
tribute), 48 pass_user_data (tele-
pass_job_queue (telegram.ext.PrefixHandler at- gram.ext.ChosenInlineResultHandler at-
tribute), 50 tribute), 35
pass_job_queue (telegram.ext.RegexHandler at- pass_user_data (telegram.ext.CommandHandler
tribute), 52 attribute), 39
pass_job_queue (tele- pass_user_data (telegram.ext.Handler attribute),

272 Index
 Python Telegram Bot Documentation, Release 12.8

31 attribute), 182
pass_user_data (tele- performer (telegram.InputMediaAudio attribute),
gram.ext.InlineQueryHandler attribute), 133
42 permissions (telegram.Chat attribute), 112
pass_user_data (telegram.ext.MessageHandler persistence (telegram.ext.Dispatcher attribute), 8
attribute), 43 persistence (telegram.ext.Updater attribute), 6
pass_user_data (telegram.ext.PollAnswerHandler persistent (telegram.ext.ConversationHandler at-
attribute), 45 tribute), 37
pass_user_data (telegram.ext.PollHandler at- personal_details (telegram.SecureData at-
tribute), 47 tribute), 222
pass_user_data (tele- PersonalDetails (class in telegram), 224
gram.ext.PreCheckoutQueryHandler at- phone_number (telegram.Contact attribute), 123
tribute), 48 phone_number (tele-
pass_user_data (telegram.ext.PrefixHandler at- gram.EncryptedPassportElement attribute),
tribute), 50 227
pass_user_data (telegram.ext.RegexHandler at- phone_number (telegram.InlineQueryResultContact
tribute), 52 attribute), 192
pass_user_data (tele- phone_number (tele-
gram.ext.ShippingQueryHandler attribute), gram.InputContactMessageContent at-
53 tribute), 208
passport (telegram.SecureData attribute), 222 PHONE_NUMBER (telegram.MessageEntity attribute),
passport_data (telegram.ext.filters.Filters at- 156
tribute), 16 phone_number (telegram.OrderInfo attribute), 212
passport_data (telegram.Message attribute), 142 photo (telegram.Chat attribute), 111
passport_registration (telegram.SecureData photo (telegram.ext.filters.Filters attribute), 16
attribute), 223 photo (telegram.Game attribute), 216
PassportData (class in telegram), 225 photo (telegram.Message attribute), 140
PassportElementError (class in telegram), 218 photo_file_id (tele-
PassportElementErrorDataField (class in gram.InlineQueryResultCachedPhoto at-
telegram), 221 tribute), 188
PassportElementErrorFile (class in tele- photo_height (telegram.InlineQueryResultPhoto
gram), 219 attribute), 200
PassportElementErrorFiles (class in tele- photo_url (telegram.InlineQueryResultPhoto
gram), 220 attribute), 200
PassportElementErrorFrontSide (class in photo_width (telegram.InlineQueryResultPhoto at-
telegram), 220 tribute), 200
PassportElementErrorReverseSide (class in photos (telegram.UserProfilePhotos attribute), 170
telegram), 219 PhotoSize (class in telegram), 157
PassportFile (class in telegram), 226 PicklePersistence (class in telegram.ext), 60
pattern (telegram.ext.CallbackQueryHandler pin_chat_message() (telegram.Bot method), 83
attribute), 33 pinChatMessage() (telegram.Bot method), 83
pattern (telegram.ext.InlineQueryHandler at- pinned_message (telegram.Chat attribute), 112
tribute), 41 pinned_message (telegram.ext.filters.Filters
pattern (telegram.ext.RegexHandler attribute), 51 attribute), 17
pattern (telegram.ext.StringRegexHandler at- pinned_message (telegram.Message attribute), 142
tribute), 56 point (telegram.MaskPosition attribute), 178
pay (telegram.InlineKeyboardButton attribute), 129 Poll (class in telegram), 158
pdf (telegram.ext.filters.Filters attribute), 15 poll (telegram.ext.filters.Filters attribute), 16
pending_update_count (telegram.WebhookInfo poll (telegram.Message attribute), 142
attribute), 174 poll (telegram.Update attribute), 165
per_chat (telegram.ext.ConversationHandler at- poll_answer (telegram.Update attribute), 165
tribute), 37 poll_id (telegram.PollAnswer attribute), 160
per_message (telegram.ext.ConversationHandler PollAnswer (class in telegram), 160
attribute), 37 PollAnswerHandler (class in telegram.ext), 45
per_user (telegram.ext.ConversationHandler at- PollHandler (class in telegram.ext), 46
tribute), 37 PollOption (class in telegram), 160
performer (telegram.Audio attribute), 66 pooled_function (telegram.utils.promise.Promise
performer (telegram.InlineQueryResultAudio attribute), 233

Index 273
Python Telegram Bot Documentation, Release 12.8

position (telegram.GameHighScore attribute), 218 rental_agreement (telegram.SecureData at-

post() (telegram.utils.request.Request method), 235 tribute), 223
post_code (telegram.ResidentialAddress attribute), repeat (telegram.ext.Job attribute), 22
225 reply (telegram.ext.filters.Filters attribute), 16
post_code (telegram.ShippingAddress attribute), reply_animation() (telegram.Message method),
211 149
PRE (telegram.MessageEntity attribute), 156 reply_audio() (telegram.Message method), 149
pre_checkout_query (telegram.Update at- reply_contact() (telegram.Message method),
tribute), 165 150
PreCheckoutQuery (class in telegram), 215 reply_dice() (telegram.Message method), 150
PreCheckoutQueryHandler (class in tele- reply_document() (telegram.Message method),
gram.ext), 48 150
prefix (telegram.ext.PrefixHandler attribute), 49 reply_html() (telegram.Message method), 150
PrefixHandler (class in telegram.ext), 49 reply_location() (telegram.Message method),
prices (telegram.ShippingOption attribute), 212 150
PRIVATE (telegram.Chat attribute), 113 reply_markdown() (telegram.Message method),
private (telegram.ext.filters.Filters attribute), 16 151
process_update() (telegram.ext.Dispatcher reply_markdown_v2() (telegram.Message
method), 10 method), 151
Promise (class in telegram.utils.promise), 233 reply_markup (telegram.InlineQueryResultArticle
promote_chat_member() (telegram.Bot method), attribute), 181
84 reply_markup (telegram.InlineQueryResultAudio
promoteChatMember() (telegram.Bot method), 84 attribute), 182
provider_payment_charge_id (tele- reply_markup (tele-
gram.SuccessfulPayment attribute), 213 gram.InlineQueryResultCachedAudio at-
py (telegram.ext.filters.Filters attribute), 15 tribute), 183
reply_markup (tele-
Q gram.InlineQueryResultCachedDocument
query (telegram.ChosenInlineResult attribute), 209 attribute), 185
query (telegram.InlineQuery attribute), 179 reply_markup (tele-
question (telegram.Poll attribute), 158 gram.InlineQueryResultCachedGif at-
QUIZ (telegram.Poll attribute), 159 tribute), 186
quote (telegram.ext.Defaults attribute), 30 reply_markup (tele-
gram.InlineQueryResultCachedMpeg4Gif
R attribute), 187
RECORD_AUDIO (telegram.ChatAction attribute), 116 reply_markup (tele-
RECORD_VIDEO (telegram.ChatAction attribute), 116 gram.InlineQueryResultCachedPhoto at-
RECORD_VIDEO_NOTE (telegram.ChatAction at- tribute), 188
tribute), 116 reply_markup (tele-
RegexHandler (class in telegram.ext), 51 gram.InlineQueryResultCachedSticker
REGULAR (telegram.Poll attribute), 159 attribute), 189
remove_chat_ids() (tele- reply_markup (tele-
gram.ext.filters.Filters.chat method), 12 gram.InlineQueryResultCachedVideo at-
remove_error_handler() (tele- tribute), 190
gram.ext.Dispatcher method), 10 reply_markup (tele-
remove_handler() (telegram.ext.Dispatcher gram.InlineQueryResultCachedVoice at-
method), 10 tribute), 191
remove_keyboard (tele- reply_markup (telegram.InlineQueryResultContact
gram.ReplyKeyboardRemove attribute), attribute), 192
161 reply_markup (tele-
remove_user_ids() (tele- gram.InlineQueryResultDocument attribute),
gram.ext.filters.Filters.user method), 19 194
remove_usernames() (tele- reply_markup (telegram.InlineQueryResultGame
gram.ext.filters.Filters.chat method), 13 attribute), 195
remove_usernames() (tele- reply_markup (telegram.InlineQueryResultGif at-
gram.ext.filters.Filters.user method), 19 tribute), 196
removed (telegram.ext.Job attribute), 22 reply_markup (tele-
gram.InlineQueryResultLocation attribute),

274 Index
 Python Telegram Bot Documentation, Release 12.8

197 gram.EncryptedPassportElement attribute),

reply_markup (tele- 228
gram.InlineQueryResultMpeg4Gif attribute), run() (telegram.ext.DelayQueue method), 28
199 run() (telegram.ext.Job method), 22
reply_markup (telegram.InlineQueryResultPhoto run() (telegram.utils.promise.Promise method), 234
attribute), 201 run_async() (telegram.ext.Dispatcher method), 10
reply_markup (telegram.InlineQueryResultVenue run_daily() (telegram.ext.JobQueue method), 23
attribute), 202 run_monthly() (telegram.ext.JobQueue method),
reply_markup (telegram.InlineQueryResultVideo 23
attribute), 204 run_once() (telegram.ext.JobQueue method), 24
reply_markup (telegram.InlineQueryResultVoice run_repeating() (telegram.ext.JobQueue
attribute), 206 method), 25
reply_markup (telegram.Message attribute), 142 running (telegram.ext.Dispatcher attribute), 10
reply_media_group() (telegram.Message running (telegram.ext.Updater attribute), 6
method), 151
reply_photo() (telegram.Message method), 151 S
reply_poll() (telegram.Message method), 152 scale (telegram.MaskPosition attribute), 178
reply_sticker() (telegram.Message method), schedule_removal() (telegram.ext.Job method),
152 23
reply_text() (telegram.Message method), 152 score (telegram.GameHighScore attribute), 218
reply_to_message (telegram.Message attribute), secret (telegram.DataCredentials attribute), 222
140 secret (telegram.EncryptedCredentials attribute),
reply_venue() (telegram.Message method), 152 229
reply_video() (telegram.Message method), 152 secret (telegram.FileCredentials attribute), 223
reply_video_note() (telegram.Message secure_data (telegram.Credentials attribute), 221
method), 153 SecureData (class in telegram), 222
reply_voice() (telegram.Message method), 153 selective (telegram.ForceReply attribute), 128
ReplyKeyboardMarkup (class in telegram), 161 selective (telegram.ReplyKeyboardMarkup at-
ReplyKeyboardRemove (class in telegram), 161 tribute), 162
ReplyMarkup (class in telegram), 164 selective (telegram.ReplyKeyboardRemove at-
Request (class in telegram.utils.request), 234 tribute), 161
request_contact (telegram.KeyboardButton at- selfie (telegram.EncryptedPassportElement at-
tribute), 137 tribute), 228
request_location (telegram.KeyboardButton at- send_action() (telegram.Chat method), 114
tribute), 137 send_animation() (telegram.Bot method), 87
request_poll (telegram.KeyboardButton at- send_animation() (telegram.Chat method), 114
tribute), 137 send_animation() (telegram.User method), 168
request_write_access (telegram.LoginUrl at- send_audio() (telegram.Bot method), 87
tribute), 138 send_audio() (telegram.Chat method), 114
residence_country_code (tele- send_audio() (telegram.User method), 168
gram.PersonalDetails attribute), 224 send_chat_action() (telegram.Bot method), 88
ResidentialAddress (class in telegram), 224 send_contact() (telegram.Bot method), 89
resize_keyboard (tele- send_dice() (telegram.Bot method), 89
gram.ReplyKeyboardMarkup attribute), send_document() (telegram.Bot method), 90
161 send_document() (telegram.Chat method), 114
restrict_chat_member() (telegram.Bot send_document() (telegram.User method), 168
method), 85 send_game() (telegram.Bot method), 91
restrictChatMember() (telegram.Bot method), send_invoice() (telegram.Bot method), 91
85 send_location() (telegram.Bot method), 93
RESTRICTED (telegram.ChatMember attribute), 119 send_media_group() (telegram.Bot method), 93
result() (telegram.utils.promise.Promise method), send_message() (telegram.Bot method), 94
234 send_message() (telegram.Chat method), 114
result_id (telegram.ChosenInlineResult attribute), send_message() (telegram.User method), 168
209 send_photo() (telegram.Bot method), 94
retrieve() (telegram.utils.request.Request send_photo() (telegram.Chat method), 114
method), 235 send_photo() (telegram.User method), 169
RetryAfter, 126 send_poll() (telegram.Bot method), 95
reverse_side (tele- send_poll() (telegram.Chat method), 115

Index 275
Python Telegram Bot Documentation, Release 12.8

send_poll() (telegram.User method), 169 setChatAdministratorCustomTitle() (tele-

send_sticker() (telegram.Bot method), 96 gram.Bot method), 100
send_sticker() (telegram.Chat method), 115 setChatDescription() (telegram.Bot method),
send_sticker() (telegram.User method), 169 100
send_venue() (telegram.Bot method), 96 setChatPermissions() (telegram.Bot method),
send_video() (telegram.Bot method), 97 100
send_video() (telegram.Chat method), 115 setChatPhoto() (telegram.Bot method), 100
send_video() (telegram.User method), 169 setChatStickerSet() (telegram.Bot method),
send_video_note() (telegram.Bot method), 98 100
send_video_note() (telegram.Chat method), 115 setChatTitle() (telegram.Bot method), 100
send_video_note() (telegram.User method), 169 setGameScore() (telegram.Bot method), 100
send_voice() (telegram.Bot method), 99 setMyCommands() (telegram.Bot method), 100
send_voice() (telegram.Chat method), 115 setPassportDataErrors() (telegram.Bot
send_voice() (telegram.User method), 169 method), 100
sendAnimation() (telegram.Bot method), 85 setStickerPositionInSet() (telegram.Bot
sendAudio() (telegram.Bot method), 85 method), 100
sendChatAction() (telegram.Bot method), 85 setStickerSetThumb() (telegram.Bot method),
sendContact() (telegram.Bot method), 85 100
sendDice() (telegram.Bot method), 85 setWebhook() (telegram.Bot method), 100
sendDocument() (telegram.Bot method), 85 shipping_address (telegram.OrderInfo attribute),
sendGame() (telegram.Bot method), 86 212
sendInvoice() (telegram.Bot method), 86 shipping_address (telegram.ShippingQuery at-
sendLocation() (telegram.Bot method), 86 tribute), 214
sendMediaGroup() (telegram.Bot method), 86 shipping_option_id (tele-
sendMessage() (telegram.Bot method), 86 gram.PreCheckoutQuery attribute), 215
sendPhoto() (telegram.Bot method), 86 shipping_option_id (tele-
sendPoll() (telegram.Bot method), 86 gram.SuccessfulPayment attribute), 213
sendSticker() (telegram.Bot method), 86 shipping_query (telegram.Update attribute), 165
sendVenue() (telegram.Bot method), 86 ShippingAddress (class in telegram), 211
sendVideo() (telegram.Bot method), 86 ShippingOption (class in telegram), 212
sendVideoNote() (telegram.Bot method), 86 ShippingQuery (class in telegram), 214
sendVoice() (telegram.Bot method), 86 ShippingQueryHandler (class in telegram.ext),
set_administrator_custom_title() (tele- 53
gram.Chat method), 115 single_file (telegram.ext.PicklePersistence
set_chat_administrator_custom_title() attribute), 61
(telegram.Bot method), 100 slow_mode_delay (telegram.Chat attribute), 112
set_chat_description() (telegram.Bot small_file_id (telegram.ChatPhoto attribute),
method), 101 121
set_chat_permissions() (telegram.Bot small_file_unique_id (telegram.ChatPhoto at-
method), 101 tribute), 121
set_chat_photo() (telegram.Bot method), 101 source (telegram.PassportElementError attribute),
set_chat_sticker_set() (telegram.Bot 218
method), 102 start() (telegram.ext.Dispatcher method), 10
set_chat_title() (telegram.Bot method), 102 start() (telegram.ext.JobQueue method), 25
set_dispatcher() (telegram.ext.JobQueue start() (telegram.ext.MessageQueue method), 27
method), 25 start_parameter (telegram.Invoice attribute), 210
set_game_score() (telegram.Bot method), 102 start_polling() (telegram.ext.Updater method),
set_my_commands() (telegram.Bot method), 103 7
set_name (telegram.Sticker attribute), 176 start_webhook() (telegram.ext.Updater method),
set_passport_data_errors() (telegram.Bot 7
method), 103 state (telegram.ResidentialAddress attribute), 225
set_permissions() (telegram.Chat method), 116 state (telegram.ShippingAddress attribute), 211
set_sticker_position_in_set() (tele- states (telegram.ext.ConversationHandler attribute),
gram.Bot method), 104 37
set_sticker_set_thumb() (telegram.Bot status (telegram.ChatMember attribute), 117
method), 104 status_update (telegram.ext.filters.Filters at-
set_webhook() (telegram.Bot method), 105 tribute), 16
Sticker (class in telegram), 175

276 Index
 Python Telegram Bot Documentation, Release 12.8

sticker (telegram.ext.filters.Filters attribute), 17 supergroup_chat_created (telegram.Message

sticker (telegram.Message attribute), 141 attribute), 141
sticker_file_id (tele- SUPPORTED_WEBHOOK_PORTS (in module tele-
gram.InlineQueryResultCachedSticker gram.constants), 122
attribute), 189 supports_inline_queries (telegram.Bot at-
sticker_set_name (telegram.Chat attribute), 112 tribute), 107
stickers (telegram.StickerSet attribute), 177 supports_inline_queries (telegram.User at-
StickerSet (class in telegram), 177 tribute), 167
stop() (telegram.ext.DelayQueue method), 28 supports_streaming (telegram.InputMediaVideo
stop() (telegram.ext.Dispatcher method), 11 attribute), 136
stop() (telegram.ext.JobQueue method), 25 svg (telegram.ext.filters.Filters attribute), 15
stop() (telegram.ext.MessageQueue method), 27 switch_inline_query (tele-
stop() (telegram.ext.Updater method), 8 gram.InlineKeyboardButton attribute),
stop_message_live_location() (tele- 129
gram.Bot method), 106 switch_inline_query_current_chat (tele-
stop_poll() (telegram.Bot method), 106 gram.InlineKeyboardButton attribute), 129
stop_poll() (telegram.Message method), 153
stopMessageLiveLocation() (telegram.Bot T
method), 106 targz (telegram.ext.filters.Filters attribute), 15
stopPoll() (telegram.Bot method), 106 telegram.constants (module), 122
store_bot_data (telegram.ext.BasePersistence at- telegram.error (module), 126
tribute), 59 telegram.ext.filters (module), 11
store_bot_data (telegram.ext.DictPersistence at- telegram.utils.helpers (module), 230
tribute), 62 telegram_payment_charge_id (tele-
store_bot_data (telegram.ext.PicklePersistence gram.SuccessfulPayment attribute), 213
attribute), 60 TelegramError, 126
store_chat_data (telegram.ext.BasePersistence TelegramObject (class in telegram), 164
attribute), 59 temporary_registration (tele-
store_chat_data (telegram.ext.DictPersistence gram.SecureData attribute), 223
attribute), 62 text (telegram.ext.filters.Filters attribute), 14, 17
store_chat_data (telegram.ext.PicklePersistence text (telegram.Game attribute), 216
attribute), 60 text (telegram.InlineKeyboardButton attribute), 128
store_user_data (telegram.ext.BasePersistence text (telegram.KeyboardButton attribute), 137
attribute), 59 text (telegram.Message attribute), 140
store_user_data (telegram.ext.DictPersistence text (telegram.PollOption attribute), 160
attribute), 62 text_entities (telegram.Game attribute), 217
store_user_data (telegram.ext.PicklePersistence text_html (telegram.Message attribute), 153
attribute), 60 text_html_urled (telegram.Message attribute),
street_line1 (telegram.ResidentialAddress at- 153
tribute), 224 TEXT_LINK (telegram.MessageEntity attribute), 156
street_line1 (telegram.ShippingAddress at- text_markdown (telegram.Message attribute), 154
tribute), 211 text_markdown_urled (telegram.Message at-
street_line2 (telegram.ResidentialAddress at- tribute), 154
tribute), 225 text_markdown_v2 (telegram.Message attribute),
street_line2 (telegram.ShippingAddress at- 154
tribute), 211 text_markdown_v2_urled (telegram.Message
strict (telegram.ext.TypeHandler attribute), 58 attribute), 154
STRIKETHROUGH (telegram.MessageEntity attribute), TEXT_MENTION (telegram.MessageEntity attribute),
156 156
StringCommandHandler (class in telegram.ext), thumb (telegram.Animation attribute), 65
54 thumb (telegram.Audio attribute), 66
StringRegexHandler (class in telegram.ext), 56 thumb (telegram.Document attribute), 125
successful_payment (telegram.ext.filters.Filters thumb (telegram.InputMediaAnimation attribute), 132
attribute), 17 thumb (telegram.InputMediaAudio attribute), 133
successful_payment (telegram.Message at- thumb (telegram.InputMediaDocument attribute), 134
tribute), 142 thumb (telegram.InputMediaVideo attribute), 136
SuccessfulPayment (class in telegram), 213 thumb (telegram.Sticker attribute), 176
SUPERGROUP (telegram.Chat attribute), 113 thumb (telegram.StickerSet attribute), 177

Index 277
Python Telegram Bot Documentation, Release 12.8

thumb (telegram.Video attribute), 171 180

thumb (telegram.VideoNote attribute), 172 title (telegram.InlineQueryResultAudio attribute),
thumb_height (telegram.InlineQueryResultArticle 182
attribute), 181 title (telegram.InlineQueryResultCachedDocument
thumb_height (telegram.InlineQueryResultContact attribute), 184
attribute), 193 title (telegram.InlineQueryResultCachedGif at-
thumb_height (tele- tribute), 185
gram.InlineQueryResultDocument attribute), title (telegram.InlineQueryResultCachedMpeg4Gif
194 attribute), 187
thumb_height (tele- title (telegram.InlineQueryResultCachedPhoto at-
gram.InlineQueryResultLocation attribute), tribute), 188
198 title (telegram.InlineQueryResultCachedVideo at-
thumb_height (telegram.InlineQueryResultVenue tribute), 190
attribute), 203 title (telegram.InlineQueryResultCachedVoice at-
thumb_mime_type (telegram.InlineQueryResultGif tribute), 191
attribute), 196 title (telegram.InlineQueryResultDocument at-
thumb_mime_type (tele- tribute), 193
gram.InlineQueryResultMpeg4Gif attribute), title (telegram.InlineQueryResultGif attribute), 196
199 title (telegram.InlineQueryResultLocation at-
thumb_url (telegram.InlineQueryResultArticle at- tribute), 197
tribute), 181 title (telegram.InlineQueryResultMpeg4Gif at-
thumb_url (telegram.InlineQueryResultContact at- tribute), 199
tribute), 192 title (telegram.InlineQueryResultPhoto attribute),
thumb_url (telegram.InlineQueryResultDocument 201
attribute), 194 title (telegram.InlineQueryResultVenue attribute),
thumb_url (telegram.InlineQueryResultGif at- 202
tribute), 196 title (telegram.InlineQueryResultVideo attribute),
thumb_url (telegram.InlineQueryResultLocation at- 204
tribute), 198 title (telegram.InlineQueryResultVoice attribute),
thumb_url (telegram.InlineQueryResultMpeg4Gif 205
attribute), 199 title (telegram.InputMediaAudio attribute), 133
thumb_url (telegram.InlineQueryResultPhoto title (telegram.InputVenueMessageContent at-
attribute), 200 tribute), 208
thumb_url (telegram.InlineQueryResultVenue title (telegram.Invoice attribute), 210
attribute), 202 title (telegram.ShippingOption attribute), 212
thumb_url (telegram.InlineQueryResultVideo title (telegram.StickerSet attribute), 177
attribute), 204 title (telegram.Venue attribute), 170
thumb_width (telegram.InlineQueryResultArticle to_float_timestamp() (in module tele-
attribute), 181 gram.utils.helpers), 233
thumb_width (telegram.InlineQueryResultContact to_json() (telegram.TelegramObject method), 164
attribute), 192 to_timestamp() (in module tele-
thumb_width (tele- gram.utils.helpers), 233
gram.InlineQueryResultDocument attribute), total_amount (telegram.Invoice attribute), 210
194 total_amount (telegram.PreCheckoutQuery at-
thumb_width (telegram.InlineQueryResultLocation tribute), 215
attribute), 198 total_amount (telegram.SuccessfulPayment at-
thumb_width (telegram.InlineQueryResultVenue at- tribute), 213
tribute), 202 total_count (telegram.UserProfilePhotos at-
tick() (telegram.ext.JobQueue method), 26 tribute), 170
time_limit (telegram.ext.DelayQueue attribute), 27 total_voter_count (telegram.Poll attribute), 158
TimedOut, 126 translation (telegram.EncryptedPassportElement
TIMEOUT (telegram.ext.ConversationHandler at- attribute), 228
tribute), 38 txt (telegram.ext.filters.Filters attribute), 15
timeout (telegram.ext.Defaults attribute), 30 type (telegram.Chat attribute), 111
title (telegram.Audio attribute), 66 type (telegram.EncryptedPassportElement attribute),
title (telegram.Chat attribute), 111 227
title (telegram.Game attribute), 216 type (telegram.ext.TypeHandler attribute), 57
title (telegram.InlineQueryResultArticle attribute), type (telegram.InlineQueryResult attribute), 180

278 Index
 Python Telegram Bot Documentation, Release 12.8

type (telegram.InlineQueryResultArticle attribute), TypeHandler (class in telegram.ext), 57

180 TYPING (telegram.ChatAction attribute), 116
type (telegram.InlineQueryResultAudio attribute),
182 U
type (telegram.InlineQueryResultCachedAudio Unauthorized, 126
attribute), 183 unban_chat_member() (telegram.Bot method),
type (telegram.InlineQueryResultCachedDocument 107
attribute), 184 unban_member() (telegram.Chat method), 116
type (telegram.InlineQueryResultCachedGif at- unbanChatMember() (telegram.Bot method), 107
tribute), 185 UNDERLINE (telegram.MessageEntity attribute), 156
type (telegram.InlineQueryResultCachedMpeg4Gif unpin_chat_message() (telegram.Bot method),
attribute), 186 107
type (telegram.InlineQueryResultCachedPhoto at- unpinChatMessage() (telegram.Bot method), 107
tribute), 187 until_date (telegram.ChatMember attribute), 117
type (telegram.InlineQueryResultCachedSticker at- Update (class in telegram), 164
tribute), 189 update (telegram.ext.filters.Filters attribute), 18
type (telegram.InlineQueryResultCachedVideo update_bot_data() (tele-
attribute), 189 gram.ext.BasePersistence method), 60
type (telegram.InlineQueryResultCachedVoice update_bot_data() (telegram.ext.DictPersistence
attribute), 191 method), 63
type (telegram.InlineQueryResultContact attribute), update_bot_data() (tele-
192 gram.ext.PicklePersistence method), 61
type (telegram.InlineQueryResultDocument at- update_chat_data() (tele-
tribute), 193 gram.ext.BasePersistence method), 60
type (telegram.InlineQueryResultGame attribute), update_chat_data() (tele-
195 gram.ext.DictPersistence method), 64
type (telegram.InlineQueryResultGif attribute), 195 update_chat_data() (tele-
type (telegram.InlineQueryResultLocation attribute), gram.ext.PicklePersistence method), 62
197 update_conversation() (tele-
type (telegram.InlineQueryResultMpeg4Gif at- gram.ext.BasePersistence method), 60
tribute), 198 update_conversation() (tele-
type (telegram.InlineQueryResultPhoto attribute), gram.ext.DictPersistence method), 64
200 update_conversation() (tele-
type (telegram.InlineQueryResultVenue attribute), gram.ext.PicklePersistence method), 62
202 update_filter (telegram.ext.filters.BaseFilter at-
type (telegram.InlineQueryResultVideo attribute), tribute), 20
203 update_id (telegram.Update attribute), 164
type (telegram.InlineQueryResultVoice attribute), 205 update_persistence() (telegram.ext.Dispatcher
type (telegram.InputMediaAnimation attribute), 131 method), 11
type (telegram.InputMediaAudio attribute), 132 update_queue (telegram.ext.CallbackContext at-
type (telegram.InputMediaDocument attribute), 134 tribute), 30
type (telegram.InputMediaPhoto attribute), 135 update_queue (telegram.ext.Dispatcher attribute),
type (telegram.InputMediaVideo attribute), 135 8
type (telegram.KeyboardButtonPollType attribute), update_queue (telegram.ext.Updater attribute), 5
137 update_user_data() (tele-
type (telegram.MessageEntity attribute), 154 gram.ext.BasePersistence method), 60
type (telegram.PassportElementError attribute), 218 update_user_data() (tele-
type (telegram.PassportElementErrorDataField at- gram.ext.DictPersistence method), 64
tribute), 221 update_user_data() (tele-
type (telegram.PassportElementErrorFile attribute), gram.ext.PicklePersistence method), 62
219 Updater (class in telegram.ext), 5
type (telegram.PassportElementErrorFiles attribute), UPLOAD_AUDIO (telegram.ChatAction attribute), 116
220 UPLOAD_DOCUMENT (telegram.ChatAction attribute),
type (telegram.PassportElementErrorFrontSide at- 116
tribute), 220 UPLOAD_PHOTO (telegram.ChatAction attribute), 116
type (telegram.PassportElementErrorReverseSide at- upload_sticker_file() (telegram.Bot method),
tribute), 219 107
type (telegram.Poll attribute), 158 UPLOAD_VIDEO (telegram.ChatAction attribute), 116

Index 279
Python Telegram Bot Documentation, Release 12.8

UPLOAD_VIDEO_NOTE (telegram.ChatAction at- video_file_id (tele-

tribute), 117 gram.InlineQueryResultCachedVideo at-
uploadStickerFile() (telegram.Bot method), tribute), 190
107 video_height (telegram.InlineQueryResultVideo
url (telegram.InlineKeyboardButton attribute), 128 attribute), 204
url (telegram.InlineQueryResultArticle attribute), 181 video_note (telegram.ext.filters.Filters attribute),
url (telegram.LoginUrl attribute), 138 19
URL (telegram.MessageEntity attribute), 156 video_note (telegram.Message attribute), 141
url (telegram.MessageEntity attribute), 155 video_url (telegram.InlineQueryResultVideo
url (telegram.WebhookInfo attribute), 174 attribute), 204
use_context (telegram.ext.Updater attribute), 6 video_width (telegram.InlineQueryResultVideo at-
User (class in telegram), 166 tribute), 204
user (telegram.ChatMember attribute), 117 VideoNote (class in telegram), 172
user (telegram.GameHighScore attribute), 218 Voice (class in telegram), 173
user (telegram.MessageEntity attribute), 155 voice (telegram.ext.filters.Filters attribute), 19
user (telegram.PollAnswer attribute), 160 voice (telegram.Message attribute), 141
user_data (telegram.ext.CallbackContext attribute), voice_duration (tele-
29 gram.InlineQueryResultVoice attribute),
user_data (telegram.ext.DictPersistence attribute), 206
64 voice_file_id (tele-
user_data (telegram.ext.Dispatcher attribute), 8 gram.InlineQueryResultCachedVoice at-
user_data_json (telegram.ext.DictPersistence at- tribute), 191
tribute), 64 voice_url (telegram.InlineQueryResultVoice at-
user_id (telegram.Contact attribute), 123 tribute), 205
user_ids (telegram.ext.filters.Filters.user attribute), voter_count (telegram.PollOption attribute), 160
18
user_sig_handler (telegram.ext.Updater at- W
tribute), 5 WAITING (telegram.ext.ConversationHandler at-
username (telegram.Bot attribute), 108 tribute), 38
username (telegram.Chat attribute), 111 wav (telegram.ext.filters.Filters attribute), 15
username (telegram.User attribute), 167 WebhookInfo (class in telegram), 174
usernames (telegram.ext.filters.Filters.chat at- width (telegram.Animation attribute), 64
tribute), 12 width (telegram.InputMediaAnimation attribute), 132
usernames (telegram.ext.filters.Filters.user at- width (telegram.InputMediaVideo attribute), 135
tribute), 18 width (telegram.PhotoSize attribute), 157
UserProfilePhotos (class in telegram), 170 width (telegram.Sticker attribute), 175
utility_bill (telegram.SecureData attribute), 223 width (telegram.Video attribute), 171
workers (telegram.ext.Dispatcher attribute), 8
V
value (telegram.Dice attribute), 124 X
value (telegram.utils.helpers.DefaultValue attribute), x_shift (telegram.MaskPosition attribute), 178
231 xml (telegram.ext.filters.Filters attribute), 15
vcard (telegram.Contact attribute), 123
vcard (telegram.InlineQueryResultContact attribute), Y
192 y_shift (telegram.MaskPosition attribute), 178
vcard (telegram.InputContactMessageContent
attribute), 209 Z
Venue (class in telegram), 170
zip (telegram.ext.filters.Filters attribute), 15
venue (telegram.ext.filters.Filters attribute), 19
venue (telegram.Message attribute), 141
via_bot (telegram.Message attribute), 142
Video (class in telegram), 171
video (telegram.ext.filters.Filters attribute), 14, 19
video (telegram.Message attribute), 141
video_duration (tele-
gram.InlineQueryResultVideo attribute),
204

280 Index