0% found this document useful (0 votes)

1K views

Python Telegram Bot

This document summarizes the Python Telegram Bot documentation. It describes the telegram package for building Telegram bots, including the telegram.ext subpackage for bot functionality. It provides details on the Updater, Dispatcher, filters, jobs, and handlers for processing bot updates. It also describes the various Telegram objects like Messages, Chats, Users, Callbacks, and Media.

Uploaded by

Austine Wuncler III

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

1K views

Python Telegram Bot

Uploaded by

Austine Wuncler III

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 287

Python Telegram Bot Documentation

Release 8.0.0

Leandro Toledo

Sep 04, 2017

Contents

1 telegram package 3
1.1 telegram.ext package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.1 telegram.ext.Updater . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.2 telegram.ext.Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1.3 telegram.ext.filters Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.1.4 telegram.ext.JobQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.1.5 telegram.ext.MessageQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.1.6 telegram.ext.DelayQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.1.7 Handlers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.2 telegram.Audio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.3 telegram.Bot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.4 telegram.CallbackQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
1.5 telegram.Chat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
1.6 telegram.ChatAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
1.7 telegram.ChatMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
1.8 telegram.ChatPhoto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
1.9 telegram.constants Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
1.10 telegram.Contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
1.11 telegram.Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
1.12 telegram.error module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
1.13 telegram.File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
1.14 telegram.ForceReply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
1.15 telegram.InlineKeyboardButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
1.16 telegram.InlineKeyboardMarkup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
1.17 telegram.InputFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
1.18 telegram.KeyboardButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
1.19 telegram.Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
1.20 telegram.Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
1.21 telegram.MessageEntity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
1.22 telegram.ParseMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
1.23 telegram.PhotoSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
1.24 telegram.ReplyKeyboardRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
1.25 telegram.ReplyKeyboardMarkup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
1.26 telegram.ReplyMarkup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
1.27 telegram.TelegramObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
1.28 telegram.Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
1.29 telegram.User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
1.30 telegram.UserProfilePhotos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
1.31 telegram.Venue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
1.32 telegram.Video . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

i
1.33 telegram.VideoNote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
1.34 telegram.Voice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
1.35 telegram.WebhookInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
1.36 Stickers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
1.36.1 telegram.Sticker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
1.36.2 telegram.StickerSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
1.36.3 telegram.MaskPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
1.37 Inline Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
1.37.1 telegram.InlineQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
1.37.2 telegram.InlineQueryResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
1.37.3 telegram.InlineQueryResultArticle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
1.37.4 telegram.InlineQueryResultAudio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
1.37.5 telegram.InlineQueryResultCachedAudio . . . . . . . . . . . . . . . . . . . . . . . . . 123
1.37.6 telegram.InlineQueryResultCachedDocument . . . . . . . . . . . . . . . . . . . . . . . 124
1.37.7 telegram.InlineQueryResultCachedGif . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
1.37.8 telegram.InlineQueryResultCachedMpeg4Gif . . . . . . . . . . . . . . . . . . . . . . . 126
1.37.9 telegram.InlineQueryResultCachedPhoto . . . . . . . . . . . . . . . . . . . . . . . . . 126
1.37.10 telegram.InlineQueryResultCachedSticker . . . . . . . . . . . . . . . . . . . . . . . . . 127
1.37.11 telegram.InlineQueryResultCachedVideo . . . . . . . . . . . . . . . . . . . . . . . . . 128
1.37.12 telegram.InlineQueryResultCachedVoice . . . . . . . . . . . . . . . . . . . . . . . . . . 129
1.37.13 telegram.InlineQueryResultContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
1.37.14 telegram.InlineQueryResultDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
1.37.15 telegram.InlineQueryResultGame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
1.37.16 telegram.InlineQueryResultGif . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
1.37.17 telegram.InlineQueryResultLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
1.37.18 telegram.InlineQueryResultMpeg4Gif . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
1.37.19 telegram.InlineQueryResultPhoto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
1.37.20 telegram.InlineQueryResultVenue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
1.37.21 telegram.InlineQueryResultVideo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
1.37.22 telegram.InlineQueryResultVoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
1.37.23 telegram.InputMessageContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
1.37.24 telegram.InputTextMessageContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
1.37.25 telegram.InputLocationMessageContent . . . . . . . . . . . . . . . . . . . . . . . . . . 140
1.37.26 telegram.InputVenueMessageContent . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
1.37.27 telegram.InputContactMessageContent . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
1.37.28 telegram.ChosenInlineResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
1.38 Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
1.38.1 telegram.LabeledPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
1.38.2 telegram.Invoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
1.38.3 telegram.ShippingAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
1.38.4 telegram.OrderInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
1.38.5 telegram.ShippingOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
1.38.6 telegram.SuccessfulPayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
1.38.7 telegram.ShippingQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
1.38.8 telegram.PreCheckoutQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
1.39 Games . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
1.39.1 telegram.Game . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
1.39.2 telegram.Animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
1.39.3 telegram.Callbackgame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
1.39.4 telegram.GameHighScore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
1.40 Module contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

2 Indices and tables 263

Python Module Index 265

ii
Python Telegram Bot Documentation, Release 8.0.0

Below you can find the documentation for the python-telegram-bot library. except for the .ext package most of the
objects in the package reflect the types as defined by the telegram bot api.

Contents 1
Python Telegram Bot Documentation, Release 8.0.0

2 Contents
CHAPTER 1

telegram package

1.1 telegram.ext package

1.1.1 telegram.ext.Updater

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

user_sig_handler=None, request_kwargs=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
telegram.Bot The bot used with this Updater.
user_sig_handler
signal signals the updater will respond to.
update_queue
Queue Queue for the updates.
job_queue
telegram.ext.JobQueue Jobqueue for the updater.
dispatcher
telegram.ext.Dispatcher Dispatcher that handles the updates and dispatches them to the
handlers.
running
bool Indicates if the updater is running.

Parameters
token (str, optional) The bots token given by the @BotFather.
base_url (str, optional) Base_url for the bot.

3
Python Telegram Bot Documentation, Release 8.0.0

workers (int, optional) Amount of threads in the thread pool for functions deco-
rated with @run_async.
bot (telegram.Bot, optional) A pre-initialized bot instance. If a pre-initialized
bot is used, it is the users responsibility to create it using a Request instance with a
large enough connection pool.
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 re-
quest object (ignored if bot argument is used).

Note: You must supply either a bot or a token argument.

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

idle(stop_signals=(2, 15, 6))

Blocks until one of the signals are received and stops the updater.
Parameters stop_signals (iterable) Iterable 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, network_delay=None, clean=False, boot-
strap_retries=0, 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
0 - no retries (default)
> 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).
network_delay Deprecated. Will be honoured as read_latency for a while
but will be removed in the future.
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

4 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.
bootstrap_retries (int, optional) Whether the bootstrapping phase of the
Updater will retry on failures on the Telegram server.
< 0 - retry indefinitely
0 - no retries (default)
> 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.

1.1.2 telegram.ext.Dispatcher

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

job_queue=None)
Bases: object
This class dispatches all kinds of updates to its registered handlers.
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 Number of maximum concurrent worker threads for the @run_async decorator.

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.

1.1. telegram.ext package 5

Python Telegram Bot Documentation, Release 8.0.0

workers (int, optional) Number of maximum concurrent worker threads for the
@run_async decorator. defaults to 4.

add_error_handler(callback)
Registers an error handler in the Dispatcher.
Parameters callback (callable) A function that takes Bot, Update,
TelegramError as arguments.
add_handler(handler, group=0)
Register a handler.
TL;DR: Order and priority counts. 0 or 1 handlers per group will be used.
A handler must be an instance of a subclass of telegram.ext.Handler. All handlers are
organized in groups with a numeric value. The default group is 0. All groups will be evalu-
ated for handling an update, but only 0 or 1 handler per group will be used. If telegram.
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.

chat_data = None
dict A dictionary handlers can use to store data for the chat.
dispatch_error(update, error)
Dispatches an error.
Parameters
update (str | telegram.Update | None) The update that caused the error
error (telegram.TelegramError) The Telegram error that was raised.
error_handlers = None
List[callable] A list of errorHandlers.
classmethod get_instance()
Get the singleton instance of this class.
Returns telegram.ext.Dispatcher
Raises RuntimeError
groups = None
List[int] A list with all groups.
handlers = None
Dict[int, List[telegram.ext.Handler]] Holds the handlers per group.
process_update(update)
Processes a single update.
Parameters update (str | telegram.Update | telegram.TelegramError)
The update to process.

6 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.
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
bool Indicates if this dispatcher is running.
start()
Thread target of thread dispatcher.
Runs in background and processes the update queue.
stop()
Stops the thread.
user_data = None
dict A dictionary handlers can use to store data for the user.

1.1.3 telegram.ext.filters Module

This module contains the Filters for use with the MessageHandler class.
class telegram.ext.filters.BaseFilter
Bases: object
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:

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

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

1.1. telegram.ext package 7

Python Telegram Bot Documentation, Release 8.0.0

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
str Name for this filter. Defaults to the type of filter.
filter(message)
This method must be overwritten.
Parameters message (telegram.Message) The message that is tested.
Returns bool
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
Filter All Messages.
audio = Filters.audio
Filter Messages that contain telegram.Audio.
class chat(chat_id=None, username=None)
Bases: telegram.ext.filters.BaseFilter
Filters messages to allow only those which are from specified chat ID.

Examples

MessageHandler(Filters.chat(-1234), callback_method)
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. If
username start swith @ symbol, it will be ignored.
Raises ValueError If chat_id and username are both present, or neither is.
command = Filters.command
Filter Messages starting with /.
contact = Filters.contact
Filter Messages that contain telegram.Contact.
document = Filters.document
Filter Messages that contain telegram.Document.
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.

8 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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
Filter Messages that are forwarded.
game = Filters.game
Filter Messages that contain telegram.Game.
group = Filters.group
Filter Messages sent in a group chat.
invoice = Filters.invoice
Filter 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.
Note: According to telegrams documentation, every single user does not have the language_code
attribute.

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
Filter Messages that contain telegram.Location.
photo = Filters.photo
Filter Messages that contain telegram.PhotoSize.
private = Filters.private
Filter Messages sent in a private chat.
reply = Filters.reply
Filter Messages that are a reply to another message.
status_update = Filters.status_update
Subset for messages containing a status update.

Examples

Use these filters like: Filters.status_update.new_chat_member etc. Or use just

Filters.status_update for all status update messages.
chat_created
Filter Messages that contain telegram.Message.group_chat_created,
telegram.Message.supergroup_chat_created or telegram.Message.
channel_chat_created.
delete_chat_photo
Filter Messages that contain telegram.Message.delete_chat_photo.

1.1. telegram.ext package 9

Python Telegram Bot Documentation, Release 8.0.0

left_chat_member
Filter Messages that contain telegram.Message.left_chat_member.
migrate
Filter Messages that contain telegram.Message.migrate_from_chat_id or :attr:
telegram.Message.migrate_from_chat_id.
new_chat_members
Filter Messages that contain telegram.Message.new_chat_member.
new_chat_photo
Filter Messages that contain telegram.Message.new_chat_photo.
new_chat_title
Filter Messages that contain telegram.Message.new_chat_title.
pinned_message
Filter Messages that contain telegram.Message.pinned_message.
sticker = Filters.sticker
Filter Messages that contain telegram.Sticker.
successful_payment = Filters.successful_payment
Filter Messages that confirm a telegram.SuccessfulPayment.
text = Filters.text
Filter Text Messages.
class user(user_id=None, username=None)
Bases: telegram.ext.filters.BaseFilter
Filters messages to allow only those which are from specified user ID.

Examples

MessageHandler(Filters.user(1234), callback_method)
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. If
username starts with @ symbol, it will be ignored.
Raises ValueError If chat_id and username are both present, or neither is.
venue = Filters.venue
Filter Messages that contain telegram.Venue.
video = Filters.video
Filter Messages that contain telegram.Video.
voice = Filters.voice
Filter Messages that contain telegram.Voice.
class telegram.ext.filters.InvertedFilter(f )
Bases: telegram.ext.filters.BaseFilter
Represents a filter that has been inverted.
Parameters f The filter to invert.
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

10 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.

1.1.4 telegram.ext.JobQueue

class telegram.ext.JobQueue(bot, prevent_autostart=None)

Bases: object
This class allows you to periodically perform tasks with the bot.
queue
PriorityQueue The queue that holds the Jobs.
bot
telegram.Bot Bot thats send to the handlers.

Parameters bot (telegram.Bot) The bot instance that should be passed to the jobs.

Deprecated: prevent_autostart (bool, optional): Thread does not start during initialisation. Use start
method instead.

jobs()
Returns a tuple of all jobs that are currently in the JobQueue.
put(job, next_t=None)
Queue a new job.

Note: This method is deprecated. Please use: run_once, run_daily or run_repeating

instead.

Parameters
job (telegram.ext.Job) The Job instance representing the new job.
next_t (int | float | datetime.timedelta | datetime.datetime |
datetime.time, optional) Time in or at which the job should run for the first
time. 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.
datetime.time will be interpreted as a specific time at which the job should
run. This could be either today or, if the time has already passed, tomorrow.

run_daily(callback, time, days=(0, 1, 2, 3, 4, 5, 6), context=None, name=None)

Creates a new Job that runs once and adds it to the queue.
Parameters

1.1. telegram.ext package 11

Python Telegram Bot Documentation, Release 8.0.0

callback (callable) The callback function that should be executed by the new
job. It should take bot, job as parameters, where 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.
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
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. It should take bot, job as parameters, where 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.
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.
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
run_repeating(callback, interval, first=None, 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. It should take bot, job as parameters, where 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.

12 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.
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.
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
start()
Starts the job_queue thread.
stop()
Stops the thread.
tick()
Run all jobs that are due and re-enqueue them with their interval.

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

1.1. telegram.ext package 13

Python Telegram Bot Documentation, Release 8.0.0

autostart (bool, optional) If True, processors are started immediately after ob-
jects 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 True.

Notes

Method is designed to accept telegram.utils.promise.Promise as promise argument,

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

1.1.6 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
int Number of maximum callbacks to process per time-window.
time_limit
int Defines width of time-window used when each processing limit is calculated.
exc_route
callable A callable, accepting 1 positional argument; used to route exceptions from processor
thread to main thread;
name
str Threads name.

14 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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 objects
creation; if False, should be started manually by start method. Defaults to True.
name (str, optional) Threads 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.
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.

1.1.7 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: object
The base class for all update handlers. Create custom handlers by inheriting from it.
callback
callable The callback function for this handler.
pass_update_queue
bool Optional. Determines whether update_queue will be passed to the callback function.
pass_job_queue
bool Optional. Determines whether job_queue will be passed to the callback function.

1.1. telegram.ext package 15

Python Telegram Bot Documentation, Release 8.0.0

pass_user_data
bool Optional. Determines whether user_data will be passed to the callback function.
pass_chat_data
bool Optional. Determines whether chat_data will be passed to the callback function.

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.

Parameters
callback (callable) A function that takes bot, update as positional argu-
ments. It will be called when the check_update has determined that an update
should be processed by this handler.
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.

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 bool
collect_optional_args(dispatcher, update=None)
Prepares the optional arguments that are the same for all types of handlers.
Parameters dispatcher (telegram.ext.Dispatcher) The dispatcher.
handle_update(update, dispatcher)
This method is called if it was determined that an update should indeed be handled by this in-
stance. It should also be overridden, but in most cases call self.callback(dispatcher.bot,
update), possibly along with optional arguments. To work with the ConversationHandler,
this method should return the value returned from self.callback
Parameters
update (str | telegram.Update) The update to be handled.
dispatcher (telegram.ext.Dispatcher) The dispatcher to collect op-
tional args.

16 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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
callable The callback function for this handler.
pass_update_queue
bool Optional. Determines whether update_queue will be passed to the callback function.
pass_job_queue
bool Optional. Determines whether job_queue will be passed to the callback function.
pattern
str | Pattern Optional. Regex pattern to test telegram.CallbackQuery.data against.
pass_groups
bool Optional. Determines whether groups will be passed to the callback function.
pass_groupdict
bool Optional. Determines whether groupdict. will be passed to the callback function.
pass_user_data
bool Optional. Determines whether user_data will be passed to the callback function.
pass_chat_data
bool Optional. Determines whether chat_data will be passed to the callback function.

Parameters
callback (callable) A function that takes bot, update as positional argu-
ments. It will be called when the check_update has determined that an update
should be processed by this handler.
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.
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

1.1. telegram.ext package 17

Python Telegram Bot Documentation, Release 8.0.0

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

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (telegram.Update) Incoming telegram update.
Returns bool
handle_update(update, dispatcher)
Send the update to the callback.
Parameters
update (telegram.Update) Incoming telegram update.
dispatcher (telegram.ext.Dispatcher) Dispatcher that originated the
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
callable The callback function for this handler.
pass_update_queue
bool Optional. Determines whether update_queue will be passed to the callback function.
pass_job_queue
bool Optional. Determines whether job_queue will be passed to the callback function.
pass_user_data
bool Optional. Determines whether user_data will be passed to the callback function.
pass_chat_data
bool Optional. Determines whether chat_data will be passed to the callback function.

Parameters
callback (callable) A function that takes bot, update as positional argu-
ments. It will be called when the check_update has determined that an update
should be processed by this handler.

18 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

pass_update_queue (bool, optional) If set to True, a keyword argument called

telegram.ext.ConversationHandler

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

low_reentry=False, run_async_timeout=None,
timed_out_behavior=None, per_chat=True,
per_user=True, per_message=False)
Bases: telegram.ext.handler.Handler
A handler to hold a conversation with a single user by managing four collections of other handlers. Note that
neither posts in Telegram Channels, nor group interactions with multiple users are managed by instances of
this class.
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 cur-
rently in that state. You will probably use mostly telegram.ext.MessageHandler and telegram.
ext.RegexHandler here.
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.
The fourth, optional collection of handlers, a list named timed_out_behavior is used if the wait
for run_async takes longer than defined in run_async_timeout. For example, you can let the user
know that they should wait for a bit before they can continue.
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.
To end the conversation, the callback function must return :attrEND or -1.

1.1. telegram.ext package 19

Python Telegram Bot Documentation, Release 8.0.0

entry_points
List[telegram.ext.Handler] A list of Handler objects that can trigger the start of the con-
versation.
states
Dict[object, List[telegram.ext.Handler]] A dict that defines the different states of con-
versation a user can be in and one or more associated Handler objects that should be used in that
state.
fallbacks
List[telegram.ext.Handler] A list of handlers that might be used if the user is in a conversa-
tion, but every handler for their current state returned False on check_update.
allow_reentry
bool Optional. Determines if a user can restart a conversation with an entry point.
run_async_timeout
float Optional. The time-out for run_async decorated Handlers.
timed_out_behavior
List[telegram.ext.Handler] Optional. A list of handlers that might be used if the wait for
run_async timed out.
per_chat
bool Optional. If the conversationkey should contain the Chats ID.
per_user
bool Optional. If the conversationkey should contain the Users ID.
per_message
bool Optional. If the conversationkey should contain the Messages ID.

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.
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.
run_async_timeout (float, optional) If the previous handler for this user was
running asynchronously using the run_async decorator, it might not be finished when
the next message arrives. This timeout defines how long the conversation handler should
wait for the next state to be computed. The default is None which means it will wait
indefinitely.
timed_out_behavior (List[telegram.ext.Handler], optional) A list of
handlers that might be used if the wait for run_async timed out. The first handler
which check_update method returns True will be used. If all return False, the
update is not handled.
per_chat (bool, optional) If the conversationkey should contain the Chats ID.
Default is True.

20 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

per_user (bool, optional) If the conversationkey should contain the Users ID.
Default is True.
per_message (bool, optional) If the conversationkey should contain the Mes-
sages ID. Default is False.
Raises ValueError

END = -1
int Used as a constant to return when a conversation is ended.
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)
Send the update to the callback for the current state and Handler
Parameters
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=False,

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 bots name and/or
some additional text.
command
str | List[str] The command or list of commands this handler should listen for.
callback
callable The callback function for this handler.
filters
telegram.ext.BaseFilter Optional. Only allow updates with these Filters.
allow_edited
bool Optional. Determines Whether the handler should also accept edited messages.
pass_args
bool Optional. Determines whether the handler should be passed args.
pass_update_queue
bool Optional. Determines whether update_queue will be passed to the callback function.
pass_job_queue
bool Optional. Determines whether job_queue will be passed to the callback function.
pass_user_data
bool Optional. Determines whether user_data will be passed to the callback function.
pass_chat_data
bool Optional. Determines whether chat_data will be passed to the callback function.

1.1. telegram.ext package 21

Python Telegram Bot Documentation, Release 8.0.0

Parameters
command (str | List[str]) The command or list of commands this handler should
listen for.
callback (callable) A function that takes bot, update as positional argu-
ments. It will be called when the check_update has determined that an update
should be processed by this handler.
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.
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
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.

22 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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
callable The callback function for this handler.
pass_update_queue
bool Optional. Determines whether update_queue will be passed to the callback function.
pass_job_queue
bool Optional. Determines whether job_queue will be passed to the callback function.
pattern
str | Pattern Optional. Regex pattern to test telegram.InlineQuery.query against.
pass_groups
bool Optional. Determines whether groups will be passed to the callback function.
pass_groupdict
bool Optional. Determines whether groupdict. will be passed to the callback function.
pass_user_data
bool Optional. Determines whether user_data will be passed to the callback function.
pass_chat_data
bool Optional. Determines whether chat_data will be passed to the callback function.

Parameters
callback (callable) A function that takes bot, update as positional argu-
ments. It will be called when the check_update has determined that an update
should be processed by this handler.
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.
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

1.1. telegram.ext package 23

Python Telegram Bot Documentation, Release 8.0.0

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

telegram.ext.MessageHandler

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

pass_update_queue=False, pass_job_queue=False,
pass_user_data=False, pass_chat_data=False, mes-
sage_updates=True, channel_post_updates=True,
edited_updates=False)
Bases: telegram.ext.handler.Handler
Handler class to handle telegram messages. They might contain text, media or status updates.
filters
Filter Only allow updates with these Filters. See telegram.ext.filters for a full list of
all available filters.
callback
callable The callback function for this handler.
pass_update_queue
bool Optional. Determines whether update_queue will be passed to the callback function.
pass_job_queue
bool Optional. Determines whether job_queue will be passed to the callback function.
pass_user_data
bool Optional. Determines whether user_data will be passed to the callback function.
pass_chat_data
bool Optional. Determines whether chat_data will be passed to the callback function.
message_updates
bool Optional. Should normal message updates be handled? Default is True.
channel_post_updates
bool Optional. Should channel posts updates be handled? Default is True.
edited_updates
bool Optional. Should edited message updates be handled? Default is False.

24 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

allow_edited
bool Optional. If the handler should also accept edited messages. Default is False - Deprecated.
use edited_updates instead.

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).
callback (callable) A function that takes bot, update as positional argu-
ments. It will be called when the check_update has determined that an update
should be processed by this handler.
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.
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.
allow_edited (bool, optional) If the handler should also accept edited messages.
Default is False - Deprecated. use edited_updates instead.
Raises ValueError

1.1. telegram.ext package 25

Python Telegram Bot Documentation, Release 8.0.0

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
callable The callback function for this handler.
pass_update_queue
bool Optional. Determines whether update_queue will be passed to the callback function.
pass_job_queue
bool Optional. Determines whether job_queue will be passed to the callback function.
pass_user_data
bool Optional. Determines whether user_data will be passed to the callback function.
pass_chat_data
bool Optional. Determines whether chat_data will be passed to the callback function.

26 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

dispatcher (telegram.ext.Dispatcher) Dispatcher that originated the

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.handler.Handler
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
str | Pattern The regex pattern.
callback
callable The callback function for this handler.
pass_groups
bool Optional. Determines whether groups will be passed to the callback function.
pass_groupdict
bool Optional. Determines whether groupdict. will be passed to the callback function.
pass_update_queue
bool Optional. Determines whether update_queue will be passed to the callback function.
pass_job_queue
bool Optional. Determines whether job_queue will be passed to the callback function.
pass_user_data
bool Optional. Determines whether user_data will be passed to the callback function.
pass_chat_data
bool Optional. Determines whether chat_data will be passed to the callback function.

1.1. telegram.ext package 27

Python Telegram Bot Documentation, Release 8.0.0

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.
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.
allow_edited (bool, optional) If the handler should also accept edited messages.
Default is False - Deprecated. use edited_updates instead.
Raises ValueError

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
callable The callback function for this handler.
pass_update_queue
bool Optional. Determines whether update_queue will be passed to the callback function.
pass_job_queue
bool Optional. Determines whether job_queue will be passed to the callback function.

28 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

pass_user_data
bool Optional. Determines whether user_data will be passed to the callback function.
pass_chat_data
bool Optional. Determines whether chat_data will be passed to the callback function.

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.

1.1. telegram.ext package 29

Python Telegram Bot Documentation, Release 8.0.0

command
str The command this handler should listen for.
callback
callable The callback function for this handler.
pass_args
bool Optional. Determines whether the handler should be passed args.
pass_update_queue
bool Optional. Determines whether update_queue will be passed to the callback function.
pass_job_queue
bool Optional. Determines whether job_queue will be passed to the callback function.

Parameters
command (str) The command this handler should listen for.
callback (callable) A function that takes bot, update as positional argu-
ments. It will be called when the check_update has determined that a command
should be processed by this handler.
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
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
class:telegram.ext.JobQueue instance created by the telegram.ext.Updater
which can be used to schedule new jobs. Default is False.

check_update(update)
Determines whether an update should be passed to this handlers callback.
Parameters update (str) An incomming command.
Returns bool
handle_update(update, dispatcher)
Send the update to the callback.
Parameters
update (str) An incomming command.
dispatcher (telegram.ext.Dispatcher) Dispatcher that originated the
command.

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.

30 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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
str | Pattern The regex pattern.
callback
callable The callback function for this handler.
pass_groups
bool Optional. Determines whether groups will be passed to the callback function.
pass_groupdict
bool Optional. Determines whether groupdict. will be passed to the callback function.
pass_update_queue
bool Optional. Determines whether update_queue will be passed to the callback function.
pass_job_queue
bool Optional. Determines whether job_queue will be passed to the callback function.

Parameters
pattern (str | Pattern) The regex pattern.
callback (callable) A function that takes bot, update as positional argu-
ments. It will be called when the check_update has determined that an update
should be processed 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
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.

1.1. telegram.ext package 31

Python Telegram Bot Documentation, Release 8.0.0

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
type The type of updates this handler should process.
callback
callable The callback function for this handler.
strict
bool Optional. Use type instead of isinstance. Default is False
pass_update_queue
bool Optional. Determines whether update_queue will be passed to the callback function.
pass_job_queue
bool Optional. Determines whether job_queue will be passed to the callback function.

Parameters
type (type) The type of updates this handler should process, as determined by
isinstance
callback (callable) A function that takes bot, update as positional argu-
ments. It will be called when the check_update has determined that an update
should be processed by this handler.
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.
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.

32 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

1.2 telegram.Audio

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

file_size=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents an audio file to be treated as music by the Telegram clients.
file_id
str Unique identifier for this file.
duration
int Duration of the audio in seconds.
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.

1.3 telegram.Bot

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

Bases: telegram.base.TelegramObject
This object represents a Telegram Bot.
Parameters
token (str) Bots 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, optional) Pre initialized telegram.
utils.Request.
addStickerToSet(*args, **kwargs)
Use this method to add a new sticker to a set created by the bot.

1.2. telegram.Audio 33
Python Telegram Bot Documentation, Release 8.0.0

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

add_sticker_to_set(*args, **kwargs)
Use this method to add a new sticker to a set created by the bot.

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

34 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

Raises telegram.TelegramError

answerCallbackQuery(*args, **kwargs)
Use this method to send answers to callback queries sent from inline keyboards. The answer will
be displayed to the user as a notification at the top of the chat screen or as an alert. Alternatively,
the user can be redirected to the specified Game URL. For this option to work, you must first 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 users 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
answerInlineQuery(*args, **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 dont support pagination. Offset length cant 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.

1.3. telegram.Bot 35
Python Telegram Bot Documentation, Release 8.0.0

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

Example

An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account
to adapt search results accordingly. To do this, it displays a Connect your YouTube account button
above the results, or even before showing any. The user presses the button, switches to a private chat
with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link.
Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where
they wanted to use the bots inline capabilities.
Returns bool On success, True is returned.
Raises telegram.TelegramError
answerPreCheckoutQuery(*args, **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.

answerShippingQuery(*args, **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).

36 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

shipping_options (List[telegram.ShippingOption]) Required if ok is

True. A JSON-serialized array of available shipping options.
error_message (str, optional) Required if ok is False. Error message in human
readable form that explains why it is impossible to complete the order (e.g. Sorry,
delivery to your desired address is unavailable). Telegram will display this message
to the user.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns bool; On success, True is returned.
Raises telegram.TelegramError
answer_callback_query(*args, **kwargs)
Use this method to send answers to callback queries sent from inline keyboards. The answer will
be displayed to the user as a notification at the top of the chat screen or as an alert. Alternatively,
the user can be redirected to the specified Game URL. For this option to work, you must first 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 users 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(*args, **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.

1.3. telegram.Bot 37
Python Telegram Bot Documentation, Release 8.0.0

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 dont support pagination. Offset length cant exceed 64 bytes.
switch_pm_text (str, optional) If passed, clients will display a button with
specified text that switches the user to a private chat with the bot and sends the bot a
start message with the parameter switch_pm_parameter.
switch_pm_parameter (str, optional) Deep-linking parameter for the /start
message sent to the bot when user presses the switch button. 1-64 characters, only
A-Z, a-z, 0-9, _ and - are allowed.
timeout (int | float, optional) If this value is specified, use it as he read timeout
from the server (instead of the one specified during creation of the connection pool).
**kwargs (dict) Arbitrary keyword arguments.

Example

An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account
to adapt search results accordingly. To do this, it displays a Connect your YouTube account button
above the results, or even before showing any. The user presses the button, switches to a private chat
with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link.
Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where
they wanted to use the bots inline capabilities.
Returns bool On success, True is returned.
Raises telegram.TelegramError
answer_pre_checkout_query(*args, **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.

38 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

Return type bool

Raises telegram.TelegramError

answer_shipping_query(*args, **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).
shipping_options (List[telegram.ShippingOption]) Required if ok is
True. A JSON-serialized array of available shipping options.
error_message (str, optional) Required if ok is False. Error message in human
readable form that explains why it is impossible to complete the order (e.g. Sorry,
delivery to your desired address is unavailable). Telegram will display this message
to the user.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns bool; On success, True is returned.
Raises telegram.TelegramError
createNewStickerSet(*args, **kwargs)
Use this method to create new sticker set owned by a user.
The bot will be able to edit the created sticker set.

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

1.3. telegram.Bot 39
Python Telegram Bot Documentation, Release 8.0.0

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

create_new_sticker_set(*args, **kwargs)
Use this method to create new sticker set owned by a user.
The bot will be able to edit the created sticker set.

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

Parameters
user_id (int) User identifier of created sticker set owner.
name (str) Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g.,
animals). Can contain only english letters, digits and underscores. Must begin with a
letter, cant contain consecutive underscores and must end in _by_<bot username>.
<bot_username> is case insensitive. 1-64 characters.
title (str) Sticker set title, 1-64 characters.
png_sticker (str | filelike object) Png image with the sticker, must be up to
512 kilobytes in size, dimensions must not exceed 512px, and either width or height
must be exactly 512px. Pass a file_id as a String to send a file that already exists on
the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from
the Internet, or upload a new one using multipart/form-data.
emojis (str) One or more emoji corresponding to the sticker.
contains_masks (bool, optional) Pass True, if a set of mask stickers should be
created.
mask_position (telegram.MaskPosition, optional) Position where the
mask should be placed on faces.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, True is returned.
Return type bool
Raises telegram.TelegramError

deleteChatPhoto(*args, **kwargs)
Use this method to delete a chat photo. Photos cant 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

40 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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

Returns Returns True on success.

Return type bool
Raises telegram.TelegramError

deleteMessage(*args, **kwargs)
Use this method to delete a message. A message can only be deleted if it was sent less than 48
hours ago. Any such recently sent outgoing message may be deleted. Additionally, if the bot is an
administrator in a group chat, it can delete any message. If the bot is an administrator in a supergroup,
it can delete messages from any other user and service messages about people joining or leaving the
group (other types of service messages may only be removed by the group creator). In channels, bots
can only remove their own messages.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
message_id (int) Identifier of the message to delete.
timeout (int | float, optional) If this value is specified, use it as
read timeout (the) from the server (instead of the one specified during creation
of the connection pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, True is returned.
Return type bool
Raises telegram.TelegramError
deleteStickerFromSet(*args, **kwargs)
Use this method to delete a sticker from a set created by the bot.
Parameters
sticker (str) File identifier of the sticker.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, True is returned.
Return type bool
Raises telegram.TelegramError
deleteWebhook(*args, **kwargs)
Use this method to remove webhook integration if you decide to switch back to getUpdates. Requires
no parameters.

1.3. telegram.Bot 41
Python Telegram Bot Documentation, Release 8.0.0

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
delete_chat_photo(*args, **kwargs)
Use this method to delete a chat photo. Photos cant 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
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments

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

Returns Returns True on success.

Return type bool
Raises telegram.TelegramError

delete_message(*args, **kwargs)
Use this method to delete a message. A message can only be deleted if it was sent less than 48
hours ago. Any such recently sent outgoing message may be deleted. Additionally, if the bot is an
administrator in a group chat, it can delete any message. If the bot is an administrator in a supergroup,
it can delete messages from any other user and service messages about people joining or leaving the
group (other types of service messages may only be removed by the group creator). In channels, bots
can only remove their own messages.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
message_id (int) Identifier of the message to delete.
timeout (int | float, optional) If this value is specified, use it as
read timeout (the) from the server (instead of the one specified during creation
of the connection pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, True is returned.
Return type bool
Raises telegram.TelegramError
delete_sticker_from_set(*args, **kwargs)
Use this method to delete a sticker from a set created by the bot.
Parameters

42 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

sticker (str) File identifier of the sticker.

timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, True is returned.
Return type bool
Raises telegram.TelegramError
delete_webhook(*args, **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(*args, **kwargs)
Use this method to edit captions of messages sent by the bot or via the bot (for inline bots).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
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.
caption (str, optional) New caption of the 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, if edited message is sent by the bot, the edited Message is returned,
otherwise True is returned.
Return type telegram.Message
Raises telegram.TelegramError
editMessageReplyMarkup(*args, **kwargs)
Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline
bots).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).

1.3. telegram.Bot 43
Python Telegram Bot Documentation, Release 8.0.0

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.
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, if edited message is sent by the bot, the editedMessage is returned,
otherwise True is returned.
Return type telegram.Message
Raises telegram.TelegramError
editMessageText(*args, **kwargs)
Use this method to edit text and game messages sent by the bot or via the bot (for inline bots).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
message_id (int, optional) Required if inline_message_id is not specified. 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.
text (str) New text of the message.
parse_mode (str) Send Markdown or HTML, if you want Telegram apps to
show bold, italic, fixed-width text or inline URLs in your bots message. See the
constants in telegram.ParseMode for the available modes.
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, 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_caption(*args, **kwargs)
Use this method to edit captions of messages sent by the bot or via the bot (for inline bots).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
message_id (int, optional) Required if inline_message_id is not specified. Iden-
tifier of the sent message.

44 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.
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, 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(*args, **kwargs)
Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline
bots).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
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.
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, if edited message is sent by the bot, the editedMessage is returned,
otherwise True is returned.
Return type telegram.Message
Raises telegram.TelegramError
edit_message_text(*args, **kwargs)
Use this method to edit text and game messages sent by the bot or via the bot (for inline bots).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
message_id (int, optional) Required if inline_message_id is not specified. 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.
text (str) New text of the message.

1.3. telegram.Bot 45
Python Telegram Bot Documentation, Release 8.0.0

parse_mode (str) Send Markdown or HTML, if you want Telegram apps to

show bold, italic, fixed-width text or inline URLs in your bots message. See the
constants in telegram.ParseMode for the available modes.
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, 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(*args, **kwargs)
Use this method to export an invite link to a supergroup or a channel. The bot must be an administrator
in the chat for this to work and must have the appropriate admin rights.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Exported invite link on success.
Return type str
Raises telegram.TelegramError
export_chat_invite_link(*args, **kwargs)
Use this method to export an invite link to a supergroup or a channel. The bot must be an administrator
in the chat for this to work and must have the appropriate admin rights.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Exported invite link on success.
Return type str
Raises telegram.TelegramError
first_name
str Bots first name.
forwardMessage(*args, **kwargs)
Use this method to forward messages of any kind.
Parameters

46 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
from_chat_id (int | str) Unique identifier for the chat where the original
message was sent (or channel username in the format @channelusername).
disable_notification (bool, optional) Sends the message silently. Users
will receive a notification with no sound.
message_id (int) Message identifier in the chat specified in from_chat_id.
timeout (int | float, optional) If this value is specified, use it as
read timeout (the) from the server (instead of the one specified during creation
of the connection pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, the sent Message is returned.
Return type telegram.Message
Raises telegram.TelegramError
forward_message(*args, **kwargs)
Use this method to forward messages of any kind.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
from_chat_id (int | str) Unique identifier for the chat where the original
message was sent (or channel username in the format @channelusername).
disable_notification (bool, optional) Sends the message silently. Users
will receive a notification with no sound.
message_id (int) Message identifier in the chat specified in from_chat_id.
timeout (int | float, optional) If this value is specified, use it as
read timeout (the) from the server (instead of the one specified during creation
of the connection pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, the sent Message is returned.
Return type telegram.Message
Raises telegram.TelegramError
getChat(*args, **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
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns telegram.Chat
Raises telegram.TelegramError

1.3. telegram.Bot 47
Python Telegram Bot Documentation, Release 8.0.0

getChatAdministrators(*args, **kwargs)
Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember
objects that contains information about all chat administrators except other bots. If the chat is a group
or a supergroup and no administrators were appointed, only the creator will be returned.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns List[telegram.ChatMember]
Raises telegram.TelegramError
getChatMember(*args, **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
targetchannel (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
getChatMembersCount(*args, **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
targetchannel (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
getFile(*args, **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 getFile again.
Parameters
file_id (str) File identifier to get info about.

48 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.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 telegram.File
Raises telegram.TelegramError
getGameHighScores(*args, **kwargs)
Use this method to get data for high score tables. Will return the score of the specified user and several
of his neighbors in a game
Parameters
user_id (int) User identifier.
chat_id (int | str, optional) Required if inline_message_id is not specified.
Unique identifier for the target chat.
message_id (int, optional) Required if inline_message_id is not specified. 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
getMe(*args, **kwargs)
A simple method for testing your bots auth token. Requires no parameters.
Parameters timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
Returns A telegram.User instance representing that bot if the credentials are valid,
None otherwise.
Return type telegram.User
Raises telegram.TelegramError
getStickerSet(*args, **kwargs)
Use this method to get a sticker set.
Parameters
name (str) Short name of the sticker set that is used in t.me/addstickers/ URLs
(e.g., animals)
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns telegram.StickerSet
Raises telegram.TelegramError
getUpdates(*args, **kwargs)
Use this method to receive incoming updates using long polling.

1.3. telegram.Bot 49
Python Telegram Bot Documentation, Release 8.0.0

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) List the types of updates you want
your bot to receive. For example, specify [message, edited_channel_post, call-
back_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 up-
dates regardless of type (default). If not specified, the previous setting will be used.
Please note that this parameter doesnt affect updates created before the call to the
get_updates, so unwanted updates may be received for a short period of time.
**kwargs (dict) Arbitrary keyword arguments.

Notes

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

2. In order to avoid getting duplicate updates, recalculate offset after each server response.
3. To take full advantage of this library take a look at telegram.ext.Updater

Returns List[telegram.Update]
Raises telegram.TelegramError

getUserProfilePhotos(*args, **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
getWebhookInfo(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

50 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.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 telegram.WebhookInfo
get_chat(*args, **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
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns telegram.Chat
Raises telegram.TelegramError
get_chat_administrators(*args, **kwargs)
Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember
objects that contains information about all chat administrators except other bots. If the chat is a group
or a supergroup and no administrators were appointed, only the creator will be returned.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns List[telegram.ChatMember]
Raises telegram.TelegramError
get_chat_member(*args, **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
targetchannel (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(*args, **kwargs)
Use this method to get the number of members in a chat
Parameters

1.3. telegram.Bot 51
Python Telegram Bot Documentation, Release 8.0.0

chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns Number of members in the chat.
Return type int
Raises telegram.TelegramError
get_file(*args, **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 getFile again.
Parameters
file_id (str) File identifier to get info 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(*args, **kwargs)
Use this method to get data for high score tables. Will return the score of the specified user and several
of his neighbors in a game
Parameters
user_id (int) User identifier.
chat_id (int | str, optional) Required if inline_message_id is not specified.
Unique identifier for the target chat.
message_id (int, optional) Required if inline_message_id is not specified. 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(*args, **kwargs)
A simple method for testing your bots 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.

52 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

Return type telegram.User

Raises telegram.TelegramError
get_sticker_set(*args, **kwargs)
Use this method to get a sticker set.
Parameters
name (str) Short name of the sticker set that is used in t.me/addstickers/ URLs
(e.g., animals)
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns telegram.StickerSet
Raises telegram.TelegramError
get_updates(*args, **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) List the types of updates you want
your bot to receive. For example, specify [message, edited_channel_post, call-
back_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 up-
dates regardless of type (default). If not specified, the previous setting will be used.
Please note that this parameter doesnt affect updates created before the call to the
get_updates, so unwanted updates may be received for a short period of time.
**kwargs (dict) Arbitrary keyword arguments.

Notes

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

2. In order to avoid getting duplicate updates, recalculate offset after each server response.
3. To take full advantage of this library take a look at telegram.ext.Updater

Returns List[telegram.Update]
Raises telegram.TelegramError

get_user_profile_photos(*args, **kwargs)
Use this method to get a list of profile pictures for a user.
Parameters

1.3. telegram.Bot 53
Python Telegram Bot Documentation, Release 8.0.0

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
int Unique identifier for this bot.
kickChatMember(*args, **kwargs)
Use this method to kick a user from a group or a supergroup. In the case of supergroups, the user will
not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot
must be an administrator in the group for this to work.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
user_id (int) Unique identifier of the target user.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
until_date (int | datetime.datetime, optional) Date when the user will
be unbanned, unix time. If user is banned for more than 366 days or less than 30
seconds from the current time they are considered to be banned forever.
**kwargs (dict) Arbitrary keyword arguments.

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

Returns bool On success, True is returned.

Raises telegram.TelegramError

54 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

kick_chat_member(*args, **kwargs)
Use this method to kick a user from a group or a supergroup. In the case of supergroups, the user will
not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot
must be an administrator in the group for this to work.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
user_id (int) Unique identifier of the target user.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
until_date (int | datetime.datetime, optional) Date when the user will
be unbanned, unix time. If user is banned for more than 366 days or less than 30
seconds from the current time they are considered to be banned forever.
**kwargs (dict) Arbitrary keyword arguments.

Returns bool On success, True is returned.

Raises telegram.TelegramError

1.3. telegram.Bot 55
Python Telegram Bot Documentation, Release 8.0.0

Raises telegram.TelegramError
name
str Bots @username.
pinChatMessage(*args, **kwargs)
Use this method to pin a message in a supergroup. The bot must be an administrator in the chat for
this to work and must have the appropriate admin rights.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
message_id (int) Identifier of a message to pin.
disable_notification (bool, optional) Pass True, if it is not necessary to
send a notification to all group members about the new pinned message.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
pin_chat_message(*args, **kwargs)
Use this method to pin a message in a supergroup. The bot must be an administrator in the chat for
this to work and must have the appropriate admin rights.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
message_id (int) Identifier of a message to pin.
disable_notification (bool, optional) Pass True, if it is not necessary to
send a notification to all group members about the new pinned message.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
promoteChatMember(*args, **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.

56 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

can_post_messages (bool, optional) Pass True, if the administrator can create

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

1.3. telegram.Bot 57
Python Telegram Bot Documentation, Release 8.0.0

can_promote_members (bool, optional) Pass True, if the administrator can

add new administrators with a subset of his own privileges or demote administrators
that he has promoted, directly or indirectly (promoted by administrators that were
appointed by him).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
restrictChatMember(*args, **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.
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.
can_send_messages (bool, optional) Pass True, if the user can send text mes-
sages, contacts, locations and venues.
can_send_media_messages (bool, optional) Pass True, if the user can
send audios, documents, photos, videos, video notes and voice notes, implies
can_send_messages.
can_send_other_messages (bool, optional) Pass 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) Pass True, if the user may
add web page previews to their messages, implies can_send_media_messages.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
restrict_chat_member(*args, **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.
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.

58 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.
can_send_messages (bool, optional) Pass True, if the user can send text mes-
sages, contacts, locations and venues.
can_send_media_messages (bool, optional) Pass True, if the user can
send audios, documents, photos, videos, video notes and voice notes, implies
can_send_messages.
can_send_other_messages (bool, optional) Pass 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) Pass True, if the user may
add web page previews to their messages, implies can_send_media_messages.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
sendAudio(*args, **kwargs)
Use this method to send audio files, if you want Telegram clients to display them in the music player.
Your audio must be in the .mp3 format. On success, the sent Message is returned. Bots can currently
send audio files of up to 50 MB in size, this limit may be changed in the future.
For sending voice messages, use the sendVoice method instead.

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

1.3. telegram.Bot 59
Python Telegram Bot Documentation, Release 8.0.0

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

sendChatAction(*args, **kwargs)
Use this method when you need to tell the user that something is happening on the bots side. The
status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its
typing status).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
action (telegram.ChatAction | str) Type of action to broadcast. Choose
one, depending on what the user is about to receive. For convenience look at the
constants in telegram.ChatAction
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns True on success.
Return type bool
Raises telegram.TelegramError
sendContact(*args, **kwargs)
Use this method to send phone contacts.

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

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) Contacts phone number.
first_name (str, optional) Contacts first name.
last_name (str, optional) Contacts last name.
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).

60 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

**kwargs (dict) Arbitrary keyword arguments.

Returns On success, the sent Message is returned.
Return type telegram.Message
Raises telegram.TelegramError

sendDocument(*args, **kwargs)
Use this method to send general files.

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

Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
document (str | filelike object | telegram.Document) File to send. Pass a
file_id as String to send a file that exists on the Telegram servers (recommended),
pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload
a new one using multipart/form-data. Lastly you can pass an existing telegram.
Document object to send.
filename (str, optional) File name that shows in telegram message (it is useful
when you send file generated by temp module, for example). Undocumented.
caption (str, optional) Document caption (may also be used when resending
documents by file_id), 0-200 characters.
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

sendGame(*args, **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.

1.3. telegram.Bot 61
Python Telegram Bot Documentation, Release 8.0.0

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
sendInvoice(*args, **kwargs)
Use this method to send invoices.
Parameters
chat_id (int | str) Unique identifier for the target private chat.
title (str) Product name.
description (str) Product description.
payload (str) Bot-defined invoice payload, 1-128 bytes. This will not be 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 list of compo-
nents (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).
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 users full name to
complete the order.
need_phone_number (bool, optional) Pass True, if you require the users
phone number to complete the order.
need_email (bool, optional) Pass True, if you require the users email to com-
plete the order.
need_shipping_address (bool, optional) Pass True, if you require the users
shipping address to complete the order.
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.

62 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

reply_markup (telegram.ReplyMarkup, optional) Additional interface op-

tions. An inlinekeyboard. If empty, one Pay total price button will be shown. If not
empty, the first button must be a Pay button.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, the sent Message is returned.
Return type telegram.Message
Raises telegram.TelegramError
sendLocation(*args, **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.
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

sendMessage(*args, **kwargs)
Use this method to send text messages.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
text (str) Text of the message to be sent. Max 4096 characters. Also found as
telegram.constants.MAX_MESSAGE_LENGTH.
parse_mode (str) Send Markdown or HTML, if you want Telegram apps to
show bold, italic, fixed-width text or inline URLs in your bots message. See the
constants in telegram.ParseMode for the available modes.

1.3. telegram.Bot 63
Python Telegram Bot Documentation, Release 8.0.0

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
sendPhoto(*args, **kwargs)
Use this method to send photos.

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

Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
photo (str | filelike object | telegram.PhotoSize) Photo to send. Pass a
file_id as String to send a photo that exists on the Telegram servers (recommended),
pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload
a new photo using multipart/form-data. Lastly you can pass an existing telegram.
PhotoSize object to send.
caption (str, optional) Photo caption (may also be used when resending photos
by file_id), 0-200 characters.
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

64 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

sendSticker(*args, **kwargs)
Use this method to send .webp stickers.

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

Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
sticker (str | filelike object telegram.Sticker) Sticker to send. Pass a
file_id as String to send a file that exists on the Telegram servers (recommended), pass
an HTTP URL as a String for Telegram to get a .webp file from the Internet, or upload
a new one using multipart/form-data. Lastly you can pass an existing telegram.
Sticker object to send.
disable_notification (bool, optional) Sends the message silently. Users
will receive a notification with no sound.
reply_to_message_id (int, optional) If the message is a reply, ID of the
original message.
reply_markup (telegram.ReplyMarkup, optional) Additional interface 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

sendVenue(*args, **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.

1.3. telegram.Bot 65
Python Telegram Bot Documentation, Release 8.0.0

reply_markup (telegram.ReplyMarkup, optional) Additional interface op-

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

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

Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
video (str | filelike object | telegram.Video) Video file to send. Pass a file_id
as String to send an video file that exists on the Telegram servers (recommended), pass
an HTTP URL as a String for Telegram to get an video file from the Internet, or upload
a new one using multipart/form-data. Lastly you can pass an existing telegram.
Video object to send.
duration (int, optional) Duration of sent video in seconds.
width (int, optional) Video width.
height (int, optional) Video height.
caption (str, optional) Video caption (may also be used when resending videos
by file_id), 0-200 characters.
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

sendVideoNote(*args, **kwargs)
Use this method to send video messages.

66 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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

Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
video_note (str | filelike object | telegram.VideoNote) Video note to
send. Pass a file_id as String to send a video note that exists on the Telegram servers
(recommended) or upload a new video using multipart/form-data. Or you can pass an
existing telegram.VideoNote object to send. Sending video notes by a URL is
currently unsupported.
duration (int, optional) Duration of sent video in seconds.
length (int, optional) Video width and height
disable_notification (bool, optional) Sends the message silently. Users
will receive a notification with no sound.
reply_to_message_id (int, optional) If the message is a reply, ID of the
original message.
reply_markup (telegram.ReplyMarkup, optional) Additional interface 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

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

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

1.3. telegram.Bot 67
Python Telegram Bot Documentation, Release 8.0.0

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(*args, **kwargs)
Use this method to send audio files, if you want Telegram clients to display them in the music player.
Your audio must be in the .mp3 format. On success, the sent Message is returned. Bots can currently
send audio files of up to 50 MB in size, this limit may be changed in the future.
For sending voice messages, use the sendVoice method instead.

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

68 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

send_chat_action(*args, **kwargs)
Use this method when you need to tell the user that something is happening on the bots side. The
status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its
typing status).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
action (telegram.ChatAction | str) Type of action to broadcast. Choose
one, depending on what the user is about to receive. For convenience look at the
constants in telegram.ChatAction
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns True on success.
Return type bool
Raises telegram.TelegramError
send_contact(*args, **kwargs)
Use this method to send phone contacts.

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

1.3. telegram.Bot 69
Python Telegram Bot Documentation, Release 8.0.0

send_document(*args, **kwargs)
Use this method to send general files.

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

send_game(*args, **kwargs)
Use this method to send a game.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
game_short_name (str) Short name of the game, serves as the unique identifier
for the game. Set up your games via Botfather.
disable_notification (bool, optional) Sends the message silently. Users
will receive a notification with no sound.
reply_to_message_id (int, optional) If the message is a reply, ID of the
original message.
reply_markup (telegram.ReplyMarkup, optional) Additional interface 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.

70 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.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 On success, the sent Message is returned.
Return type telegram.Message
Raises telegram.TelegramError
send_invoice(*args, **kwargs)
Use this method to send invoices.
Parameters
chat_id (int | str) Unique identifier for the target private chat.
title (str) Product name.
description (str) Product description.
payload (str) Bot-defined invoice payload, 1-128 bytes. This will not be 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 list of compo-
nents (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).
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 users full name to
complete the order.
need_phone_number (bool, optional) Pass True, if you require the users
phone number to complete the order.
need_email (bool, optional) Pass True, if you require the users email to com-
plete the order.
need_shipping_address (bool, optional) Pass True, if you require the users
shipping address to complete the order.
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.ReplyMarkup, optional) Additional interface op-
tions. An inlinekeyboard. If empty, one Pay total price button will be shown. If not
empty, the first button must be a Pay button.

1.3. telegram.Bot 71
Python Telegram Bot Documentation, Release 8.0.0

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

send_message(*args, **kwargs)
Use this method to send text messages.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
text (str) Text of the message to be sent. Max 4096 characters. Also found as
telegram.constants.MAX_MESSAGE_LENGTH.
parse_mode (str) Send Markdown or HTML, if you want Telegram apps to
show bold, italic, fixed-width text or inline URLs in your bots 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.

72 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

disable_notification (bool, optional) Sends the message silently. Users

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

send_sticker(*args, **kwargs)
Use this method to send .webp stickers.

1.3. telegram.Bot 73
Python Telegram Bot Documentation, Release 8.0.0

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

send_venue(*args, **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.

74 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

reply_markup (telegram.ReplyMarkup, optional) Additional interface op-

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

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

send_video_note(*args, **kwargs)
Use this method to send video messages.

1.3. telegram.Bot 75
Python Telegram Bot Documentation, Release 8.0.0

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

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

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

76 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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

setChatDescription(*args, **kwargs)
Use this method to change the description of a supergroup or a channel. The bot must be an adminis-
trator 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
targetchannel (in the format @channelusername).
description (str) New chat description, 1-255 characters.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
setChatPhoto(*args, **kwargs)
Use this method to set a new profile photo for the chat.
Photos cant 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
targetchannel (in the format @channelusername).
photo (telegram.InputFile) New chat photo.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments

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

Returns Returns True on success.

Return type bool
Raises telegram.TelegramError

1.3. telegram.Bot 77
Python Telegram Bot Documentation, Release 8.0.0

setChatTitle(*args, **kwargs)
Use this method to change the title of a chat. Titles cant 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
targetchannel (in the format @channelusername).
title (str) New chat title, 1-255 characters.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments

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

Returns Returns True on success.

Return type bool
Raises telegram.TelegramError

setGameScore(*args, **kwargs)
Use this method to set the score of the specified user in a game. On success, if the message was sent
by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is
not greater than the users current score in the chat and force is False.
Parameters
user_id (int) User identifier.
score (int) New score, must be non-negative.
force (bool, optional) Pass True, if the high score is allowed to decrease. This
can be useful when fixing mistakes or banning cheaters
disable_edit_message (bool, optional) Pass True, if the game message
should not be automatically edited to include the current scoreboard.
chat_id (int|str, optional) Required if inline_message_id is not speci-
fied. 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 wasnt sent by the bot , True.
Return type telegram.Message
Raises
telegram.TelegramError If the new score is not greater than the users
current score in the chat and force is False.

78 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

setStickerPositionInSet(*args, **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
setWebhook(*args, **kwargs)
Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever
there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a
JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount
of attempts.
If youd like to make sure that the Webhook request comes from Telegram, we recommend using a
secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bots
token, you can be pretty sure its 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 bots server, and higher values to increase your
bots throughput.
allowed_updates (List[str], optional) List the types of updates you want
your bot to receive. For example, specify [message, edited_channel_post, call-
back_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 up-
dates regardless of type (default). If not specified, the previous setting will be used.
Please note that this parameter doesnt 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.3. telegram.Bot 79
Python Telegram Bot Documentation, Release 8.0.0

1. You will not be able to receive updates using get_updates for as long as an outgoing webhook is
set up.
2. To use a self-signed certificate, you need to upload your public key certificate using certificate
parameter. Please upload as InputFile, sending a String will not work.
3. Ports currently supported for Webhooks: 443, 80, 88, 8443.

Returns bool On success, True is returned.

Raises telegram.TelegramError

set_chat_description(*args, **kwargs)
Use this method to change the description of a supergroup or a channel. The bot must be an adminis-
trator 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
targetchannel (in the format @channelusername).
description (str) New chat description, 1-255 characters.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
set_chat_photo(*args, **kwargs)
Use this method to set a new profile photo for the chat.
Photos cant 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
targetchannel (in the format @channelusername).
photo (telegram.InputFile) New chat photo.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments

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

Returns Returns True on success.

Return type bool
Raises telegram.TelegramError

set_chat_title(*args, **kwargs)
Use this method to change the title of a chat. Titles cant 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.

80 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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

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

Returns Returns True on success.

Return type bool
Raises telegram.TelegramError

set_game_score(*args, **kwargs)
Use this method to set the score of the specified user in a game. On success, if the message was sent
by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is
not greater than the users current score in the chat and force is False.
Parameters
user_id (int) User identifier.
score (int) New score, must be non-negative.
force (bool, optional) Pass True, if the high score is allowed to decrease. This
can be useful when fixing mistakes or banning cheaters
disable_edit_message (bool, optional) Pass True, if the game message
should not be automatically edited to include the current scoreboard.
chat_id (int|str, optional) Required if inline_message_id is not speci-
fied. 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 wasnt sent by the bot , True.
Return type telegram.Message
Raises
telegram.TelegramError If the new score is not greater than the users
current score in the chat and force is False.
set_sticker_position_in_set(*args, **kwargs)
Use this method to move a sticker in a set created by the bot to a specific position.
Parameters

1.3. telegram.Bot 81
Python Telegram Bot Documentation, Release 8.0.0

sticker (str) File identifier of the sticker.

position (int) New sticker position in the set, zero-based.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, True is returned.
Return type bool
Raises telegram.TelegramError
set_webhook(*args, **kwargs)
Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever
there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a
JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount
of attempts.
If youd like to make sure that the Webhook request comes from Telegram, we recommend using a
secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bots
token, you can be pretty sure its us.

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

Note:
1. You will not be able to receive updates using get_updates for as long as an outgoing webhook is
set up.
2. To use a self-signed certificate, you need to upload your public key certificate using certificate
parameter. Please upload as InputFile, sending a String will not work.

82 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

3. Ports currently supported for Webhooks: 443, 80, 88, 8443.

Returns bool On success, True is returned.

Raises telegram.TelegramError

unbanChatMember(*args, **kwargs)
Use this method to unban a previously kicked user in a supergroup.
The user will not return to the group automatically, but will be able to join via link, etc. The bot must
be an administrator in the group for this to work.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
user_id (int) Unique identifier of the target user.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns bool On success, True is returned.
Raises telegram.TelegramError
unban_chat_member(*args, **kwargs)
Use this method to unban a previously kicked user in a supergroup.
The user will not return to the group automatically, but will be able to join via link, etc. The bot must
be an administrator in the group for this to work.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
user_id (int) Unique identifier of the target user.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns bool On success, True is returned.
Raises telegram.TelegramError
unpinChatMessage(*args, **kwargs)
Use this method to unpin a message in a supergroup. The bot must be an administrator in the chat for
this to work and must have the appropriate admin rights.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool

1.3. telegram.Bot 83
Python Telegram Bot Documentation, Release 8.0.0

Raises telegram.TelegramError
unpin_chat_message(*args, **kwargs)
Use this method to unpin a message in a supergroup. The bot must be an administrator in the chat for
this to work and must have the appropriate admin rights.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
uploadStickerFile(*args, **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')

upload_sticker_file(*args, **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')

84 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

username
str Bots username.

1.4 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.
Exactly one of the fields data or game_short_name will be present.

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

Parameters
id (str) Unique identifier for this query.
from_user (telegram.User) Sender.

1.4. telegram.CallbackQuery 85
Python Telegram Bot Documentation, Release 8.0.0

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.
inline_message_id (str, optional) Identifier of the message sent via the bot in
inline mode, that originated the query.
chat_instance (str, optional) Global identifier, uniquely corresponding to the
chat to which the message with the callback button was sent. Useful for high scores in
games.
data (str, optional) Data associated with the callback button. Be aware that a bad
client can send arbitrary data in this field.
game_short_name (str, optional) Short name of a Game to be returned, serves
as the unique identifier for the game

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(*args, **kwargs)
Shortcut for either:
bot.edit_message_caption(chat_id=update.callback_query.message.chat_id,
message_id=update.callback_query.message.message_id,
*args, **kwargs)

or:
bot.edit_message_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(*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,

*args, **kwargs)

or:
bot.edit_message_reply_markup(inline_message_id=update.callback_query.
inline_message_id,

*args, **kwargs)

86 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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(*args, **kwargs)
Shortcut for either:

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

or:

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

1.5 telegram.Chat

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

all_members_are_administrators=None, bot=None, photo=None, descrip-
tion=None, invite_link=None, pinned_message=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a chat.
id
int Unique identifier for this chat.
type
str Type of chat.
title
str Optional. Title, for supergroups, channels and group chats.
username
str Optional. Username.
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.
all_members_are_administrators
bool Optional.
photo
telegram.ChatPhoto Optional. Chat photo.
description
str Optional. Description, for supergroups and channel chats.
invite_link
str Optional. Chat invite link, for supergroups and channel chats.

1.5. telegram.Chat 87
Python Telegram Bot Documentation, Release 8.0.0

pinned_message
telegram.Message Optional. Pinned message, for supergroups. Returned only in get_chat.

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.
all_members_are_administrators (bool, optional) True if a group has All
Members Are Admins enabled.
photo (telegram.ChatPhoto, optional) Chat photo. Returned only in getChat.
description (str, optional) Description, for supergroups and channel chats. Re-
turned 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.
bot (telegram.Bot, optional) The Bot to use for instance methods.
**kwargs (dict) Arbitrary keyword arguments.

CHANNEL = 'channel'
str channel
GROUP = 'group'
str group
PRIVATE = 'private'
str private
SUPERGROUP = 'supergroup'
str supergroup
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:

88 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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 groups creator or by the member that added them.

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

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

Returns bool If the action was sent successfully.

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

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

1.6 telegram.ChatAction

class telegram.ChatAction
Bases: object
Helper class to provide constants for different chatactions.

1.6. telegram.ChatAction 89
Python Telegram Bot Documentation, Release 8.0.0

FIND_LOCATION = 'find_location'
str find_location
RECORD_AUDIO = 'record_audio'
str record_audio
RECORD_VIDEO = 'record_video'
str record_video
RECORD_VIDEO_NOTE = 'record_video_note'
str record_video_note
TYPING = 'typing'
str typing
UPLOAD_AUDIO = 'upload_audio'
str upload_audio
UPLOAD_DOCUMENT = 'upload_document'
str upload_document
UPLOAD_PHOTO = 'upload_photo'
str upload_photo
UPLOAD_VIDEO = 'upload_video'
str upload_video
UPLOAD_VIDEO_NOTE = 'upload_video_note'
str upload_video_note

1.7 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_other_messages=None, can_add_web_page_previews=None,
**kwargs)
Bases: telegram.base.TelegramObject
This object contains information about one member of the chat.
user
telegram.User Information about the user.
status
str The members status in the chat.
until_date
datetime.datetime Optional. Date when restrictions will be lifted for this user.
can_be_edited
bool Optional. If the bot is allowed to edit administrator privileges of that user.
can_change_info
bool Optional. If the administrator can change the chat title, photo and other settings.
can_post_messages
bool Optional. If the administrator can post in the channel.
can_edit_messages
bool Optional. If the administrator can edit messages of other users.

90 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

can_delete_messages
bool Optional. If the administrator can delete messages of other users.
can_invite_users
bool Optional. If the administrator can invite new users to the chat.
can_restrict_members
bool Optional. If the administrator can restrict, ban or unban chat members.
can_pin_messages
bool Optional. If the administrator can pin messages.
can_promote_members
bool Optional. If the administrator can add new administrators.
can_send_messages
bool Optional. If the user can send text messages, contacts, locations and venues.
can_send_media_messages
bool Optional. If the user can send media messages, implies can_send_messages.
can_send_other_messages
bool Optional. If the user can send animations, games, stickers and use inline bots, implies
can_send_media_messages.
can_add_web_page_previews
bool Optional. If user may add web page previews to his messages, implies
can_send_media_messages

Parameters
user (telegram.User) Information about the user.
status (str) The members status in the chat. Can be creator, administrator,
member, restricted, left or kicked.
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 only. True, if the administra-
tor can change the chat title, photo and other settings.
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 only. True, if the adminis-
trator 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 only. True, if the adminis-
trator 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).

1.7. telegram.ChatMember 91
Python Telegram Bot Documentation, Release 8.0.0

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_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'
str administrator
CREATOR = 'creator'
str creator
KICKED = 'kicked'
str kicked
LEFT = 'left'
str left
MEMBER = 'member'
str member
RESTRICTED = 'restricted'
str restricted

1.8 telegram.ChatPhoto

class telegram.ChatPhoto(small_file_id, big_file_id, bot=None, **kwargs)

Bases: telegram.base.TelegramObject
This object represents a chat photo.
small_file_id
str Unique file identifier of small (160x160) chat photo.
big_file_id
str Unique file identifier of big (640x640) chat photo.

Parameters
small_file_id (str) Unique file identifier of small (160x160) chat photo. This
file_id can be used only for photo download.
big_file_id (str) Unique file identifier of big (640x640) chat photo. This file_id
can be used only for photo download.
bot (telegram.Bot, optional) The Bot to use for instance methods
**kwargs (dict) Arbitrary keyword arguments.

1.9 telegram.constants Module

Constants in the Telegram network.

The following constants were extracted from the Telegram Bots FAQ.

92 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

telegram.constants.MAX_MESSAGE_LENGTH
int 4096
telegram.constants.MAX_CAPTION_LENGTH
int 200
telegram.constants.SUPPORTED_WEBHOOK_PORTS
List[int] [443, 80, 88, 8443]
telegram.constants.MAX_FILESIZE_DOWNLOAD
int In bytes (20MB)
telegram.constants.MAX_FILESIZE_UPLOAD
int In bytes (50MB)
telegram.constants.MAX_MESSAGES_PER_SECOND_PER_CHAT
int 1. Telegram may allow short bursts that go over this limit, but eventually youll begin receiving 429
errors.
telegram.constants.MAX_MESSAGES_PER_SECOND
int 30
telegram.constants.MAX_MESSAGES_PER_MINUTE_PER_GROUP
int 20
telegram.constants.MAX_INLINE_QUERY_RESULTS
int 50
The following constant have been found by experimentation:
telegram.constants.MAX_MESSAGE_ENTITIES
int 100 (Beyond this cap telegram will simply ignore further formatting styles)

1.10 telegram.Contact

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

**kwargs)
Bases: telegram.base.TelegramObject
This object represents a phone contact.
phone_number
str Contacts phone number.
first_name
str Contacts first name.
last_name
str Optional. Contacts last name.
user_id
int Optional. Contacts user identifier in Telegram.

1.10. telegram.Contact 93
Python Telegram Bot Documentation, Release 8.0.0

1.11 telegram.Document

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

file_size=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a general file (as opposed to photos, voice messages and audio files).
file_id
str Unique file identifier.
thumb
telegram.PhotoSize Optional. Document thumbnail.
file_name
str Original filename.
mime_type
str Optional. MIME type of the file.
file_size
int Optional. File size.

1.12 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.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: exceptions.Exception
exception telegram.error.TimedOut
Bases: telegram.error.NetworkError

94 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

exception telegram.error.Unauthorized(message)
Bases: telegram.error.TelegramError

1.13 telegram.File

class telegram.File(file_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
str Unique identifier for this file.
file_size
str Optional. File size.
file_path
str Optional. File path. Use download to get the file.

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

1.13. telegram.File 95
Python Telegram Bot Documentation, Release 8.0.0

1.14 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 bots 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
True Shows reply interface to the user.
selective
bool Optional. Force reply from specific users only.

1.15 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, **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
str Label text on the button.
url
str Optional. HTTP url to be opened when button is pressed.
callback_data
str Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes.
switch_inline_query
str Optional. Will prompt the user to select one of their chats, open that chat and insert the bots
username and the specified inline query in the input field.
switch_inline_query_current_chat
str Optional. Will insert the bots username and the specified inline query in the current chats
input field.
callback_game
telegram.CallbackGame Optional. Description of the game that will be launched when the
user presses the button.

96 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

pay
bool Optional. Specify True, to send a Pay button.

Parameters
text (str) Label text on the button.
url (str) HTTP url to be opened when button is pressed.
callback_data (str, optional) Data to be sent in a callback query to the bot
when button is pressed, 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 bots username and
the specified inline query in the input field. Can be empty, in which case just the bots
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 bots username and the specified inline query in the current chats
input field. Can be empty, in which case only the bots 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.

1.16 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
List[List[telegram.InlineKeyboardButton]] Array of button rows, each represented by an
Array of InlineKeyboardButton objects.

1.17 telegram.InputFile

class telegram.InputFile(data)
Bases: object
This object represents a Telegram InputFile.
data
dict Data containing an inputfile.

1.16. telegram.InlineKeyboardMarkup 97
Python Telegram Bot Documentation, Release 8.0.0

Parameters data (dict) Data containing an inputfile.

Raises TelegramError

content_type
str Content type
headers
dict Headers.
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
static is_inputfile(data)
Check if the request is a file request.
Parameters data (Dict[str, str]) A dict of (str, str) key/value pairs.
Returns bool
to_form()
Transform the inputfile to multipart/form data.
Returns str

1.18 telegram.KeyboardButton

class telegram.KeyboardButton(text, request_contact=None, request_location=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.

Note: Optional fields are mutually exclusive.

text
str Text of the button.
request_contact
bool Optional. If the users phone number will be sent.
request_location
bool Optional. If the users current location will be sent.

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 users 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 users current location will be
sent when the button is pressed. Available in private chats only.

98 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

Note: request_contact and request_location options will only work in Telegram versions
released after 9 April, 2016. Older clients will ignore them.

1.19 telegram.Location

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

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

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

1.20 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, audio=None, document=None,
game=None, photo=None, sticker=None, video=None, voice=None,
video_note=None, new_chat_members=None, caption=None, con-
tact=None, location=None, venue=None, new_chat_member=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, mi-
grate_from_chat_id=None, pinned_message=None, invoice=None,
successful_payment=None, forward_signature=None, au-
thor_signature=None, 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
int Unique message identifier inside this chat.
from_user
telegram.User Optional. Sender.
date
datetime.datetime Date the message was sent.

1.19. telegram.Location 99
Python Telegram Bot Documentation, Release 8.0.0

chat
telegram.Chat Conversation the message belongs to.
forward_from
telegram.User Optional. Sender of the original message.
forward_from_chat
telegram.Chat Optional. Information about the original channel.
forward_from_message_id
int Optional. Identifier of the original message in the channel.
forward_date
datetime.datetime Optional. Date the original message was sent.
reply_to_message
telegram.Message Optional. The original message.
edit_date
datetime.datetime Optional. Date the message was last edited.
text
str Optional. The actual UTF-8 text of the message.
entities
List[telegram.MessageEntity] Optional. Special entities like usernames, URLs, bot com-
mands, etc. that appear in the text. See Message.parse_entity and parse_entities meth-
ods for how to use properly.
audio
telegram.Audio Optional. Information about the file.
document
telegram.Document Optional. Information about the file.
game
telegram.Game Optional. Information about the game.
photo
List[telegram.PhotoSize] Optional. Available sizes of the photo.
sticker
telegram.Sticker Optional. Information about the sticker.
video
telegram.Video Optional. Information about the video.
voice
telegram.Voice Optional. Information about the file.
video_note
telegram.VideoNote Optional. Information about the video message.
new_chat_members
List[telegram.User] Optional. Information about new members to the chat. (the bot itself may
be one of these members).
caption
str Optional. Caption for the document, photo or video, 0-200 characters.
contact
telegram.Contact Optional. Information about the contact.
location
telegram.Location Optional. Information about the location.
venue
telegram.Venue Optional. Information about the venue.

100 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

left_chat_member
telegram.User Optional. Information about the user that left the group. (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 changed to this value.
delete_chat_photo
bool Optional. The chat photo was deleted.
group_chat_created
bool Optional. The group has been created.
supergroup_chat_created
bool Optional. The supergroup has been created.
channel_chat_created
bool Optional. The channel has been created.
migrate_to_chat_id
int Optional. The group has been migrated to a supergroup with the specified identifier.
migrate_from_chat_id
int Optional. The supergroup has been migrated from a group with the specified identifier.
pinned_message
telegram.message Optional. Specified message was pinned.
invoice
telegram.Invoice Optional. Information about the invoice.
successful_payment
telegram.SuccessfulPayment Optional. Information about the payment.
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.
bot
telegram.Bot Optional. The Bot to use for instance methods.

Deprecated: 6.0 new_chat_member (telegram.User): Replaced with new_chat_members

1.20. telegram.Message 101

Python Telegram Bot Documentation, Release 8.0.0

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.
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.
audio (telegram.Audio, optional) Message is an audio file, information about
the file.
document (telegram.Document, optional) Message is a general file, informa-
tion about the file.
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-200 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.

102 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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 cant be received in a message coming through
updates, because bot cant 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 cant be received in a message coming through updates, be-
cause bot cant 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
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
attr: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.
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.

chat_id
int Shortcut for telegram.Chat.id for chat.
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)

1.20. telegram.Message 103

Python Telegram Bot Documentation, Release 8.0.0

Note: You can only edit messages that the bot sent itself, therefore this method can only be used on
the return value of the bot.send_* family of methods.

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, therefore this method can only be used on
the return value of the bot.send_* family of methods.

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, therefore this method can only be used on
the return value of the bot.send_* family of methods..

Returns On success, instance representing the edited message.

Return type telegram.Message

effective_attachment
telegram.Audio or telegram.Contact or telegram.Document 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, disable_notification=False)
Shortcut for:

bot.forward_message(chat_id=chat_id,
from_chat_id=update.message.chat_id,
disable_notification=disable_notification,
message_id=update.message.message_id)

Returns On success, instance representing the message forwarded.

Return type telegram.Message

104 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

new_chat_member
Deprecated
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 dont handle automatically. (That is, you cant just slice
Message.text with the offset and length.)

Parameters
entity (telegram.MessageEntity) The entity to extract the text from. It
must
an entity that belongs to this message. (be)
Returns The text of the given entity
Return type str

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

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

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

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

1.20. telegram.Message 105

Python Telegram Bot Documentation, Release 8.0.0

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

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

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

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

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

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

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

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

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

106 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.

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

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

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

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

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

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

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

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

1.20. telegram.Message 107

Python Telegram Bot Documentation, Release 8.0.0

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

1.21 telegram.MessageEntity

class telegram.MessageEntity(type, offset, length, url=None, user=None, **kwargs)

Bases: telegram.base.TelegramObject
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
type
str Type of the entity.
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. Url that will be opened after user taps on the text.
user
telegram.User Optional. The mentioned user.

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

108 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.

ALL_TYPES = ['mention', 'hashtag', 'bot_command', 'url', 'email', 'bold', 'italic',

List[str] List of all the types.
BOLD = 'bold'
str bold
BOT_COMMAND = 'bot_command'
str bot_command
CODE = 'code'
str code
EMAIL = 'email'
str email
HASHTAG = 'hashtag'
str hashtag
ITALIC = 'italic'
str italic
MENTION = 'mention'
str mention
PRE = 'pre'
str pre
TEXT_LINK = 'text_link'
str text_link
TEXT_MENTION = 'text_mention'
str text_mention
URL = 'url'
str url

1.22 telegram.ParseMode
class telegram.ParseMode
Bases: object
This object represents a Telegram Message Parse Modes.
HTML = 'HTML'
str HTML
MARKDOWN = 'Markdown'
str Markdown

1.22. telegram.ParseMode 109

Python Telegram Bot Documentation, Release 8.0.0

1.23 telegram.PhotoSize

class telegram.PhotoSize(file_id, width, height, file_size=None, **kwargs)

Bases: telegram.base.TelegramObject
This object represents one size of a photo or a file/sticker thumbnail.
file_id
str Unique identifier for this file.
width
int Photo width.
height
int Photo height.
file_size
int Optional. File size.

Parameters
file_id (str) Unique identifier for this file.
width (int) Photo width.
height (int) Photo height.
file_size (int, optional) File size.
**kwargs (dict) Arbitrary keyword arguments.

1.24 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
True Requests clients to remove the custom keyboard.
selective
bool Optional. Use this parameter if you want to remove the keyboard for specific users only.

Example

110 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

1.25 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
List[List[telegram.KeyboardButton | str]] Array of button rows.
resize_keyboard
bool Optional. Requests clients to resize the keyboard.
one_time_keyboard
bool Optional. Requests clients to hide the keyboard as soon as its been used.
selective
bool Optional. Show the keyboard to specific users only.

Example

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

1.25. telegram.ReplyKeyboardMarkup 111

Python Telegram Bot Documentation, Release 8.0.0

1.27 telegram.TelegramObject

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

1.28 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, **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
int The updates unique identifier.
message
telegram.Message Optional. New incoming message.
edited_message
telegram.Message Optional. New version of a message.
channel_post
telegram.Message Optional. New incoming channel post.
edited_channel_post
telegram.Message Optional. New version of a channel post.
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.
callback_query
telegram.CallbackQuery Optional. New incoming callback query.
shipping_query
telegram.ShippingQuery Optional. New incoming shipping query.
pre_checkout_query
telegram.PreCheckoutQuery Optional. New incoming pre-checkout query.

112 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.
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
**kwargs (dict) Arbitrary keyword arguments.

classmethod de_json(data, bot)

effective_chat
telegram.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 and pre_checkout_query.
effective_message
telegram.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 and pre_checkout_query.
effective_user
telegram.User The user that sent this update, no matter what kind of update this is. Will be
None for channel_post.

1.29 telegram.User

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

guage_code=None, bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a Telegram user or bot.
id
int Unique identifier for this user or bot.
is_bot
bool True, if this user is a bot
first_name
str Users or bots first name.
last_name
str Optional. Users or bots last name.

1.29. telegram.User 113

Python Telegram Bot Documentation, Release 8.0.0

username
str Optional. Users or bots last name.
language_code
str Optional. IETF language tag of the users language.
bot
telegram.Bot Optional. The Bot to use for instance methods.

Parameters
id (int) Unique identifier for this user or bot.
is_bot (bool) True, if this user is a bot
first_name (str) Users or bots first name.
last_name (str, optional) Users or bots last name.
username (str, optional) Users or bots username.
language_code (str, optional) IETF language tag of the users language.
bot (telegram.Bot, optional) The Bot to use for instance methods.

classmethod de_json(data, bot)

classmethod de_list(data, bot)
get_profile_photos(*args, **kwargs)
Shortcut for:

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

mention_html(name=None)
Parameters name (str) If provided, will overwrite the users name.
Returns The inline mention for the user as HTML.
Return type str
mention_markdown(name=None)
Parameters name (str) If provided, will overwrite the users name.
Returns The inline mention for the user as markdown.
Return type str
name
str The users username if available, if not it returns the first name and if present first_name
and last_name.

1.30 telegram.UserProfilePhotos

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

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

Parameters

114 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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

1.31 telegram.Venue

class telegram.Venue(location, title, address, foursquare_id=None, **kwargs)

Bases: telegram.base.TelegramObject
This object represents a venue.
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.

1.32 telegram.Video

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

file_size=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a video file.
file_id
str Unique identifier for this file.
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.

1.31. telegram.Venue 115

Python Telegram Bot Documentation, Release 8.0.0

1.33 telegram.VideoNote

class telegram.VideoNote(file_id, length, duration, thumb=None, file_size=None, **kwargs)

Bases: telegram.base.TelegramObject
This object represents a video message (available in Telegram apps as of v.4.0).
file_id
str Unique identifier for this file.
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.

1.34 telegram.Voice

class telegram.Voice(file_id, duration, mime_type=None, file_size=None, **kwargs)

Bases: telegram.base.TelegramObject
This object represents a voice note.
file_id
str Unique identifier for this file.
duration
int Duration of the audio in seconds as defined by sender.

116 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

mime_type
str Optional. MIME type of the file as defined by sender.
file_size
int Optional. File size.

Parameters
file_id (str) Unique identifier for this file.
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.
**kwargs (dict) Arbitrary keyword arguments.

1.35 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
str Webhook URL.
has_custom_certificate
bool If a custom certificate was provided for webhook.
pending_update_count
int Number of updates awaiting delivery.
last_error_date
int Optional. Unix time for the most recent error that happened.
last_error_message
str Optional. Error message in human-readable format.
max_connections
int Optional. Maximum allowed number of simultaneous HTTPS connections.
allowed_updates
List[str] Optional. A list of update types the bot is subscribed to.

1.35. telegram.WebhookInfo 117

Python Telegram Bot Documentation, Release 8.0.0

allowed_updates (List[str], optional) A list of update types the bot is sub-

scribed to. Defaults to all update types.

1.36 Stickers

1.36.1 telegram.Sticker

class telegram.Sticker(file_id, width, height, thumb=None, emoji=None, file_size=None,

set_name=None, mask_position=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a sticker.
file_id
str Unique identifier for this file.
width
int Sticker width.
height
int Sticker height.
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.

1.36.2 telegram.StickerSet

class telegram.StickerSet(name, title, contains_masks, stickers, bot=None, **kwargs)

Bases: telegram.base.TelegramObject

118 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

This object represents a sticker set.

name
str Sticker set name.
title
str Sticker set title.
contains_masks
bool True, if the sticker set contains masks.
stickers
List[telegram.Sticker] List of all set stickers.

Parameters
name (str) Sticker set name.
title (str) Sticker set title.
contains_masks (bool) True, if the sticker set contains masks.
stickers (List[telegram.Sticker]) List of all set stickers.

1.36.3 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
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.
y_shift
float Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom.
scale
float Mask scaling coefficient. For example, 2.0 means double size.

Notes

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'
str chin

1.36. Stickers 119

Python Telegram Bot Documentation, Release 8.0.0

EYES = 'eyes'
str eyes
FOREHEAD = 'forehead'
str forehead
MOUTH = 'mouth'
str mouth

1.37 Inline Mode

1.37.1 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
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 512 characters).
offset
str Offset of the results to be returned, can be controlled by the bot.

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

120 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

results (List[telegram.InlineQueryResult]) A list of results for the

inline query.
cache_time (int, optional) The maximum amount of time in seconds that the
result of the inline query may be cached on the server. Defaults to 300.
is_personal (bool, optional) Pass True, if results may be cached on the server
side only for the user that sent the query. By default, results may be returned to any
user who sends the same query.
next_offset (str, optional) Pass the offset that a client should send in the next
query with the same text to receive more results. Pass an empty string if there are no
more results or if you dont support pagination. Offset length cant 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.

1.37.2 telegram.InlineQueryResult

class telegram.InlineQueryResult(type, id, **kwargs)

Bases: telegram.base.TelegramObject
Baseclass for the InlineQueryResult* classes.
type
str Type of the result.
id
str Unique identifier for this result, 1-64 Bytes.

Parameters
type (str) Type of the result.
id (str) Unique identifier for this result, 1-64 Bytes.
**kwargs (dict) Arbitrary keyword arguments.

1.37.3 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
str article.
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.

1.37. Inline Mode 121

Python Telegram Bot Documentation, Release 8.0.0

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

1.37.4 telegram.InlineQueryResultAudio

class telegram.InlineQueryResultAudio(id, audio_url, title, performer=None,

audio_duration=None, cap-
tion=None, reply_markup=None, in-
put_message_content=None, **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
str audio.
id
str Unique identifier for this result, 1-64 bytes.
audio_url
str A valid URL for the audio file.

122 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

title
str Title.
performer
str Optional. Caption, 0-200 characters.
audio_duration
str Optional. Performer.
caption
str Optional. Audio duration in seconds.
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
audio.

1.37.5 telegram.InlineQueryResultCachedAudio

class telegram.InlineQueryResultCachedAudio(id, audio_file_id, caption=None,

reply_markup=None, in-
put_message_content=None, **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 amessage with the specified
content instead of the audio.
type
str audio.
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-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.

1.37. Inline Mode 123

Python Telegram Bot Documentation, Release 8.0.0

input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
audio.

1.37.6 telegram.InlineQueryResultCachedDocument

class telegram.InlineQueryResultCachedDocument(id, title, document_file_id, de-

scription=None, caption=None,
reply_markup=None, in-
put_message_content=None,
**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
str document.
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, 0-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
file.

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.

124 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

caption (str, optional) Caption, 0-200 characters

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.

1.37.7 telegram.InlineQueryResultCachedGif

class telegram.InlineQueryResultCachedGif(id, gif_file_id, title=None, cap-

tion=None, reply_markup=None, in-
put_message_content=None, **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
str gif.
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, 0-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
gif.

1.37. Inline Mode 125

Python Telegram Bot Documentation, Release 8.0.0

1.37.8 telegram.InlineQueryResultCachedMpeg4Gif

class telegram.InlineQueryResultCachedMpeg4Gif(id, mpeg4_file_id, title=None, cap-

tion=None, reply_markup=None,
input_message_content=None,
**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
str mpeg4_gif.
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, 0-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
MPEG-4 file.

1.37.9 telegram.InlineQueryResultCachedPhoto

class telegram.InlineQueryResultCachedPhoto(id, photo_file_id, title=None, de-

126 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

type
str photo.
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, 0-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
photo.

1.37.10 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
str sticker.
id
str Unique identifier for this result, 1-64 bytes.
sticker_file_id
str A valid file identifier of the sticker.

1.37. Inline Mode 127

Python Telegram Bot Documentation, Release 8.0.0

reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
sticker.

Parameters
id (str)
sticker_file_id (str)
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.

1.37.11 telegram.InlineQueryResultCachedVideo

class telegram.InlineQueryResultCachedVideo(id, video_file_id, title, description=None,

caption=None, reply_markup=None, in-
put_message_content=None, **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
str video.
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, 0-200 characters.
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
video.

128 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

caption (str, optional) Caption, 0-200 characters.

1.37.12 telegram.InlineQueryResultCachedVoice

class telegram.InlineQueryResultCachedVoice(id, voice_file_id, title, cap-

tion=None, reply_markup=None, in-
put_message_content=None, **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
str voice.
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-200 characters.
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
voice.

1.37. Inline Mode 129

Python Telegram Bot Documentation, Release 8.0.0

1.37.13 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, **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
str contact.
id
str Unique identifier for this result, 1-64 bytes.
phone_number
str Contacts phone number.
first_name
str Contacts first name.
last_name
str Optional. Contacts last name.
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard 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.

130 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

1.37.14 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, **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
str document.
id
str Unique identifier for this result, 1-64 bytes.
title
str Title for the result.
caption
str Optional. Caption, 0-200 characters
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 keyboard attached to the message.
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.

1.37. Inline Mode 131

Python Telegram Bot Documentation, Release 8.0.0

input_message_content (telegram.InputMessageContent) Op-

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

1.37.15 telegram.InlineQueryResultGame

class telegram.InlineQueryResultGame(id, game_short_name, reply_markup=None,

**kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a Game.
type
str game.
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 keyboard attached to the message.

1.37.16 telegram.InlineQueryResultGif

class telegram.InlineQueryResultGif(id, gif_url, thumb_url, gif_width=None,

gif_height=None, title=None, caption=None, re-
ply_markup=None, input_message_content=None,
gif_duration=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
str gif.
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.

132 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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).
title
str Optional. Title for the result.
caption
str Optional. Caption, 0-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
gif.

1.37.17 telegram.InlineQueryResultLocation

class telegram.InlineQueryResultLocation(id, latitude, longitude, ti-

tle, reply_markup=None, in-
put_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
str location.
id
str Unique identifier for this result, 1-64 bytes.
latitude
float Location latitude in degrees.

1.37. Inline Mode 133

Python Telegram Bot Documentation, Release 8.0.0

longitude
float Location longitude in degrees.
title
str Location title.
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard 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.

1.37.18 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, **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.
type
str mpeg4_gif.
id
str Unique identifier for this result, 1-64 bytes.

134 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

mpeg4_url
str A valid URL for the MP4 file. File size must not exceed 1MB.
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.
title
str Optional. Title for the result.
caption
str Optional. Caption, 0-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
MPEG-4 file.

1.37.19 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, **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
str photo.

1.37. Inline Mode 135

Python Telegram Bot Documentation, Release 8.0.0

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, 0-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
photo.

1.37.20 telegram.InlineQueryResultVenue

class telegram.InlineQueryResultVenue(id, latitude, longitude, title, address,

foursquare_id=None, reply_markup=None,
input_message_content=None, thumb_url=None,
thumb_width=None, thumb_height=None,
**kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult

136 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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
str venue.
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.
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
venue.
thumb_url
str Optional. Url of the thumbnail for the result.
thumb_width
int Optional. Thumbnail width.
thumb_height
int Optional. Thumbnail height.

1.37. Inline Mode 137

Python Telegram Bot Documentation, Release 8.0.0

1.37.21 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, in-
put_message_content=None, **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.
type
str video.
id
str Unique identifier for this result, 1-64 bytes.
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-200 characters
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 keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
video.

138 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.
**kwargs (dict) Arbitrary keyword arguments.

1.37.22 telegram.InlineQueryResultVoice

class telegram.InlineQueryResultVoice(id, voice_url, title, voice_duration=None,

caption=None, reply_markup=None, in-
put_message_content=None, **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
str voice.
id
str Unique identifier for this result, 1-64 bytes.
voice_url
str A valid URL for the voice recording.
title
str Voice message title.
caption
str Optional. Caption, 0-200 characters.
voice_duration
int Optional. Recording duration in seconds.
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
voice.

1.37. Inline Mode 139

Python Telegram Bot Documentation, Release 8.0.0

**kwargs (dict) Arbitrary keyword arguments.

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

1.37.24 telegram.InputTextMessageContent

class telegram.InputTextMessageContent(message_text, parse_mode=None, dis-

able_web_page_preview=None, **kwargs)
Bases: telegram.inline.inputmessagecontent.InputMessageContent
Represents the content of a text message to be sent as the result of an inline query.
message_text
str Text of the message to be sent, 1-4096 characters.
parse_mode
str Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-
width text or inline URLs in your bots message.
disable_web_page_preview
bool Optional. Disables link previews for links in the sent message.

1.37.25 telegram.InputLocationMessageContent

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

Bases: telegram.inline.inputmessagecontent.InputMessageContent
Represents the content of a location message to be sent as the result of an inline query.
latitude
float Latitude of the location in degrees.
longitude
float Longitude of the location in degrees.

Parameters
latitude (float) Latitude of the location in degrees.
longitude (float) Longitude of the location in degrees.
**kwargs (dict) Arbitrary keyword arguments.

140 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

1.37.26 telegram.InputVenueMessageContent

class telegram.InputVenueMessageContent(latitude, longitude, title, address,

foursquare_id=None, **kwargs)
Bases: telegram.inline.inputmessagecontent.InputMessageContent
Represents the content of a venue message to be sent as the result of an inline query.
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.

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.
**kwargs (dict) Arbitrary keyword arguments.

1.37.27 telegram.InputContactMessageContent

class telegram.InputContactMessageContent(phone_number, first_name,

last_name=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
str Contacts phone number.
first_name
str Contacts first name.
last_name
str Optional. Contacts last name.

Parameters
phone_number (str) Contacts phone number.
first_name (str) Contacts first name.
last_name (str, optional) Contacts last name.
**kwargs (dict) Arbitrary keyword arguments.

1.37. Inline Mode 141

Python Telegram Bot Documentation, Release 8.0.0

1.37.28 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
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.
inline_message_id
str Optional. Identifier of the sent inline message.
query
str The query that was used to obtain the result.

1.38 Payments

1.38.1 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
str Portion label.
amount
int Price of the product in the smallest units of the currency.

Parameters
label (str) Portion label

142 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.

1.38.2 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
str Product name.
description
str Product description.
start_parameter
str Unique bot deep-linking parameter.
currency
str Three-letter ISO 4217 currency code.
total_amount
int Total price in the smallest units of the currency.

1.38.3 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
str ISO 3166-1 alpha-2 country code.
state
str State, if applicable.
city
str City.
street_line1
str First line for the address.

1.38. Payments 143

Python Telegram Bot Documentation, Release 8.0.0

street_line2
str Second line for the address.
post_code
str Address post code.

1.38.4 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
str Optional. User name.
phone_number
str Optional. Users phone number.
email
str Optional. User email.
shipping_address
telegram.ShippingAddress Optional. User shipping address.

Parameters
name (str, optional) User name.
phone_number (str, optional) Users phone number.
email (str, optional) User email.
shipping_address (telegram.ShippingAddress, optional) User ship-
ping address.
**kwargs (dict) Arbitrary keyword arguments.

1.38.5 telegram.ShippingOption

class telegram.ShippingOption(id, title, prices, **kwargs)

Bases: telegram.base.TelegramObject
This object represents one shipping option.
id
str Shipping option identifier.
title
str Option title.

144 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

prices
List[telegram.LabeledPrice] List of price portions.

Parameters
id (str) Shipping option identifier.
title (str) Option title.
prices (List[telegram.LabeledPrice]) List of price portions.
**kwargs (dict) Arbitrary keyword arguments.

1.38.6 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
str Three-letter ISO 4217 currency code.
total_amount
int Total price in the smallest units of the currency.
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.

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.

1.38. Payments 145

Python Telegram Bot Documentation, Release 8.0.0

1.38.7 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
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 shipping address.
bot
telegram.Bot Optional. The Bot to use for instance methods.

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)

146 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

1.38.8 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
str Unique query identifier.
from_user
telegram.User User who sent the query.
currency
str Three-letter ISO 4217 currency code.
total_amount
int Total price in the smallest units of the currency.
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.

Parameters
id (str) Unique query identifier.
from_user (telegram.User) User who sent the query.
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.
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)

1.38. Payments 147

Python Telegram Bot Documentation, Release 8.0.0

1.39 Games

1.39.1 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
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.
text_entities
List[telegram.MessageEntity] Optional. Special entities that appear in text, such as user-
names, URLs, bot commands, etc.
animation
telegram.Animation Optional. Animation that will be displayed in the game message in chats.
Upload via BotFather.

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.

148 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.

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

1.39.2 telegram.Animation

class telegram.Animation(file_id, thumb=None, file_name=None, mime_type=None,

file_size=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents an animation file to be displayed in the message containing a game.
file_id
str Unique file identifier.
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.

Parameters

1.39. Games 149

Python Telegram Bot Documentation, Release 8.0.0

file_id (str) Unique file identifier.

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.

1.39.3 telegram.Callbackgame

class telegram.CallbackGame
Bases: telegram.base.TelegramObject
A placeholder, currently holds no information. Use BotFather to set up your game.

1.39.4 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
int Position in high score table for the game.
user
telegram.User User.
score
int Score.

Parameters
position (int) Position in high score table for the game.
user (telegram.User) User.
score (int) Score.

1.40 Module contents

A library that provides a Python interface to the Telegram Bot API

class telegram.Audio(file_id, duration, performer=None, title=None, mime_type=None,
file_size=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents an audio file to be treated as music by the Telegram clients.
file_id
str Unique identifier for this file.
duration
int Duration of the audio in seconds.
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.

150 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

mime_type
str Optional. MIME type of the file as defined by sender.
file_size
int Optional. File size.

Parameters
file_id (str) Unique identifier for this file.
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.
mime_type (str, optional) MIME type of the file as defined by sender.
file_size (int, optional) File size.
**kwargs (dict) Arbitrary keyword arguments.
classmethod de_json(data, bot)
class telegram.Bot(token, base_url=None, base_file_url=None, request=None)
Bases: telegram.base.TelegramObject
This object represents a Telegram Bot.
Parameters
token (str) Bots 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, optional) Pre initialized telegram.
utils.Request.
addStickerToSet(*args, **kwargs)
Use this method to add a new sticker to a set created by the bot.

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

1.40. Module contents 151

Python Telegram Bot Documentation, Release 8.0.0

Returns On success, True is returned.

Return type bool
Raises telegram.TelegramError
add_sticker_to_set(*args, **kwargs)
Use this method to add a new sticker to a set created by the bot.

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

Parameters
user_id (int) User identifier of created sticker set owner.
name (str) Sticker set name.
png_sticker (str | filelike object) Png image with the sticker, must be up to
512 kilobytes in size, dimensions must not exceed 512px, and either width or height
must be exactly 512px. Pass a file_id as a String to send a file that already exists on
the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from
the Internet, or upload a new one using multipart/form-data.
emojis (str) One or more emoji corresponding to the sticker.
mask_position (telegram.MaskPosition, optional) Position where the
mask should beplaced on faces.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, True is returned.
Return type bool
Raises telegram.TelegramError
answerCallbackQuery(*args, **kwargs)
Use this method to send answers to callback queries sent from inline keyboards. The answer will
be displayed to the user as a notification at the top of the chat screen or as an alert. Alternatively,
the user can be redirected to the specified Game URL. For this option to work, you must first 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 users 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.

152 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.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
answerInlineQuery(*args, **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 dont support pagination. Offset length cant exceed 64 bytes.
switch_pm_text (str, optional) If passed, clients will display a button with
specified text that switches the user to a private chat with the bot and sends the bot a
start message with the parameter switch_pm_parameter.
switch_pm_parameter (str, optional) Deep-linking parameter for the /start
message sent to the bot when user presses the switch button. 1-64 characters, only
A-Z, a-z, 0-9, _ and - are allowed.
timeout (int | float, optional) If this value is specified, use it as he read timeout
from the server (instead of the one specified during creation of the connection pool).
**kwargs (dict) Arbitrary keyword arguments.

Example

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

1.40. Module contents 153

Python Telegram Bot Documentation, Release 8.0.0

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
answerShippingQuery(*args, **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).
shipping_options (List[telegram.ShippingOption]) Required if ok is
True. A JSON-serialized array of available shipping options.
error_message (str, optional) Required if ok is False. Error message in human
readable form that explains why it is impossible to complete the order (e.g. Sorry,
delivery to your desired address is unavailable). Telegram will display this message
to the user.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns bool; On success, True is returned.
Raises telegram.TelegramError
answer_callback_query(*args, **kwargs)
Use this method to send answers to callback queries sent from inline keyboards. The answer will
be displayed to the user as a notification at the top of the chat screen or as an alert. Alternatively,
the user can be redirected to the specified Game URL. For this option to work, you must first 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.

154 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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 users 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(*args, **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 dont support pagination. Offset length cant exceed 64 bytes.
switch_pm_text (str, optional) If passed, clients will display a button with
specified text that switches the user to a private chat with the bot and sends the bot a
start message with the parameter switch_pm_parameter.
switch_pm_parameter (str, optional) Deep-linking parameter for the /start
message sent to the bot when user presses the switch button. 1-64 characters, only
A-Z, a-z, 0-9, _ and - are allowed.
timeout (int | float, optional) If this value is specified, use it as he read timeout
from the server (instead of the one specified during creation of the connection pool).
**kwargs (dict) Arbitrary keyword arguments.

Example

1.40. Module contents 155

Python Telegram Bot Documentation, Release 8.0.0

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 bots inline capabilities.
Returns bool On success, True is returned.
Raises telegram.TelegramError
answer_pre_checkout_query(*args, **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(*args, **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).
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.

156 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

Returns bool; On success, True is returned.

Raises telegram.TelegramError
createNewStickerSet(*args, **kwargs)
Use this method to create new sticker set owned by a user.
The bot will be able to edit the created sticker set.

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

1.40. Module contents 157

Python Telegram Bot Documentation, Release 8.0.0

title (str) Sticker set title, 1-64 characters.

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

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

Returns Returns True on success.

Return type bool
Raises telegram.TelegramError
deleteMessage(*args, **kwargs)
Use this method to delete a message. A message can only be deleted if it was sent less than 48
hours ago. Any such recently sent outgoing message may be deleted. Additionally, if the bot is an
administrator in a group chat, it can delete any message. If the bot is an administrator in a supergroup,
it can delete messages from any other user and service messages about people joining or leaving the
group (other types of service messages may only be removed by the group creator). In channels, bots
can only remove their own messages.
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.

158 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

timeout (int | float, optional) If this value is specified, use it as

read timeout (the) from the server (instead of the one specified during creation
of the connection pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, True is returned.
Return type bool
Raises telegram.TelegramError
deleteStickerFromSet(*args, **kwargs)
Use this method to delete a sticker from a set created by the bot.
Parameters
sticker (str) File identifier of the sticker.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, True is returned.
Return type bool
Raises telegram.TelegramError
deleteWebhook(*args, **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
delete_chat_photo(*args, **kwargs)
Use this method to delete a chat photo. Photos cant 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
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments

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

Returns Returns True on success.

Return type bool

1.40. Module contents 159

Python Telegram Bot Documentation, Release 8.0.0

Raises telegram.TelegramError
delete_message(*args, **kwargs)
Use this method to delete a message. A message can only be deleted if it was sent less than 48
hours ago. Any such recently sent outgoing message may be deleted. Additionally, if the bot is an
administrator in a group chat, it can delete any message. If the bot is an administrator in a supergroup,
it can delete messages from any other user and service messages about people joining or leaving the
group (other types of service messages may only be removed by the group creator). In channels, bots
can only remove their own messages.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
message_id (int) Identifier of the message to delete.
timeout (int | float, optional) If this value is specified, use it as
read timeout (the) from the server (instead of the one specified during creation
of the connection pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, True is returned.
Return type bool
Raises telegram.TelegramError
delete_sticker_from_set(*args, **kwargs)
Use this method to delete a sticker from a set created by the bot.
Parameters
sticker (str) File identifier of the sticker.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, True is returned.
Return type bool
Raises telegram.TelegramError
delete_webhook(*args, **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(*args, **kwargs)
Use this method to edit captions of messages sent by the bot or via the bot (for inline bots).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).

160 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.
caption (str, optional) New caption of the 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, if edited message is sent by the bot, the edited Message is returned,
otherwise True is returned.
Return type telegram.Message
Raises telegram.TelegramError
editMessageReplyMarkup(*args, **kwargs)
Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline
bots).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
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.
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, if edited message is sent by the bot, the editedMessage is returned,
otherwise True is returned.
Return type telegram.Message
Raises telegram.TelegramError
editMessageText(*args, **kwargs)
Use this method to edit text and game messages sent by the bot or via the bot (for inline bots).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
message_id (int, optional) Required if inline_message_id is not specified. 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.

1.40. Module contents 161

Python Telegram Bot Documentation, Release 8.0.0

text (str) New text of the message.

parse_mode (str) Send Markdown or HTML, if you want Telegram apps to
show bold, italic, fixed-width text or inline URLs in your bots message. See the
constants in telegram.ParseMode for the available modes.
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, 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_caption(*args, **kwargs)
Use this method to edit captions of messages sent by the bot or via the bot (for inline bots).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
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.
caption (str, optional) New caption of the 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, 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(*args, **kwargs)
Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline
bots).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
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.

162 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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, if edited message is sent by the bot, the editedMessage is returned,
otherwise True is returned.
Return type telegram.Message
Raises telegram.TelegramError
edit_message_text(*args, **kwargs)
Use this method to edit text and game messages sent by the bot or via the bot (for inline bots).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
message_id (int, optional) Required if inline_message_id is not specified. 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.
text (str) New text of the message.
parse_mode (str) Send Markdown or HTML, if you want Telegram apps to
show bold, italic, fixed-width text or inline URLs in your bots message. See the
constants in telegram.ParseMode for the available modes.
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, 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(*args, **kwargs)
Use this method to export an invite link to a supergroup or a channel. The bot must be an administrator
in the chat for this to work and must have the appropriate admin rights.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Exported invite link on success.

1.40. Module contents 163

Python Telegram Bot Documentation, Release 8.0.0

Return type str

Raises telegram.TelegramError
export_chat_invite_link(*args, **kwargs)
Use this method to export an invite link to a supergroup or a channel. The bot must be an administrator
in the chat for this to work and must have the appropriate admin rights.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Exported invite link on success.
Return type str
Raises telegram.TelegramError
first_name
str Bots first name.
forwardMessage(*args, **kwargs)
Use this method to forward messages of any kind.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
from_chat_id (int | str) Unique identifier for the chat where the original
message was sent (or channel username in the format @channelusername).
disable_notification (bool, optional) Sends the message silently. Users
will receive a notification with no sound.
message_id (int) Message identifier in the chat specified in from_chat_id.
timeout (int | float, optional) If this value is specified, use it as
read timeout (the) from the server (instead of the one specified during creation
of the connection pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, the sent Message is returned.
Return type telegram.Message
Raises telegram.TelegramError
forward_message(*args, **kwargs)
Use this method to forward messages of any kind.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
from_chat_id (int | str) Unique identifier for the chat where the original
message was sent (or channel username in the format @channelusername).
disable_notification (bool, optional) Sends the message silently. Users
will receive a notification with no sound.
message_id (int) Message identifier in the chat specified in from_chat_id.

164 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

timeout (int | float, optional) If this value is specified, use it as

read timeout (the) from the server (instead of the one specified during creation
of the connection pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, the sent Message is returned.
Return type telegram.Message
Raises telegram.TelegramError
getChat(*args, **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
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns telegram.Chat
Raises telegram.TelegramError
getChatAdministrators(*args, **kwargs)
Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember
objects that contains information about all chat administrators except other bots. If the chat is a group
or a supergroup and no administrators were appointed, only the creator will be returned.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns List[telegram.ChatMember]
Raises telegram.TelegramError
getChatMember(*args, **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
targetchannel (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

1.40. Module contents 165

Python Telegram Bot Documentation, Release 8.0.0

getChatMembersCount(*args, **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
targetchannel (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
getFile(*args, **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 getFile again.
Parameters
file_id (str) File identifier to get info 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
getGameHighScores(*args, **kwargs)
Use this method to get data for high score tables. Will return the score of the specified user and several
of his neighbors in a game
Parameters
user_id (int) User identifier.
chat_id (int | str, optional) Required if inline_message_id is not specified.
Unique identifier for the target chat.
message_id (int, optional) Required if inline_message_id is not specified. 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
getMe(*args, **kwargs)
A simple method for testing your bots auth token. Requires no parameters.

166 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

Parameters timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
Returns A telegram.User instance representing that bot if the credentials are valid,
None otherwise.
Return type telegram.User
Raises telegram.TelegramError
getStickerSet(*args, **kwargs)
Use this method to get a sticker set.
Parameters
name (str) Short name of the sticker set that is used in t.me/addstickers/ URLs
(e.g., animals)
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns telegram.StickerSet
Raises telegram.TelegramError
getUpdates(*args, **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) List the types of updates you want
your bot to receive. For example, specify [message, edited_channel_post, call-
back_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 up-
dates regardless of type (default). If not specified, the previous setting will be used.
Please note that this parameter doesnt affect updates created before the call to the
get_updates, so unwanted updates may be received for a short period of time.
**kwargs (dict) Arbitrary keyword arguments.

Notes

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

2. In order to avoid getting duplicate updates, recalculate offset after each server response.
3. To take full advantage of this library take a look at telegram.ext.Updater

Returns List[telegram.Update]

1.40. Module contents 167

Python Telegram Bot Documentation, Release 8.0.0

Raises telegram.TelegramError
getUserProfilePhotos(*args, **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
getWebhookInfo(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
get_chat(*args, **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
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns telegram.Chat
Raises telegram.TelegramError
get_chat_administrators(*args, **kwargs)
Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember
objects that contains information about all chat administrators except other bots. If the chat is a group
or a supergroup and no administrators were appointed, only the creator will be returned.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).

168 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.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 List[telegram.ChatMember]
Raises telegram.TelegramError
get_chat_member(*args, **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
targetchannel (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(*args, **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
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns Number of members in the chat.
Return type int
Raises telegram.TelegramError
get_file(*args, **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 getFile again.
Parameters
file_id (str) File identifier to get info 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

1.40. Module contents 169

Python Telegram Bot Documentation, Release 8.0.0

get_game_high_scores(*args, **kwargs)
Use this method to get data for high score tables. Will return the score of the specified user and several
of his neighbors in a game
Parameters
user_id (int) User identifier.
chat_id (int | str, optional) Required if inline_message_id is not specified.
Unique identifier for the target chat.
message_id (int, optional) Required if inline_message_id is not specified. 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(*args, **kwargs)
A simple method for testing your bots auth token. Requires no parameters.
Parameters timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
Returns A telegram.User instance representing that bot if the credentials are valid,
None otherwise.
Return type telegram.User
Raises telegram.TelegramError
get_sticker_set(*args, **kwargs)
Use this method to get a sticker set.
Parameters
name (str) Short name of the sticker set that is used in t.me/addstickers/ URLs
(e.g., animals)
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns telegram.StickerSet
Raises telegram.TelegramError
get_updates(*args, **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.

170 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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) List the types of updates you want
your bot to receive. For example, specify [message, edited_channel_post, call-
back_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 up-
dates regardless of type (default). If not specified, the previous setting will be used.
Please note that this parameter doesnt affect updates created before the call to the
get_updates, so unwanted updates may be received for a short period of time.
**kwargs (dict) Arbitrary keyword arguments.

Notes

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

2. In order to avoid getting duplicate updates, recalculate offset after each server response.
3. To take full advantage of this library take a look at telegram.ext.Updater

Returns List[telegram.Update]
Raises telegram.TelegramError
get_user_profile_photos(*args, **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

1.40. Module contents 171

Python Telegram Bot Documentation, Release 8.0.0

id
int Unique identifier for this bot.
kickChatMember(*args, **kwargs)
Use this method to kick a user from a group or a supergroup. In the case of supergroups, the user will
not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot
must be an administrator in the group for this to work.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
user_id (int) Unique identifier of the target user.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
until_date (int | datetime.datetime, optional) Date when the user will
be unbanned, unix time. If user is banned for more than 366 days or less than 30
seconds from the current time they are considered to be banned forever.
**kwargs (dict) Arbitrary keyword arguments.

Returns bool On success, True is returned.

Raises telegram.TelegramError
kick_chat_member(*args, **kwargs)
Use this method to kick a user from a group or a supergroup. In the case of supergroups, the user will
not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot
must be an administrator in the group for this to work.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
user_id (int) Unique identifier of the target user.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
until_date (int | datetime.datetime, optional) Date when the user will
be unbanned, unix time. If user is banned for more than 366 days or less than 30
seconds from the current time they are considered to be banned forever.
**kwargs (dict) Arbitrary keyword arguments.

Returns bool On success, True is returned.

Raises telegram.TelegramError

172 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

last_name
str Optional. Bots last name.
leaveChat(*args, **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
targetchannel (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
leave_chat(*args, **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
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns bool On success, True is returned.
Raises telegram.TelegramError
name
str Bots @username.
pinChatMessage(*args, **kwargs)
Use this method to pin a message in a supergroup. The bot must be an administrator in the chat for
this to work and must have the appropriate admin rights.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
message_id (int) Identifier of a message to pin.
disable_notification (bool, optional) Pass True, if it is not necessary to
send a notification to all group members about the new pinned message.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
pin_chat_message(*args, **kwargs)
Use this method to pin a message in a supergroup. The bot must be an administrator in the chat for
this to work and must have the appropriate admin rights.

1.40. Module contents 173

Python Telegram Bot Documentation, Release 8.0.0

Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
message_id (int) Identifier of a message to pin.
disable_notification (bool, optional) Pass True, if it is not necessary to
send a notification to all group members about the new pinned message.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
promoteChatMember(*args, **kwargs)
Use this method to promote or demote a user in a supergroup or a channel. The bot must be an
administrator in the chat for this to work and must have the appropriate admin rights. Pass False for
all boolean parameters to demote a user
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
supergroup (in the format @supergroupusername).
user_id (int) Unique identifier of the target user.
can_change_info (bool, optional) Pass True, if the administrator can change
chat title, photo and other settings.
can_post_messages (bool, optional) Pass True, if the administrator can create
channel posts, channels only.
can_edit_messages (bool, optional) Pass True, if the administrator can edit
messages of other users, channels only.
can_delete_messages (bool, optional) Pass True, if the administrator can
delete messages of other users.
can_invite_users (bool, optional) Pass True, if the administrator can invite
new users to the chat.
can_restrict_members (bool, optional) Pass True, if the administrator can
restrict, ban or unban chat members.
can_pin_messages (bool, optional) Pass True, if the administrator can pin
messages, supergroups only.
can_promote_members (bool, optional) Pass True, if the administrator can
add new administrators with a subset of his own privileges or demote administrators
that he has promoted, directly or indirectly (promoted by administrators that were
appointed by him).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError

174 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

promote_chat_member(*args, **kwargs)
Use this method to promote or demote a user in a supergroup or a channel. The bot must be an
administrator in the chat for this to work and must have the appropriate admin rights. Pass False for
all boolean parameters to demote a user
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
supergroup (in the format @supergroupusername).
user_id (int) Unique identifier of the target user.
can_change_info (bool, optional) Pass True, if the administrator can change
chat title, photo and other settings.
can_post_messages (bool, optional) Pass True, if the administrator can create
channel posts, channels only.
can_edit_messages (bool, optional) Pass True, if the administrator can edit
messages of other users, channels only.
can_delete_messages (bool, optional) Pass True, if the administrator can
delete messages of other users.
can_invite_users (bool, optional) Pass True, if the administrator can invite
new users to the chat.
can_restrict_members (bool, optional) Pass True, if the administrator can
restrict, ban or unban chat members.
can_pin_messages (bool, optional) Pass True, if the administrator can pin
messages, supergroups only.
can_promote_members (bool, optional) Pass True, if the administrator can
add new administrators with a subset of his own privileges or demote administrators
that he has promoted, directly or indirectly (promoted by administrators that were
appointed by him).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
request
restrictChatMember(*args, **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.
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.
can_send_messages (bool, optional) Pass True, if the user can send text mes-
sages, contacts, locations and venues.

1.40. Module contents 175

Python Telegram Bot Documentation, Release 8.0.0

can_send_media_messages (bool, optional) Pass True, if the user can

send audios, documents, photos, videos, video notes and voice notes, implies
can_send_messages.
can_send_other_messages (bool, optional) Pass 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) Pass True, if the user may
add web page previews to their messages, implies can_send_media_messages.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
restrict_chat_member(*args, **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.
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.
can_send_messages (bool, optional) Pass True, if the user can send text mes-
sages, contacts, locations and venues.
can_send_media_messages (bool, optional) Pass True, if the user can
send audios, documents, photos, videos, video notes and voice notes, implies
can_send_messages.
can_send_other_messages (bool, optional) Pass 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) Pass True, if the user may
add web page previews to their messages, implies can_send_media_messages.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
sendAudio(*args, **kwargs)
Use this method to send audio files, if you want Telegram clients to display them in the music player.
Your audio must be in the .mp3 format. On success, the sent Message is returned. Bots can currently
send audio files of up to 50 MB in size, this limit may be changed in the future.
For sending voice messages, use the sendVoice method instead.

176 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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-200 characters.
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.
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
sendChatAction(*args, **kwargs)
Use this method when you need to tell the user that something is happening on the bots side. The
status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its
typing status).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
action (telegram.ChatAction | str) Type of action to broadcast. Choose
one, depending on what the user is about to receive. For convenience look at the
constants in telegram.ChatAction
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns True on success.
Return type bool
Raises telegram.TelegramError

1.40. Module contents 177

Python Telegram Bot Documentation, Release 8.0.0

sendContact(*args, **kwargs)
Use this method to send phone contacts.

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

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

178 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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
sendGame(*args, **kwargs)
Use this method to send a game.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
game_short_name (str) Short name of the game, serves as the unique identifier
for the game. Set up your games via Botfather.
disable_notification (bool, optional) Sends the message silently. Users
will receive a notification with no sound.
reply_to_message_id (int, optional) If the message is a reply, ID of the
original message.
reply_markup (telegram.ReplyMarkup, optional) Additional interface 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
sendInvoice(*args, **kwargs)
Use this method to send invoices.
Parameters
chat_id (int | str) Unique identifier for the target private chat.
title (str) Product name.
description (str) Product description.
payload (str) Bot-defined invoice payload, 1-128 bytes. This will not be 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.

1.40. Module contents 179

Python Telegram Bot Documentation, Release 8.0.0

currency (str) Three-letter ISO 4217 currency code.

prices (List[telegram.LabeledPrice) Price breakdown, a list of compo-
nents (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).
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 users full name to
complete the order.
need_phone_number (bool, optional) Pass True, if you require the users
phone number to complete the order.
need_email (bool, optional) Pass True, if you require the users email to com-
plete the order.
need_shipping_address (bool, optional) Pass True, if you require the users
shipping address to complete the order.
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.ReplyMarkup, optional) Additional interface op-
tions. An inlinekeyboard. If empty, one Pay total price button will be shown. If not
empty, the first button must be a Pay button.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, the sent Message is returned.
Return type telegram.Message
Raises telegram.TelegramError
sendLocation(*args, **kwargs)
Use this method to send point on the map.

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

180 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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
sendMessage(*args, **kwargs)
Use this method to send text messages.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
text (str) Text of the message to be sent. Max 4096 characters. Also found as
telegram.constants.MAX_MESSAGE_LENGTH.
parse_mode (str) Send Markdown or HTML, if you want Telegram apps to
show bold, italic, fixed-width text or inline URLs in your bots 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
sendPhoto(*args, **kwargs)
Use this method to send photos.

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

1.40. Module contents 181

Python Telegram Bot Documentation, Release 8.0.0

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

182 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

Return type telegram.Message

Raises telegram.TelegramError
sendVenue(*args, **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.

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.
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
sendVideo(*args, **kwargs)
Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent
as Document).

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

1.40. Module contents 183

Python Telegram Bot Documentation, Release 8.0.0

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-200 characters.
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
sendVideoNote(*args, **kwargs)
Use this method to send video messages.

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

184 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

Return type telegram.Message

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

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

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

1.40. Module contents 185

Python Telegram Bot Documentation, Release 8.0.0

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-200 characters.
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.
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(*args, **kwargs)
Use this method when you need to tell the user that something is happening on the bots side. The
status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its
typing status).
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
action (telegram.ChatAction | str) Type of action to broadcast. Choose
one, depending on what the user is about to receive. For convenience look at the
constants in telegram.ChatAction
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns True on success.
Return type bool
Raises telegram.TelegramError
send_contact(*args, **kwargs)
Use this method to send phone contacts.

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

Parameters

186 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
phone_number (str, optional) Contacts phone number.
first_name (str, optional) Contacts first name.
last_name (str, optional) Contacts last name.
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_document(*args, **kwargs)
Use this method to send general files.

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

1.40. Module contents 187

Python Telegram Bot Documentation, Release 8.0.0

**kwargs (dict) Arbitrary keyword arguments.

Returns On success, the sent Message is returned.
Return type telegram.Message
Raises telegram.TelegramError
send_game(*args, **kwargs)
Use this method to send a game.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
game_short_name (str) Short name of the game, serves as the unique identifier
for the game. Set up your games via Botfather.
disable_notification (bool, optional) Sends the message silently. Users
will receive a notification with no sound.
reply_to_message_id (int, optional) If the message is a reply, ID of the
original message.
reply_markup (telegram.ReplyMarkup, optional) Additional interface 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_invoice(*args, **kwargs)
Use this method to send invoices.
Parameters
chat_id (int | str) Unique identifier for the target private chat.
title (str) Product name.
description (str) Product description.
payload (str) Bot-defined invoice payload, 1-128 bytes. This will not be 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 list of compo-
nents (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).
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.

188 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

photo_height (int, optional) Photo height.

need_name (bool, optional) Pass True, if you require the users full name to
complete the order.
need_phone_number (bool, optional) Pass True, if you require the users
phone number to complete the order.
need_email (bool, optional) Pass True, if you require the users email to com-
plete the order.
need_shipping_address (bool, optional) Pass True, if you require the users
shipping address to complete the order.
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.ReplyMarkup, optional) Additional interface op-
tions. An inlinekeyboard. If empty, one Pay total price button will be shown. If not
empty, the first button must be a Pay button.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns On success, the sent Message is returned.
Return type telegram.Message
Raises telegram.TelegramError
send_location(*args, **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.
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).

1.40. Module contents 189

Python Telegram Bot Documentation, Release 8.0.0

**kwargs (dict) Arbitrary keyword arguments.

Returns On success, the sent Message is returned.
Return type telegram.Message
Raises telegram.TelegramError
send_message(*args, **kwargs)
Use this method to send text messages.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
text (str) Text of the message to be sent. Max 4096 characters. Also found as
telegram.constants.MAX_MESSAGE_LENGTH.
parse_mode (str) Send Markdown or HTML, if you want Telegram apps to
show bold, italic, fixed-width text or inline URLs in your bots 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(*args, **kwargs)
Use this method to send photos.

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

190 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

disable_notification (bool, optional) Sends the message silently. Users

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

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

Parameters

1.40. Module contents 191

Python Telegram Bot Documentation, Release 8.0.0

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.
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(*args, **kwargs)
Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent
as Document).

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

192 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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

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

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

1.40. Module contents 193

Python Telegram Bot Documentation, Release 8.0.0

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-200 characters.
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
setChatDescription(*args, **kwargs)
Use this method to change the description of a supergroup or a channel. The bot must be an adminis-
trator 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
targetchannel (in the format @channelusername).
description (str) New chat description, 1-255 characters.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
setChatPhoto(*args, **kwargs)
Use this method to set a new profile photo for the chat.
Photos cant 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
targetchannel (in the format @channelusername).
photo (telegram.InputFile) New chat photo.

194 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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

Returns Returns True on success.

Return type bool
Raises telegram.TelegramError
setChatTitle(*args, **kwargs)
Use this method to change the title of a chat. Titles cant 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
targetchannel (in the format @channelusername).
title (str) New chat title, 1-255 characters.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments

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

Returns Returns True on success.

Return type bool
Raises telegram.TelegramError
setGameScore(*args, **kwargs)
Use this method to set the score of the specified user in a game. On success, if the message was sent
by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is
not greater than the users current score in the chat and force is False.
Parameters
user_id (int) User identifier.
score (int) New score, must be non-negative.
force (bool, optional) Pass True, if the high score is allowed to decrease. This
can be useful when fixing mistakes or banning cheaters
disable_edit_message (bool, optional) Pass True, if the game message
should not be automatically edited to include the current scoreboard.
chat_id (int|str, optional) Required if inline_message_id is not speci-
fied. Unique identifier for the target chat.
message_id (int, optional) Required if inline_message_id is not specified. Iden-
tifier of the sent message.

1.40. Module contents 195

Python Telegram Bot Documentation, Release 8.0.0

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 wasnt sent by the bot , True.
Return type telegram.Message
Raises
telegram.TelegramError If the new score is not greater than the users
current score in the chat and force is False.
setStickerPositionInSet(*args, **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
setWebhook(*args, **kwargs)
Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever
there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a
JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount
of attempts.
If youd like to make sure that the Webhook request comes from Telegram, we recommend using a
secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bots
token, you can be pretty sure its us.

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

196 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

allowed_updates (List[str], optional) List the types of updates you want

your bot to receive. For example, specify [message, edited_channel_post, call-
back_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 up-
dates regardless of type (default). If not specified, the previous setting will be used.
Please note that this parameter doesnt 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.

Returns bool On success, True is returned.

Raises telegram.TelegramError
set_chat_description(*args, **kwargs)
Use this method to change the description of a supergroup or a channel. The bot must be an adminis-
trator 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
targetchannel (in the format @channelusername).
description (str) New chat description, 1-255 characters.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
set_chat_photo(*args, **kwargs)
Use this method to set a new profile photo for the chat.
Photos cant 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
targetchannel (in the format @channelusername).
photo (telegram.InputFile) 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).

1.40. Module contents 197

Python Telegram Bot Documentation, Release 8.0.0

**kwargs (dict) Arbitrary keyword arguments

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

Returns Returns True on success.

Return type bool
Raises telegram.TelegramError
set_chat_title(*args, **kwargs)
Use this method to change the title of a chat. Titles cant 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
targetchannel (in the format @channelusername).
title (str) New chat title, 1-255 characters.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments

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

Returns Returns True on success.

Return type bool
Raises telegram.TelegramError
set_game_score(*args, **kwargs)
Use this method to set the score of the specified user in a game. On success, if the message was sent
by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is
not greater than the users current score in the chat and force is False.
Parameters
user_id (int) User identifier.
score (int) New score, must be non-negative.
force (bool, optional) Pass True, if the high score is allowed to decrease. This
can be useful when fixing mistakes or banning cheaters
disable_edit_message (bool, optional) Pass True, if the game message
should not be automatically edited to include the current scoreboard.
chat_id (int|str, optional) Required if inline_message_id is not speci-
fied. 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.

198 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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

1.40. Module contents 199

Python Telegram Bot Documentation, Release 8.0.0

a complete list of available update types. Specify an empty list to receive all up-
dates regardless of type (default). If not specified, the previous setting will be used.
Please note that this parameter doesnt 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.

Returns bool On success, True is returned.

Raises telegram.TelegramError
to_dict()
unbanChatMember(*args, **kwargs)
Use this method to unban a previously kicked user in a supergroup.
The user will not return to the group automatically, but will be able to join via link, etc. The bot must
be an administrator in the group for this to work.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
user_id (int) Unique identifier of the target user.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns bool On success, True is returned.
Raises telegram.TelegramError
unban_chat_member(*args, **kwargs)
Use this method to unban a previously kicked user in a supergroup.
The user will not return to the group automatically, but will be able to join via link, etc. The bot must
be an administrator in the group for this to work.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the target
channel (in the format @channelusername).
user_id (int) Unique identifier of the target user.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.

200 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

Returns bool On success, True is returned.

Raises telegram.TelegramError
unpinChatMessage(*args, **kwargs)
Use this method to unpin a message in a supergroup. The bot must be an administrator in the chat for
this to work and must have the appropriate admin rights.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
unpin_chat_message(*args, **kwargs)
Use this method to unpin a message in a supergroup. The bot must be an administrator in the chat for
this to work and must have the appropriate admin rights.
Parameters
chat_id (int | str) Unique identifier for the target chat or username of the
targetchannel (in the format @channelusername).
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments
Returns Returns True on success.
Return type bool
Raises telegram.TelegramError
uploadStickerFile(*args, **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')

1.40. Module contents 201

Python Telegram Bot Documentation, Release 8.0.0

Return type telegram.File

Raises telegram.TelegramError
upload_sticker_file(*args, **kwargs)
Use this method to upload a .png file with a sticker for later use in create_new_sticker_set
and add_sticker_to_set methods (can be used multiple times).

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

Parameters
user_id (int) User identifier of sticker file owner.
png_sticker (str | filelike object) Png image with the sticker, must be up to 512
kilobytes in size, dimensions must not exceed 512px, and either width or height must
be exactly 512px.
timeout (int | float, optional) If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the connection
pool).
**kwargs (dict) Arbitrary keyword arguments.
Returns The uploaded File
Return type telegram.File
Raises telegram.TelegramError
username
str Bots username.
class telegram.Chat(id, type, title=None, username=None, first_name=None, last_name=None,
all_members_are_administrators=None, bot=None, photo=None, descrip-
tion=None, invite_link=None, pinned_message=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a chat.
id
int Unique identifier for this chat.
type
str Type of chat.
title
str Optional. Title, for supergroups, channels and group chats.
username
str Optional. Username.
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.
all_members_are_administrators
bool Optional.
photo
telegram.ChatPhoto Optional. Chat photo.
description
str Optional. Description, for supergroups and channel chats.

202 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

invite_link
str Optional. Chat invite link, for supergroups and channel chats.
pinned_message
telegram.Message Optional. Pinned message, for supergroups. Returned only in get_chat.

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

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

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

1.40. Module contents 203

Python Telegram Bot Documentation, Release 8.0.0

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 groups creator or by the member that added them.

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

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

Returns bool If the action was sent successfully.

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
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
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_other_messages=None, can_add_web_page_previews=None,
**kwargs)
Bases: telegram.base.TelegramObject
This object contains information about one member of the chat.
user
telegram.User Information about the user.

204 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

status
str The members status in the chat.
until_date
datetime.datetime Optional. Date when restrictions will be lifted for this user.
can_be_edited
bool Optional. If the bot is allowed to edit administrator privileges of that user.
can_change_info
bool Optional. If the administrator can change the chat title, photo and other settings.
can_post_messages
bool Optional. If the administrator can post in the channel.
can_edit_messages
bool Optional. If the administrator can edit messages of other users.
can_delete_messages
bool Optional. If the administrator can delete messages of other users.
can_invite_users
bool Optional. If the administrator can invite new users to the chat.
can_restrict_members
bool Optional. If the administrator can restrict, ban or unban chat members.
can_pin_messages
bool Optional. If the administrator can pin messages.
can_promote_members
bool Optional. If the administrator can add new administrators.
can_send_messages
bool Optional. If the user can send text messages, contacts, locations and venues.
can_send_media_messages
bool Optional. If the user can send media messages, implies can_send_messages.
can_send_other_messages
bool Optional. If the user can send animations, games, stickers and use inline bots, implies
can_send_media_messages.
can_add_web_page_previews
bool Optional. If user may add web page previews to his messages, implies
can_send_media_messages

1.40. Module contents 205

Python Telegram Bot Documentation, Release 8.0.0

can_delete_messages (bool, optional) Administrators only. True, if the ad-

ministrator can delete messages of other user.
can_invite_users (bool, optional) Administrators only. True, if the adminis-
trator 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 only. True, if the adminis-
trator 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).
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_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'
CREATOR = 'creator'
KICKED = 'kicked'
LEFT = 'left'
MEMBER = 'member'
RESTRICTED = 'restricted'
classmethod de_json(data, bot)
to_dict()
class telegram.ChatAction
Bases: object
Helper class to provide constants for different chatactions.
FIND_LOCATION = 'find_location'
RECORD_AUDIO = 'record_audio'
RECORD_VIDEO = 'record_video'
RECORD_VIDEO_NOTE = 'record_video_note'
TYPING = 'typing'
UPLOAD_AUDIO = 'upload_audio'
UPLOAD_DOCUMENT = 'upload_document'
UPLOAD_PHOTO = 'upload_photo'
UPLOAD_VIDEO = 'upload_video'
UPLOAD_VIDEO_NOTE = 'upload_video_note'

206 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.

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.
query (str) The query that was used to obtain the result.
**kwargs (dict) Arbitrary keyword arguments.
classmethod de_json(data, bot)
to_dict()
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.
Exactly one of the fields data or game_short_name will be present.

id
str Unique identifier for this query.
from_user
telegram.User Sender.

1.40. Module contents 207

Python Telegram Bot Documentation, Release 8.0.0

message
telegram.Message Optional. Message with the callback button that originated the query.
inline_message_id
str Optional. Identifier of the message sent via the bot in inline mode, that originated the query.
chat_instance
str Optional. Global identifier, uniquely corresponding to the chat to which the message with the
callback button was sent.
data
str Optional. Data associated with the callback button.
game_short_name
str Optional. Short name of a Game to be returned.

Parameters
id (str) Unique identifier for this query.
from_user (telegram.User) Sender.
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.
inline_message_id (str, optional) Identifier of the message sent via the bot in
inline mode, that originated the query.
chat_instance (str, optional) Global identifier, uniquely corresponding to the
chat to which the message with the callback button was sent. Useful for high scores in
games.
data (str, optional) Data associated with the callback button. Be aware that a bad
client can send arbitrary data in this field.
game_short_name (str, optional) Short name of a Game to be returned, serves
as the unique identifier for the game

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

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

Returns On success, True is returned.

Return type bool
classmethod de_json(data, bot)
edit_message_caption(*args, **kwargs)
Shortcut for either:

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

or:

208 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

bot.edit_message_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(*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,

*args, **kwargs)

or:

bot.edit_message_reply_markup(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_text(*args, **kwargs)
Shortcut for either:

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

or:

bot.edit_message_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
to_dict()
class telegram.Contact(phone_number, first_name, last_name=None, user_id=None,
**kwargs)
Bases: telegram.base.TelegramObject
This object represents a phone contact.
phone_number
str Contacts phone number.
first_name
str Contacts first name.
last_name
str Optional. Contacts last name.

1.40. Module contents 209

Python Telegram Bot Documentation, Release 8.0.0

user_id
int Optional. Contacts user identifier in Telegram.

Parameters
phone_number (str) Contacts phone number.
first_name (str) Contacts first name.
last_name (str, optional) Contacts last name.
user_id (int, optional) Contacts user identifier in Telegram.
**kwargs (dict) Arbitrary keyword arguments.
classmethod de_json(data, bot)
class telegram.Document(file_id, thumb=None, file_name=None, mime_type=None,
file_size=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a general file (as opposed to photos, voice messages and audio files).
file_id
str Unique file identifier.
thumb
telegram.PhotoSize Optional. Document thumbnail.
file_name
str Original filename.
mime_type
str Optional. MIME type of the file.
file_size
int Optional. File size.

Parameters
file_id (str) Unique 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.
**kwargs (dict) Arbitrary keyword arguments.
classmethod de_json(data, bot)
class telegram.File(file_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
str Unique identifier for this file.
file_size
str Optional. File size.

210 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

file_path
str Optional. File path. Use download to get the file.

Parameters
file_id (str) Unique identifier for this file.
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.
classmethod de_json(data, bot)
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 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 (object, optional) A file-like object. Must be opened 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).
Raises ValueError If both custom_path and out are passed.
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 bots 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
True Shows reply interface to the user.
selective
bool Optional. Force reply from specific users only.

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 bots message is a reply (has reply_to_message_id), sender of the original mes-
sage.
**kwargs (dict) Arbitrary keyword arguments.
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, **kwargs)
Bases: telegram.base.TelegramObject

1.40. Module contents 211

Python Telegram Bot Documentation, Release 8.0.0

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.

212 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

inline_keyboard
List[List[telegram.InlineKeyboardButton]] Array of button rows, each represented by an
Array of InlineKeyboardButton objects.

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

bot.answer_inline_query(update.inline_query.id, *args, **kwargs)

Parameters
results (List[telegram.InlineQueryResult]) A list of results for the
inline query.
cache_time (int, optional) The maximum amount of time in seconds that the
result of the inline query may be cached on the server. Defaults to 300.

1.40. Module contents 213

Python Telegram Bot Documentation, Release 8.0.0

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 dont support pagination. Offset length cant 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.
classmethod de_json(data, bot)
to_dict()
class telegram.InlineQueryResult(type, id, **kwargs)
Bases: telegram.base.TelegramObject
Baseclass for the InlineQueryResult* classes.
type
str Type of the result.
id
str Unique identifier for this result, 1-64 Bytes.

Parameters
type (str) Type of the result.
id (str) Unique identifier for this result, 1-64 Bytes.
**kwargs (dict) Arbitrary keyword arguments.
class telegram.InlineQueryResult(type, id, **kwargs)
Bases: telegram.base.TelegramObject
Baseclass for the InlineQueryResult* classes.
type
str Type of the result.
id
str Unique identifier for this result, 1-64 Bytes.

Parameters
type (str) Type of the result.
id (str) Unique identifier for this result, 1-64 Bytes.
**kwargs (dict) Arbitrary keyword arguments.
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
str article.

214 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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

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 dont 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.
class telegram.InlineQueryResultAudio(id, audio_url, title, performer=None,
audio_duration=None, cap-
tion=None, reply_markup=None, in-
put_message_content=None, **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
str audio.

1.40. Module contents 215

Python Telegram Bot Documentation, Release 8.0.0

id
str Unique identifier for this result, 1-64 bytes.
audio_url
str A valid URL for the audio file.
title
str Title.
performer
str Optional. Caption, 0-200 characters.
audio_duration
str Optional. Performer.
caption
str Optional. Audio duration in seconds.
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
audio.

Parameters
id (str) Unique identifier for this result, 1-64 bytes.
audio_url (str) A valid URL for the audio file.
title (str) Title.
performer (str, optional) Caption, 0-200 characters.
audio_duration (str, optional) Performer.
caption (str, optional) Audio 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 audio.
**kwargs (dict) Arbitrary keyword arguments.
class telegram.InlineQueryResultCachedAudio(id, audio_file_id, caption=None,
reply_markup=None, in-
put_message_content=None, **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 amessage with the specified
content instead of the audio.
type
str audio.
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-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.

216 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
audio.

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-200 characters
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.
class telegram.InlineQueryResultCachedDocument(id, title, document_file_id, de-
scription=None, caption=None,
reply_markup=None, in-
put_message_content=None,
**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
str document.
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, 0-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
file.

1.40. Module contents 217

Python Telegram Bot Documentation, Release 8.0.0

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.
class telegram.InlineQueryResultCachedGif(id, gif_file_id, title=None, cap-
tion=None, reply_markup=None, in-
put_message_content=None, **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
str gif.
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, 0-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
gif.

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, 0-200 characters
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.
class telegram.InlineQueryResultCachedMpeg4Gif(id, mpeg4_file_id, title=None, cap-
tion=None, reply_markup=None,
input_message_content=None,
**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.

218 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

type
str mpeg4_gif.
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, 0-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
MPEG-4 file.

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, 0-200 characters
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.
class telegram.InlineQueryResultCachedPhoto(id, photo_file_id, title=None, de-
scription=None, caption=None,
reply_markup=None, in-
put_message_content=None, **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.
type
str photo.
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, 0-200 characters

1.40. Module contents 219

Python Telegram Bot Documentation, Release 8.0.0

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, 0-200 characters
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.
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
str sticker.
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 keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
sticker.

220 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

class telegram.InlineQueryResultCachedVideo(id, video_file_id, title, description=None,

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, 0-200 characters.
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.
class telegram.InlineQueryResultCachedVoice(id, voice_file_id, title, cap-
tion=None, reply_markup=None, in-
put_message_content=None, **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
str voice.
id
str Unique identifier for this result, 1-64 bytes.

1.40. Module contents 221

Python Telegram Bot Documentation, Release 8.0.0

voice_file_id
str A valid file identifier for the voice message.
title
str Voice message title.
caption
str Optional. Caption, 0-200 characters.
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
voice.

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-200 characters.
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.
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, **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
str contact.
id
str Unique identifier for this result, 1-64 bytes.
phone_number
str Contacts phone number.
first_name
str Contacts first name.
last_name
str Optional. Contacts last name.
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard 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.

222 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

thumb_width
int Optional. Thumbnail width.
thumb_height
int Optional. Thumbnail height.

Parameters
id (str) Unique identifier for this result, 1-64 bytes.
phone_number (str) Contacts phone number.
first_name (str) Contacts first name.
last_name (str, optional) Contacts last name.
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.
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, **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
str document.
id
str Unique identifier for this result, 1-64 bytes.
title
str Title for the result.
caption
str Optional. Caption, 0-200 characters
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 keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
file.

1.40. Module contents 223

Python Telegram Bot Documentation, Release 8.0.0

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.

Parameters
id (str) Unique identifier for this result, 1-64 bytes.
title (str) Title for the result.
caption (str, optional) Caption, 0-200 characters
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.
input_message_content (telegram.InputMessageContent) Op-
tional. 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.
class telegram.InlineQueryResultGif(id, gif_url, thumb_url, gif_width=None,
gif_height=None, title=None, caption=None, re-
ply_markup=None, input_message_content=None,
gif_duration=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
str gif.
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.
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).

224 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

title
str Optional. Title for the result.
caption
str Optional. Caption, 0-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
gif.

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.
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).
title (str, optional) Title for the result.caption (str, optional):
caption (str, optional) Caption, 0-200 characters
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.
class telegram.InlineQueryResultLocation(id, latitude, longitude, ti-
tle, reply_markup=None, in-
put_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
str location.
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.
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
location.

1.40. Module contents 225

Python Telegram Bot Documentation, Release 8.0.0

thumb_url
str Optional. Url of the thumbnail for the result.
thumb_width
int Optional. Thumbnail width.
thumb_height
int Optional. Thumbnail height.

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.
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.
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, **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.
type
str mpeg4_gif.
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.
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.
title
str Optional. Title for the result.

226 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

caption
str Optional. Caption, 0-200 characters
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
MPEG-4 file.

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.
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.
title (str, optional) Title for the result.
caption (str, optional) Caption, 0-200 characters
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.
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, **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
str photo.
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.

1.40. Module contents 227

Python Telegram Bot Documentation, Release 8.0.0

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, 0-200 characters
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.
class telegram.InlineQueryResultVenue(id, latitude, longitude, title, address,
foursquare_id=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
str venue.
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.
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.

228 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
venue.
thumb_url
str Optional. Url of the thumbnail for the result.
thumb_width
int Optional. Thumbnail width.
thumb_height
int Optional. Thumbnail height.

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.
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.
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, in-
put_message_content=None, **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.
type
str video.
id
str Unique identifier for this result, 1-64 bytes.
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.

1.40. Module contents 229

Python Telegram Bot Documentation, Release 8.0.0

caption
str Optional. Caption, 0-200 characters
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 keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
video.

Parameters
id (str) Unique identifier for this result, 1-64 bytes.
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-200 characters.
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.
**kwargs (dict) Arbitrary keyword arguments.
class telegram.InlineQueryResultVoice(id, voice_url, title, voice_duration=None,
caption=None, reply_markup=None, in-
put_message_content=None, **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
str voice.
id
str Unique identifier for this result, 1-64 bytes.
voice_url
str A valid URL for the voice recording.

230 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

title
str Voice message title.
caption
str Optional. Caption, 0-200 characters.
voice_duration
int Optional. Recording duration in seconds.
reply_markup
telegram.InlineKeyboardMarkup Optional. Inline keyboard attached to the message.
input_message_content
telegram.InputMessageContent Optional. Content of the message to be sent instead of the
voice.

Parameters
id (str) Unique identifier for this result, 1-64 bytes.
voice_url (str) A valid URL for the voice recording.
title (str) Voice message title.
caption (str, optional) Caption, 0-200 characters.
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.
**kwargs (dict) Arbitrary keyword arguments.
class telegram.InlineQueryResultGame(id, game_short_name, reply_markup=None,
**kwargs)
Bases: telegram.inline.inlinequeryresult.InlineQueryResult
Represents a Game.
type
str game.
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 keyboard attached to the message.

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.
class telegram.InputContactMessageContent(phone_number, first_name,
last_name=None, **kwargs)
Bases: telegram.inline.inputmessagecontent.InputMessageContent
Represents the content of a contact message to be sent as the result of an inline query.

1.40. Module contents 231

Python Telegram Bot Documentation, Release 8.0.0

phone_number
str Contacts phone number.
first_name
str Contacts first name.
last_name
str Optional. Contacts last name.

Parameters
phone_number (str) Contacts phone number.
first_name (str) Contacts first name.
last_name (str, optional) Contacts last name.
**kwargs (dict) Arbitrary keyword arguments.
class telegram.InputFile(data)
Bases: object
This object represents a Telegram InputFile.
data
dict Data containing an inputfile.

Parameters data (dict) Data containing an inputfile.

Raises TelegramError
content_type
str Content type
headers
dict Headers.
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
static is_inputfile(data)
Check if the request is a file request.
Parameters data (Dict[str, str]) A dict of (str, str) key/value pairs.
Returns bool
to_form()
Transform the inputfile to multipart/form data.
Returns str
class telegram.InputLocationMessageContent(latitude, longitude, **kwargs)
Bases: telegram.inline.inputmessagecontent.InputMessageContent
Represents the content of a location message to be sent as the result of an inline query.
latitude
float Latitude of the location in degrees.
longitude
float Longitude of the location in degrees.

Parameters

232 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

latitude (float) Latitude of the location in degrees.

longitude (float) Longitude of the location in degrees.
**kwargs (dict) Arbitrary keyword arguments.
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.
class telegram.InputTextMessageContent(message_text, parse_mode=None, dis-
able_web_page_preview=None, **kwargs)
Bases: telegram.inline.inputmessagecontent.InputMessageContent
Represents the content of a text message to be sent as the result of an inline query.
message_text
str Text of the message to be sent, 1-4096 characters.
parse_mode
str Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-
width text or inline URLs in your bots message.
disable_web_page_preview
bool Optional. Disables link previews for links in the sent message.

Parameters
message_text (str) Text of the message to be sent, 1-4096 characters. 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 bots message.
disable_web_page_preview (bool, optional) Disables link previews for links
in the sent message.
**kwargs (dict) Arbitrary keyword arguments.
class telegram.InputVenueMessageContent(latitude, longitude, title, address,
foursquare_id=None, **kwargs)
Bases: telegram.inline.inputmessagecontent.InputMessageContent
Represents the content of a venue message to be sent as the result of an inline query.
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.

Parameters
latitude (float) Latitude of the location in degrees.
longitude (float) Longitude of the location in degrees.

1.40. Module contents 233

Python Telegram Bot Documentation, Release 8.0.0

title (str) Name of the venue.

address (str) Address of the venue.
foursquare_id (str, optional) Foursquare identifier of the venue, if known.
**kwargs (dict) Arbitrary keyword arguments.
class telegram.KeyboardButton(text, request_contact=None, request_location=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.

Note: Optional fields are mutually exclusive.

text
str Text of the button.
request_contact
bool Optional. If the users phone number will be sent.
request_location
bool Optional. If the users current location will be sent.

Note: request_contact and request_location options will only work in Telegram versions
released after 9 April, 2016. Older clients will ignore them.

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

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

Parameters
longitude (float) Longitude as defined by sender.
latitude (float) Latitude as defined by sender.
**kwargs (dict) Arbitrary keyword arguments.
classmethod de_json(data, bot)

234 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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

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

message_id
int Unique message identifier inside this chat.
from_user
telegram.User Optional. Sender.
date
datetime.datetime Date the message was sent.
chat
telegram.Chat Conversation the message belongs to.
forward_from
telegram.User Optional. Sender of the original message.
forward_from_chat
telegram.Chat Optional. Information about the original channel.
forward_from_message_id
int Optional. Identifier of the original message in the channel.
forward_date
datetime.datetime Optional. Date the original message was sent.
reply_to_message
telegram.Message Optional. The original message.
edit_date
datetime.datetime Optional. Date the message was last edited.
text
str Optional. The actual UTF-8 text of the message.
entities
List[telegram.MessageEntity] Optional. Special entities like usernames, URLs, bot com-
mands, etc. that appear in the text. See Message.parse_entity and parse_entities meth-
ods for how to use properly.
audio
telegram.Audio Optional. Information about the file.
document
telegram.Document Optional. Information about the file.

1.40. Module contents 235

Python Telegram Bot Documentation, Release 8.0.0

game
telegram.Game Optional. Information about the game.
photo
List[telegram.PhotoSize] Optional. Available sizes of the photo.
sticker
telegram.Sticker Optional. Information about the sticker.
video
telegram.Video Optional. Information about the video.
voice
telegram.Voice Optional. Information about the file.
video_note
telegram.VideoNote Optional. Information about the video message.
new_chat_members
List[telegram.User] Optional. Information about new members to the chat. (the bot itself may
be one of these members).
caption
str Optional. Caption for the document, photo or video, 0-200 characters.
contact
telegram.Contact Optional. Information about the contact.
location
telegram.Location Optional. Information about the location.
venue
telegram.Venue Optional. Information about the venue.
left_chat_member
telegram.User Optional. Information about the user that left the group. (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 changed to this value.
delete_chat_photo
bool Optional. The chat photo was deleted.
group_chat_created
bool Optional. The group has been created.
supergroup_chat_created
bool Optional. The supergroup has been created.
channel_chat_created
bool Optional. The channel has been created.
migrate_to_chat_id
int Optional. The group has been migrated to a supergroup with the specified identifier.
migrate_from_chat_id
int Optional. The supergroup has been migrated from a group with the specified identifier.
pinned_message
telegram.message Optional. Specified message was pinned.
invoice
telegram.Invoice Optional. Information about the invoice.

236 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

successful_payment
telegram.SuccessfulPayment Optional. Information about the payment.
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.
bot
telegram.Bot Optional. The Bot to use for instance methods.

Deprecated: 6.0 new_chat_member (telegram.User): Replaced with new_chat_members

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_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.
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.
audio (telegram.Audio, optional) Message is an audio file, information about
the file.
document (telegram.Document, optional) Message is a general file, informa-
tion about the file.
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.

1.40. Module contents 237

Python Telegram Bot Documentation, Release 8.0.0

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-200 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 cant be received in a message coming through
updates, because bot cant 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 cant be received in a message coming through updates, be-
cause bot cant 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
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
attr: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.

238 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

successful_payment (telegram.SuccessfulPayment, optional) Mes-

sage is a service message about a successful payment, information about the payment.
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.
chat_id
int Shortcut for telegram.Chat.id for chat.
classmethod de_json(data, bot)
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)

Note: You can only edit messages that the bot sent itself, therefore this method can only be used on
the return value of the bot.send_* family of methods.

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, therefore this method can only be used on
the return value of the bot.send_* family of methods.

Returns On success, instance representing the edited message.

Return type telegram.Message
edit_text(*args, **kwargs)
Shortcut for:

1.40. Module contents 239

Python Telegram Bot Documentation, Release 8.0.0

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, therefore this method can only be used on
the return value of the bot.send_* family of methods..

Returns On success, instance representing the edited message.

Return type telegram.Message
effective_attachment
telegram.Audio or telegram.Contact or telegram.Document 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, disable_notification=False)
Shortcut for:

bot.forward_message(chat_id=chat_id,
from_chat_id=update.message.chat_id,
disable_notification=disable_notification,
message_id=update.message.message_id)

Returns On success, instance representing the message forwarded.

Return type telegram.Message
new_chat_member
Deprecated
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

Note: This method is present because Telegram calculates the offset and length in UTF-16 code-
point pairs, which some versions of Python dont handle automatically. (That is, you cant just slice

240 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

Message.text with the offset and length.)

Parameters
entity (telegram.MessageEntity) The entity to extract the text from. It
must
an entity that belongs to this message. (be)
Returns The text of the given entity
Return type str
reply_audio(*args, **kwargs)
Shortcut for:

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

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

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

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

1.40. Module contents 241

Python Telegram Bot Documentation, Release 8.0.0

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

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

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

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

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

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

242 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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

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

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
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
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.
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.
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
to_dict()
class telegram.MessageEntity(type, offset, length, url=None, user=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

1.40. Module contents 243

Python Telegram Bot Documentation, Release 8.0.0

type
str Type of the entity.
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. Url that will be opened after user taps on the text.
user
telegram.User Optional. The mentioned user.

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.
ALL_TYPES = ['mention', 'hashtag', 'bot_command', 'url', 'email', 'bold', 'italic',
BOLD = 'bold'
BOT_COMMAND = 'bot_command'
CODE = 'code'
EMAIL = 'email'
HASHTAG = 'hashtag'
ITALIC = 'italic'
MENTION = 'mention'
PRE = 'pre'
TEXT_LINK = 'text_link'
TEXT_MENTION = 'text_mention'
URL = 'url'
classmethod de_json(data, bot)
classmethod de_list(data, bot)
class telegram.ParseMode
Bases: object
This object represents a Telegram Message Parse Modes.
HTML = 'HTML'
MARKDOWN = 'Markdown'
class telegram.PhotoSize(file_id, width, height, file_size=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents one size of a photo or a file/sticker thumbnail.

244 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

file_id
str Unique identifier for this file.
width
int Photo width.
height
int Photo height.
file_size
int Optional. File size.

Parameters
file_id (str) Unique identifier for this file.
width (int) Photo width.
height (int) Photo height.
file_size (int, optional) File size.
**kwargs (dict) Arbitrary keyword arguments.
classmethod de_json(data, bot)
classmethod de_list(data, bot)
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
True Requests clients to remove the custom keyboard.
selective
bool Optional. Use this parameter if you want to remove the keyboard for specific users only.

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 havent 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 bots message is a reply (has reply_to_message_id), sender of the original mes-
sage.
**kwargs (dict) Arbitrary keyword arguments.
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
List[List[telegram.KeyboardButton | str]] Array of button rows.

1.40. Module contents 245

Python Telegram Bot Documentation, Release 8.0.0

resize_keyboard
bool Optional. Requests clients to resize the keyboard.
one_time_keyboard
bool Optional. Requests clients to hide the keyboard as soon as its been used.
selective
bool Optional. Show the keyboard to specific users only.

Example

A user requests to change the bots language, bot replies to the request with a keyboard to select the new
language. Other users in the group dont 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 apps standard keyboard. Defaults to False
one_time_keyboard (bool, optional) Requests clients to hide the keyboard as
soon as its 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 bots message is a reply (has reply_to_message_id), sender of the original mes-
sage.
Defaults to False.
**kwargs (dict) Arbitrary keyword arguments.
to_dict()
class telegram.ReplyMarkup
Bases: telegram.base.TelegramObject
Base class for Telegram ReplyMarkup Objects.
See telegram.ReplyKeyboardMarkup and telegram.InlineKeyboardMarkup for detailed
use.
class telegram.Sticker(file_id, width, height, thumb=None, emoji=None, file_size=None,
set_name=None, mask_position=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a sticker.
file_id
str Unique identifier for this file.
width
int Sticker width.
height
int Sticker height.
thumb
telegram.PhotoSize Optional. Sticker thumbnail in the .webp or .jpg format.

246 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.

Parameters
file_id (str) Unique identifier for this file.
width (int) Sticker width.
height (int) Sticker height.
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.
classmethod de_json(data, bot)
classmethod de_list(data, bot)
exception telegram.TelegramError(message)
Bases: exceptions.Exception
class telegram.TelegramObject
Bases: object
Base class for most telegram objects.
classmethod de_json(data, bot)
to_dict()
to_json()
Returns str
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, **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
int The updates unique identifier.

1.40. Module contents 247

Python Telegram Bot Documentation, Release 8.0.0

message
telegram.Message Optional. New incoming message.
edited_message
telegram.Message Optional. New version of a message.
channel_post
telegram.Message Optional. New incoming channel post.
edited_channel_post
telegram.Message Optional. New version of a channel post.
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.
callback_query
telegram.CallbackQuery Optional. New incoming callback query.
shipping_query
telegram.ShippingQuery Optional. New incoming shipping query.
pre_checkout_query
telegram.PreCheckoutQuery Optional. New incoming pre-checkout query.

Parameters
update_id (int) The updates unique identifier. Update identifiers start from a
certain positive number and increase sequentially. This ID becomes especially handy if
youre 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.
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
**kwargs (dict) Arbitrary keyword arguments.
classmethod de_json(data, bot)
effective_chat
telegram.Chat The chat that this update was sent in, no matter what kind of update this is.

248 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

Will be None for inline_query, chosen_inline_result, callback_query from inline

messages, shipping_query and pre_checkout_query.
effective_message
telegram.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 and pre_checkout_query.
effective_user
telegram.User The user that sent this update, no matter what kind of update this is. Will be
None for channel_post.
class telegram.User(id, first_name, is_bot, last_name=None, username=None, lan-
guage_code=None, bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a Telegram user or bot.
id
int Unique identifier for this user or bot.
is_bot
bool True, if this user is a bot
first_name
str Users or bots first name.
last_name
str Optional. Users or bots last name.
username
str Optional. Users or bots last name.
language_code
str Optional. IETF language tag of the users language.
bot
telegram.Bot Optional. The Bot to use for instance methods.

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

mention_html(name=None)
Parameters name (str) If provided, will overwrite the users name.
Returns The inline mention for the user as HTML.
Return type str

1.40. Module contents 249

Python Telegram Bot Documentation, Release 8.0.0

mention_markdown(name=None)
Parameters name (str) If provided, will overwrite the users name.
Returns The inline mention for the user as markdown.
Return type str
name
str The users username if available, if not it returns the first name and if present first_name
and last_name.
class telegram.UserProfilePhotos(total_count, photos, **kwargs)
Bases: telegram.base.TelegramObject
This object represent a users profile pictures.
total_count
int Total number of profile pictures.
photos
List[List[telegram.PhotoSize]] Requested profile pictures.

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).
classmethod de_json(data, bot)
to_dict()
class telegram.Venue(location, title, address, foursquare_id=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a venue.
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.

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.
**kwargs (dict) Arbitrary keyword arguments.
classmethod de_json(data, bot)
class telegram.Video(file_id, width, height, duration, thumb=None, mime_type=None,
file_size=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a video file.

250 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

file_id
str Unique identifier for this file.
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.

Parameters
file_id (str) Unique identifier for this file.
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.
**kwargs (dict) Arbitrary keyword arguments.
classmethod de_json(data, bot)
class telegram.Voice(file_id, duration, mime_type=None, file_size=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a voice note.
file_id
str Unique identifier for this file.
duration
int 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.

1.40. Module contents 251

Python Telegram Bot Documentation, Release 8.0.0

class telegram.WebhookInfo(url, has_custom_certificate, pending_update_count,

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.
classmethod de_json(data, bot)
class telegram.Animation(file_id, thumb=None, file_name=None, mime_type=None,
file_size=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents an animation file to be displayed in the message containing a game.
file_id
str Unique file identifier.
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.

252 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

file_size
int Optional. File size.

Parameters
file_id (str) Unique file identifier.
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.
classmethod de_json(data, bot)
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
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.
text_entities
List[telegram.MessageEntity] Optional. Special entities that appear in text, such as user-
names, URLs, bot commands, etc.
animation
telegram.Animation Optional. Animation that will be displayed in the game message in chats.
Upload via BotFather.

1.40. Module contents 253

Python Telegram Bot Documentation, Release 8.0.0

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

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
to_dict()
class telegram.GameHighScore(position, user, score)
Bases: telegram.base.TelegramObject
This object represents one row of the high scores table for a game.
position
int Position in high score table for the game.
user
telegram.User User.
score
int Score.

Parameters
position (int) Position in high score table for the game.
user (telegram.User) User.
score (int) Score.
classmethod de_json(data, bot)
class telegram.VideoNote(file_id, length, duration, thumb=None, file_size=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a video message (available in Telegram apps as of v.4.0).

254 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

file_id
str Unique identifier for this file.
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.

Parameters
file_id (str) Unique identifier for this file.
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.
**kwargs (dict) Arbitrary keyword arguments.
classmethod de_json(data, bot)
class telegram.LabeledPrice(label, amount, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a portion of the price for goods or services.
label
str Portion label.
amount
int Price of the product in the smallest units of the currency.

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.
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
str Three-letter ISO 4217 currency code.
total_amount
int Total price in the smallest units of the currency.
invoice_payload
str Bot specified invoice payload.

1.40. Module contents 255

Python Telegram Bot Documentation, Release 8.0.0

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.

Parameters
id (str) Shipping option identifier.
title (str) Option title.
prices (List[telegram.LabeledPrice]) List of price portions.
**kwargs (dict) Arbitrary keyword arguments.
to_dict()
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
str ISO 3166-1 alpha-2 country code.

256 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

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.

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.
classmethod de_json(data, bot)
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.

1.40. Module contents 257

Python Telegram Bot Documentation, Release 8.0.0

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.
classmethod de_json(data, bot)
to_dict()
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
str Optional. User name.
phone_number
str Optional. Users phone number.
email
str Optional. User email.
shipping_address
telegram.ShippingAddress Optional. User shipping address.

Parameters
name (str, optional) User name.
phone_number (str, optional) Users phone number.

258 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

email (str, optional) User email.

shipping_address (telegram.ShippingAddress, optional) User ship-
ping address.
**kwargs (dict) Arbitrary keyword arguments.
classmethod de_json(data, bot)
class telegram.Invoice(title, description, start_parameter, currency, total_amount, **kwargs)
Bases: telegram.base.TelegramObject
This object contains basic information about an invoice.
title
str Product name.
description
str Product description.
start_parameter
str Unique bot deep-linking parameter.
currency
str Three-letter ISO 4217 currency code.
total_amount
int Total price in the smallest units of the currency.

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.
classmethod de_json(data, bot)
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.

1.40. Module contents 259

Python Telegram Bot Documentation, Release 8.0.0

bot
telegram.Bot Optional. The Bot to use for instance methods.

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.
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.
classmethod de_json(data, bot)
to_dict()
class telegram.ChatPhoto(small_file_id, big_file_id, bot=None, **kwargs)
Bases: telegram.base.TelegramObject
This object represents a chat photo.
small_file_id
str Unique file identifier of small (160x160) chat photo.
big_file_id
str Unique file identifier of big (640x640) chat photo.

260 Chapter 1. telegram package

Python Telegram Bot Documentation, Release 8.0.0

class telegram.StickerSet(name, title, contains_masks, stickers, bot=None, **kwargs)

Bases: telegram.base.TelegramObject
This object represents a sticker set.
name
str Sticker set name.
title
str Sticker set title.
contains_masks
bool True, if the sticker set contains masks.
stickers
List[telegram.Sticker] List of all set stickers.

Parameters
name (str) Sticker set name.
title (str) Sticker set title.
contains_masks (bool) True, if the sticker set contains masks.
stickers (List[telegram.Sticker]) List of all set stickers.
static de_json(data, bot)
to_dict()
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
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.
y_shift
float Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom.
scale
float Mask scaling coefficient. For example, 2.0 means double size.

Notes

1.40. Module contents 261

Python Telegram Bot Documentation, Release 8.0.0

EYES = 'eyes'
FOREHEAD = 'forehead'
MOUTH = 'mouth'
classmethod de_json(data, bot)
class telegram.CallbackGame
Bases: telegram.base.TelegramObject
A placeholder, currently holds no information. Use BotFather to set up your game.

262 Chapter 1. telegram package

CHAPTER 2

Indices and tables

genindex
modindex
search

263
Python Telegram Bot Documentation, Release 8.0.0

264 Chapter 2. Indices and tables

Python Module Index

t
telegram.constants, 92
telegram.error, 94
telegram.ext.filters, 7

265
Python Telegram Bot Documentation, Release 8.0.0

266 Python Module Index

Index

Symbols answer_pre_checkout_query() (telegram.Bot method),

__call__() (telegram.ext.DelayQueue method), 15 38
__call__() (telegram.ext.MessageQueue method), 14 answer_shipping_query() (telegram.Bot method), 39
__weakref__ (telegram.ext.MessageQueue attribute), answerCallbackQuery() (telegram.Bot method), 35
14 answerInlineQuery() (telegram.Bot method), 35
answerPreCheckoutQuery() (telegram.Bot method), 36
A answerShippingQuery() (telegram.Bot method), 36
add_error_handler() (telegram.ext.Dispatcher method), Audio (class in telegram), 33
6 audio (Message attribute), 100
add_handler() (telegram.ext.Dispatcher method), 6 audio (telegram.ext.filters.Filters attribute), 8
add_sticker_to_set() (telegram.Bot method), 34 audio (telegram.Message attribute), 235
address (InlineQueryResultVenue attribute), 137 audio_duration (InlineQueryResultAudio attribute),
address (InputVenueMessageContent attribute), 141 123
address (telegram.InlineQueryResultVenue attribute), audio_duration (telegram.InlineQueryResultAudio at-
228 tribute), 216
address (telegram.InputVenueMessageContent at- audio_file_id (InlineQueryResultCachedAudio at-
tribute), 233 tribute), 123
address (telegram.Venue attribute), 250 audio_file_id (telegram.InlineQueryResultCachedAudio
address (Venue attribute), 115 attribute), 216
addStickerToSet() (telegram.Bot method), 33 audio_url (InlineQueryResultAudio attribute), 122
ADMINISTRATOR (telegram.ChatMember attribute), audio_url (telegram.InlineQueryResultAudio attribute),
92 216
all (telegram.ext.filters.Filters attribute), 8 author_signature (Message attribute), 101
all_members_are_administrators (Chat attribute), 87 author_signature (telegram.Message attribute), 237
all_members_are_administrators (telegram.Chat
attribute), 202 B
ALL_TYPES (telegram.MessageEntity attribute), 109 BadRequest, 94
allow_edited (CommandHandler attribute), 21 BaseFilter (class in telegram.ext.filters), 7
allow_edited (MessageHandler attribute), 24 big_file_id (ChatPhoto attribute), 92
allow_reentry (ConversationHandler attribute), 20 big_file_id (telegram.ChatPhoto attribute), 260
allowed_updates (telegram.WebhookInfo attribute), BOLD (telegram.MessageEntity attribute), 109
252 Bot (class in telegram), 33
allowed_updates (WebhookInfo attribute), 117 bot (Dispatcher attribute), 5
amount (LabeledPrice attribute), 142 bot (JobQueue attribute), 11
amount (telegram.LabeledPrice attribute), 255 bot (Message attribute), 101
Animation (class in telegram), 149 bot (PreCheckoutQuery attribute), 147
animation (Game attribute), 148 bot (ShippingQuery attribute), 146
animation (telegram.Game attribute), 253 bot (telegram.Message attribute), 237
answer() (telegram.CallbackQuery method), 86 bot (telegram.PreCheckoutQuery attribute), 257
answer() (telegram.InlineQuery method), 120 bot (telegram.ShippingQuery attribute), 259
answer() (telegram.PreCheckoutQuery method), 147 bot (telegram.User attribute), 249
answer() (telegram.ShippingQuery method), 146 bot (Updater attribute), 3
answer_callback_query() (telegram.Bot method), 37 bot (User attribute), 114
answer_inline_query() (telegram.Bot method), 37

267
Python Telegram Bot Documentation, Release 8.0.0

BOT_COMMAND (telegram.MessageEntity attribute), can_send_media_messages (telegram.ChatMember at-

109 tribute), 205
burst_limit (DelayQueue attribute), 14 can_send_messages (ChatMember attribute), 91
can_send_messages (telegram.ChatMember attribute),
C 205
callback (CallbackQueryHandler attribute), 17 can_send_other_messages (ChatMember attribute), 91
callback (ChosenInlineResultHandler attribute), 18 can_send_other_messages (telegram.ChatMember at-
callback (CommandHandler attribute), 21 tribute), 205
callback (Handler attribute), 15 caption (InlineQueryResultAudio attribute), 123
callback (InlineQueryHandler attribute), 23 caption (InlineQueryResultCachedAudio attribute), 123
callback (MessageHandler attribute), 24 caption (InlineQueryResultCachedDocument attribute),
callback (PreCheckoutQueryHandler attribute), 26 124
callback (RegexHandler attribute), 27 caption (InlineQueryResultCachedGif attribute), 125
callback (ShippingQueryHandler attribute), 28 caption (InlineQueryResultCachedMpeg4Gif attribute),
callback (StringCommandHandler attribute), 30 126
callback (StringRegexHandler attribute), 31 caption (InlineQueryResultCachedPhoto attribute), 127
callback (TypeHandler attribute), 32 caption (InlineQueryResultCachedVideo attribute), 128
callback_data (InlineKeyboardButton attribute), 96 caption (InlineQueryResultCachedVoice attribute), 129
callback_data (telegram.InlineKeyboardButton at- caption (InlineQueryResultDocument attribute), 131
tribute), 212 caption (InlineQueryResultGif attribute), 133
callback_game (InlineKeyboardButton attribute), 96 caption (InlineQueryResultMpeg4Gif attribute), 135
callback_game (telegram.InlineKeyboardButton caption (InlineQueryResultPhoto attribute), 136
attribute), 212 caption (InlineQueryResultVideo attribute), 138
callback_query (telegram.Update attribute), 248 caption (InlineQueryResultVoice attribute), 139
callback_query (Update attribute), 112 caption (Message attribute), 100
CallbackGame (class in telegram), 150 caption (telegram.InlineQueryResultAudio attribute),
CallbackQuery (class in telegram), 85 216
CallbackQueryHandler (class in telegram.ext), 17 caption (telegram.InlineQueryResultCachedAudio at-
can_add_web_page_previews (ChatMember attribute), tribute), 216
91 caption (telegram.InlineQueryResultCachedDocument
can_add_web_page_previews (telegram.ChatMember attribute), 217
attribute), 205 caption (telegram.InlineQueryResultCachedGif at-
can_be_edited (ChatMember attribute), 90 tribute), 218
can_be_edited (telegram.ChatMember attribute), 205 caption (telegram.InlineQueryResultCachedMpeg4Gif
can_change_info (ChatMember attribute), 90 attribute), 219
can_change_info (telegram.ChatMember attribute), caption (telegram.InlineQueryResultCachedPhoto at-
205 tribute), 219
can_delete_messages (ChatMember attribute), 90 caption (telegram.InlineQueryResultCachedVideo at-
can_delete_messages (telegram.ChatMember attribute), 221
tribute), 205 caption (telegram.InlineQueryResultCachedVoice at-
can_edit_messages (ChatMember attribute), 90 tribute), 222
can_edit_messages (telegram.ChatMember attribute), caption (telegram.InlineQueryResultDocument at-
205 tribute), 223
can_invite_users (ChatMember attribute), 91 caption (telegram.InlineQueryResultGif attribute), 225
can_invite_users (telegram.ChatMember attribute), 205 caption (telegram.InlineQueryResultMpeg4Gif at-
can_pin_messages (ChatMember attribute), 91 tribute), 226
can_pin_messages (telegram.ChatMember attribute), caption (telegram.InlineQueryResultPhoto attribute),
205 227
can_post_messages (ChatMember attribute), 90 caption (telegram.InlineQueryResultVideo attribute),
can_post_messages (telegram.ChatMember attribute), 229
205 caption (telegram.InlineQueryResultVoice attribute),
can_promote_members (ChatMember attribute), 91 231
can_promote_members (telegram.ChatMember at- caption (telegram.Message attribute), 236
tribute), 205 CHANNEL (telegram.Chat attribute), 88
can_restrict_members (ChatMember attribute), 91 channel_chat_created (Message attribute), 101
can_restrict_members (telegram.ChatMember at- channel_chat_created (telegram.Message attribute),
tribute), 205 236
can_send_media_messages (ChatMember attribute), 91 channel_post (telegram.Update attribute), 248

268 Index
Python Telegram Bot Documentation, Release 8.0.0

channel_post (Update attribute), 112 contains_masks (StickerSet attribute), 119

channel_post_updates (MessageHandler attribute), 24 contains_masks (telegram.StickerSet attribute), 261
Chat (class in telegram), 87 content_type (telegram.InputFile attribute), 98
chat (Message attribute), 99 ConversationHandler (class in telegram.ext), 19
chat (telegram.Message attribute), 235 country_code (ShippingAddress attribute), 143
chat_created (telegram.ext.filters.Filters attribute), 9 country_code (telegram.ShippingAddress attribute),
chat_data (telegram.ext.Dispatcher attribute), 6 256
chat_id (telegram.Message attribute), 103 create_new_sticker_set() (telegram.Bot method), 40
chat_instance (CallbackQuery attribute), 85 createNewStickerSet() (telegram.Bot method), 39
chat_instance (telegram.CallbackQuery attribute), 208 CREATOR (telegram.ChatMember attribute), 92
ChatAction (class in telegram), 89 currency (Invoice attribute), 143
ChatMember (class in telegram), 90 currency (PreCheckoutQuery attribute), 147
ChatMigrated, 94 currency (SuccessfulPayment attribute), 145
ChatPhoto (class in telegram), 92 currency (telegram.Invoice attribute), 259
check_update() (telegram.ext.CallbackQueryHandler currency (telegram.PreCheckoutQuery attribute), 257
method), 18 currency (telegram.SuccessfulPayment attribute), 255
check_update() (tele-
gram.ext.ChosenInlineResultHandler D
method), 19 data (CallbackQuery attribute), 85
check_update() (telegram.ext.CommandHandler data (InputFile attribute), 97
method), 22 data (telegram.CallbackQuery attribute), 208
check_update() (telegram.ext.ConversationHandler data (telegram.InputFile attribute), 232
method), 21 date (Message attribute), 99
check_update() (telegram.ext.Handler method), 16 date (telegram.Message attribute), 235
check_update() (telegram.ext.InlineQueryHandler de_json() (telegram.Update class method), 113
method), 24 de_json() (telegram.User class method), 114
check_update() (telegram.ext.MessageHandler de_list() (telegram.User class method), 114
method), 25 DelayQueue (class in telegram.ext), 14
check_update() (tele- delete() (telegram.Message method), 103
gram.ext.PreCheckoutQueryHandler delete_chat_photo (Message attribute), 101
method), 26 delete_chat_photo (telegram.ext.filters.Filters at-
check_update() (telegram.ext.RegexHandler method), tribute), 9
28 delete_chat_photo (telegram.Message attribute), 236
check_update() (telegram.ext.ShippingQueryHandler delete_chat_photo() (telegram.Bot method), 42
method), 29 delete_message() (telegram.Bot method), 42
check_update() (telegram.ext.StringCommandHandler delete_sticker_from_set() (telegram.Bot method), 42
method), 30 delete_webhook() (telegram.Bot method), 43
check_update() (telegram.ext.StringRegexHandler deleteChatPhoto() (telegram.Bot method), 40
method), 31 deleteMessage() (telegram.Bot method), 41
check_update() (telegram.ext.TypeHandler method), 32 deleteStickerFromSet() (telegram.Bot method), 41
CHIN (telegram.MaskPosition attribute), 119 deleteWebhook() (telegram.Bot method), 41
chosen_inline_result (telegram.Update attribute), 248 description (Chat attribute), 87
chosen_inline_result (Update attribute), 112 description (Game attribute), 148
ChosenInlineResult (class in telegram), 142 description (InlineQueryResultArticle attribute), 122
ChosenInlineResultHandler (class in telegram.ext), 18 description (InlineQueryResultCachedDocument at-
city (ShippingAddress attribute), 143 tribute), 124
city (telegram.ShippingAddress attribute), 257 description (InlineQueryResultCachedPhoto attribute),
CODE (telegram.MessageEntity attribute), 109 127
collect_optional_args() (telegram.ext.Handler method), description (InlineQueryResultCachedVideo attribute),
16 128
command (CommandHandler attribute), 21 description (InlineQueryResultDocument attribute),
command (StringCommandHandler attribute), 29 131
command (telegram.ext.filters.Filters attribute), 8 description (InlineQueryResultPhoto attribute), 136
CommandHandler (class in telegram.ext), 21 description (InlineQueryResultVideo attribute), 138
Contact (class in telegram), 93 description (Invoice attribute), 143
contact (Message attribute), 100 description (telegram.Chat attribute), 202
contact (telegram.ext.filters.Filters attribute), 8 description (telegram.Game attribute), 253
contact (telegram.Message attribute), 236

Index 269
Python Telegram Bot Documentation, Release 8.0.0

description (telegram.InlineQueryResultArticle at- edit_message_text() (telegram.CallbackQuery method),

tribute), 215 87
description (telegram.InlineQueryResultCachedDocumentedit_reply_markup() (telegram.Message method), 104
attribute), 217 edit_text() (telegram.Message method), 104
description (telegram.InlineQueryResultCachedPhoto edited_channel_post (telegram.Update attribute), 248
attribute), 219 edited_channel_post (Update attribute), 112
description (telegram.InlineQueryResultCachedVideo edited_message (telegram.Update attribute), 248
attribute), 221 edited_message (Update attribute), 112
description (telegram.InlineQueryResultDocument at- edited_updates (MessageHandler attribute), 24
tribute), 223 editMessageCaption() (telegram.Bot method), 43
description (telegram.InlineQueryResultPhoto at- editMessageReplyMarkup() (telegram.Bot method), 43
tribute), 227 editMessageText() (telegram.Bot method), 44
description (telegram.InlineQueryResultVideo at- effective_attachment (telegram.Message attribute), 104
tribute), 230 effective_chat (telegram.Update attribute), 113
description (telegram.Invoice attribute), 259 effective_message (telegram.Update attribute), 113
disable_web_page_preview (InputTextMessageContent effective_user (telegram.Update attribute), 113
attribute), 140 email (OrderInfo attribute), 144
disable_web_page_preview (tele- EMAIL (telegram.MessageEntity attribute), 109
gram.InputTextMessageContent attribute), email (telegram.OrderInfo attribute), 258
233 emoji (Sticker attribute), 118
dispatch_error() (telegram.ext.Dispatcher method), 6 emoji (telegram.Sticker attribute), 246
Dispatcher (class in telegram.ext), 5 END (telegram.ext.ConversationHandler attribute), 21
dispatcher (Updater attribute), 3 entities (Message attribute), 100
Document (class in telegram), 94 entities (telegram.Message attribute), 235
document (Message attribute), 100 entry_points (ConversationHandler attribute), 19
document (telegram.ext.filters.Filters attribute), 8 error_handlers (telegram.ext.Dispatcher attribute), 6
document (telegram.Message attribute), 235 exc_route (DelayQueue attribute), 14
document_file_id (InlineQueryResultCachedDocument export_chat_invite_link() (telegram.Bot method), 46
attribute), 124 exportChatInviteLink() (telegram.Bot method), 46
document_file_id (tele- EYES (telegram.MaskPosition attribute), 119
gram.InlineQueryResultCachedDocument
attribute), 217 F
document_url (InlineQueryResultDocument attribute), fallbacks (ConversationHandler attribute), 20
131 File (class in telegram), 95
document_url (telegram.InlineQueryResultDocument file_id (Animation attribute), 149
attribute), 223 file_id (Audio attribute), 33
download() (telegram.File method), 95 file_id (Document attribute), 94
duration (Audio attribute), 33 file_id (File attribute), 95
duration (telegram.Audio attribute), 150 file_id (PhotoSize attribute), 110
duration (telegram.Video attribute), 251 file_id (Sticker attribute), 118
duration (telegram.VideoNote attribute), 255 file_id (telegram.Animation attribute), 252
duration (telegram.Voice attribute), 251 file_id (telegram.Audio attribute), 150
duration (Video attribute), 115 file_id (telegram.Document attribute), 210
duration (VideoNote attribute), 116 file_id (telegram.File attribute), 210
duration (Voice attribute), 116 file_id (telegram.PhotoSize attribute), 244
file_id (telegram.Sticker attribute), 246
E file_id (telegram.Video attribute), 250
edit_caption() (telegram.Message method), 103 file_id (telegram.VideoNote attribute), 254
edit_date (Message attribute), 100 file_id (telegram.Voice attribute), 251
edit_date (telegram.Message attribute), 235 file_id (Video attribute), 115
edit_message_caption() (telegram.Bot method), 44 file_id (VideoNote attribute), 116
edit_message_caption() (telegram.CallbackQuery file_id (Voice attribute), 116
method), 86 file_name (Animation attribute), 149
edit_message_reply_markup() (telegram.Bot method), file_name (Document attribute), 94
45 file_name (telegram.Animation attribute), 252
edit_message_reply_markup() (tele- file_name (telegram.Document attribute), 210
gram.CallbackQuery method), 86 file_path (File attribute), 95
edit_message_text() (telegram.Bot method), 45 file_path (telegram.File attribute), 210

270 Index
Python Telegram Bot Documentation, Release 8.0.0

file_size (Animation attribute), 149 forwarded (telegram.ext.filters.Filters attribute), 9

file_size (Audio attribute), 33 forwardMessage() (telegram.Bot method), 46
file_size (Document attribute), 94 foursquare_id (InlineQueryResultVenue attribute), 137
file_size (File attribute), 95 foursquare_id (InputVenueMessageContent attribute),
file_size (PhotoSize attribute), 110 141
file_size (Sticker attribute), 118 foursquare_id (telegram.InlineQueryResultVenue at-
file_size (telegram.Animation attribute), 252 tribute), 228
file_size (telegram.Audio attribute), 151 foursquare_id (telegram.InputVenueMessageContent
file_size (telegram.Document attribute), 210 attribute), 233
file_size (telegram.File attribute), 210 foursquare_id (telegram.Venue attribute), 250
file_size (telegram.PhotoSize attribute), 245 foursquare_id (Venue attribute), 115
file_size (telegram.Sticker attribute), 247 from_user (CallbackQuery attribute), 85
file_size (telegram.Video attribute), 251 from_user (ChosenInlineResult attribute), 142
file_size (telegram.VideoNote attribute), 255 from_user (InlineQuery attribute), 120
file_size (telegram.Voice attribute), 251 from_user (Message attribute), 99
file_size (Video attribute), 115 from_user (PreCheckoutQuery attribute), 147
file_size (VideoNote attribute), 116 from_user (ShippingQuery attribute), 146
file_size (Voice attribute), 117 from_user (telegram.CallbackQuery attribute), 207
filter() (telegram.ext.filters.BaseFilter method), 8 from_user (telegram.ChosenInlineResult attribute), 207
Filters (class in telegram.ext.filters), 8 from_user (telegram.InlineQuery attribute), 213
filters (CommandHandler attribute), 21 from_user (telegram.Message attribute), 235
filters (MessageHandler attribute), 24 from_user (telegram.PreCheckoutQuery attribute), 257
Filters.chat (class in telegram.ext.filters), 8 from_user (telegram.ShippingQuery attribute), 259
Filters.entity (class in telegram.ext.filters), 8
Filters.language (class in telegram.ext.filters), 9 G
Filters.user (class in telegram.ext.filters), 10 Game (class in telegram), 148
FIND_LOCATION (telegram.ChatAction attribute), 89 game (Message attribute), 100
first_name (Chat attribute), 87 game (telegram.ext.filters.Filters attribute), 9
first_name (Contact attribute), 93 game (telegram.Message attribute), 235
first_name (InlineQueryResultContact attribute), 130 game_short_name (CallbackQuery attribute), 85
first_name (InputContactMessageContent attribute), game_short_name (InlineQueryResultGame attribute),
141 132
first_name (telegram.Bot attribute), 46 game_short_name (telegram.CallbackQuery attribute),
first_name (telegram.Chat attribute), 202 208
first_name (telegram.Contact attribute), 209 game_short_name (telegram.InlineQueryResultGame
first_name (telegram.InlineQueryResultContact at- attribute), 231
tribute), 222 GameHighScore (class in telegram), 150
first_name (telegram.InputContactMessageContent at- get_administrators() (telegram.Chat method), 88
tribute), 232 get_chat() (telegram.Bot method), 51
first_name (telegram.User attribute), 249 get_chat_administrators() (telegram.Bot method), 51
first_name (User attribute), 113 get_chat_member() (telegram.Bot method), 51
force_reply (ForceReply attribute), 96 get_chat_members_count() (telegram.Bot method), 51
force_reply (telegram.ForceReply attribute), 211 get_file() (telegram.Bot method), 52
ForceReply (class in telegram), 96 get_game_high_scores() (telegram.Bot method), 52
FOREHEAD (telegram.MaskPosition attribute), 120 get_instance() (telegram.ext.Dispatcher class method),
forward() (telegram.Message method), 104 6
forward_date (Message attribute), 100 get_me() (telegram.Bot method), 52
forward_date (telegram.Message attribute), 235 get_member() (telegram.Chat method), 88
forward_from (Message attribute), 100 get_members_count() (telegram.Chat method), 89
forward_from (telegram.Message attribute), 235 get_profile_photos() (telegram.User method), 114
forward_from_chat (Message attribute), 100 get_sticker_set() (telegram.Bot method), 53
forward_from_chat (telegram.Message attribute), 235 get_updates() (telegram.Bot method), 53
forward_from_message_id (Message attribute), 100 get_user_profile_photos() (telegram.Bot method), 53
forward_from_message_id (telegram.Message at- get_webhook_info() (telegram.Bot method), 54
tribute), 235 getChat() (telegram.Bot method), 47
forward_message() (telegram.Bot method), 47 getChatAdministrators() (telegram.Bot method), 47
forward_signature (Message attribute), 101 getChatMember() (telegram.Bot method), 48
forward_signature (telegram.Message attribute), 237 getChatMembersCount() (telegram.Bot method), 48

Index 271
Python Telegram Bot Documentation, Release 8.0.0

getFile() (telegram.Bot method), 48 has_custom_certificate (telegram.WebhookInfo at-

getGameHighScores() (telegram.Bot method), 49 tribute), 252
getMe() (telegram.Bot method), 49 has_custom_certificate (WebhookInfo attribute), 117
getStickerSet() (telegram.Bot method), 49 HASHTAG (telegram.MessageEntity attribute), 109
getUpdates() (telegram.Bot method), 49 headers (telegram.InputFile attribute), 98
getUserProfilePhotos() (telegram.Bot method), 50 height (PhotoSize attribute), 110
getWebhookInfo() (telegram.Bot method), 50 height (Sticker attribute), 118
gif_duration (InlineQueryResultGif attribute), 133 height (telegram.PhotoSize attribute), 245
gif_duration (telegram.InlineQueryResultGif attribute), height (telegram.Sticker attribute), 246
224 height (telegram.Video attribute), 251
gif_file_id (InlineQueryResultCachedGif attribute), height (Video attribute), 115
125 hide_url (InlineQueryResultArticle attribute), 122
gif_file_id (telegram.InlineQueryResultCachedGif at- hide_url (telegram.InlineQueryResultArticle attribute),
tribute), 218 215
gif_height (InlineQueryResultGif attribute), 132 HTML (telegram.ParseMode attribute), 109
gif_height (telegram.InlineQueryResultGif attribute),
224 I
gif_url (InlineQueryResultGif attribute), 132 id (CallbackQuery attribute), 85
gif_url (telegram.InlineQueryResultGif attribute), 224 id (Chat attribute), 87
gif_width (InlineQueryResultGif attribute), 132 id (InlineQuery attribute), 120
gif_width (telegram.InlineQueryResultGif attribute), id (InlineQueryResult attribute), 121
224 id (InlineQueryResultArticle attribute), 121
GROUP (telegram.Chat attribute), 88 id (InlineQueryResultAudio attribute), 122
group (telegram.ext.filters.Filters attribute), 9 id (InlineQueryResultCachedAudio attribute), 123
group_chat_created (Message attribute), 101 id (InlineQueryResultCachedDocument attribute), 124
group_chat_created (telegram.Message attribute), 236 id (InlineQueryResultCachedGif attribute), 125
groups (telegram.ext.Dispatcher attribute), 6 id (InlineQueryResultCachedMpeg4Gif attribute), 126
id (InlineQueryResultCachedPhoto attribute), 127
H id (InlineQueryResultCachedSticker attribute), 127
handle_update() (telegram.ext.CallbackQueryHandler id (InlineQueryResultCachedVideo attribute), 128
method), 18 id (InlineQueryResultCachedVoice attribute), 129
handle_update() (tele- id (InlineQueryResultContact attribute), 130
gram.ext.ChosenInlineResultHandler id (InlineQueryResultDocument attribute), 131
method), 19 id (InlineQueryResultGame attribute), 132
handle_update() (telegram.ext.CommandHandler id (InlineQueryResultGif attribute), 132
method), 22 id (InlineQueryResultLocation attribute), 133
handle_update() (telegram.ext.ConversationHandler id (InlineQueryResultMpeg4Gif attribute), 134
method), 21 id (InlineQueryResultPhoto attribute), 135
handle_update() (telegram.ext.Handler method), 16 id (InlineQueryResultVenue attribute), 137
handle_update() (telegram.ext.InlineQueryHandler id (InlineQueryResultVideo attribute), 138
method), 24 id (InlineQueryResultVoice attribute), 139
handle_update() (telegram.ext.MessageHandler id (PreCheckoutQuery attribute), 147
method), 25 id (ShippingOption attribute), 144
handle_update() (tele- id (ShippingQuery attribute), 146
gram.ext.PreCheckoutQueryHandler id (telegram.Bot attribute), 54
method), 26 id (telegram.CallbackQuery attribute), 207
handle_update() (telegram.ext.RegexHandler method), id (telegram.Chat attribute), 202
28 id (telegram.InlineQuery attribute), 213
handle_update() (telegram.ext.ShippingQueryHandler id (telegram.InlineQueryResult attribute), 214
method), 29 id (telegram.InlineQueryResultArticle attribute), 214
handle_update() (telegram.ext.StringCommandHandler id (telegram.InlineQueryResultAudio attribute), 215
method), 30 id (telegram.InlineQueryResultCachedAudio attribute),
handle_update() (telegram.ext.StringRegexHandler 216
method), 31 id (telegram.InlineQueryResultCachedDocument at-
handle_update() (telegram.ext.TypeHandler method), tribute), 217
32 id (telegram.InlineQueryResultCachedGif attribute),
Handler (class in telegram.ext), 15 218
handlers (telegram.ext.Dispatcher attribute), 6

272 Index
Python Telegram Bot Documentation, Release 8.0.0

id (telegram.InlineQueryResultCachedMpeg4Gif at- InlineQueryResultCachedVoice (class in telegram), 129

tribute), 219 InlineQueryResultContact (class in telegram), 130
id (telegram.InlineQueryResultCachedPhoto attribute), InlineQueryResultDocument (class in telegram), 131
219 InlineQueryResultGame (class in telegram), 132
id (telegram.InlineQueryResultCachedSticker at- InlineQueryResultGif (class in telegram), 132
tribute), 220 InlineQueryResultLocation (class in telegram), 133
id (telegram.InlineQueryResultCachedVideo attribute), InlineQueryResultMpeg4Gif (class in telegram), 134
221 InlineQueryResultPhoto (class in telegram), 135
id (telegram.InlineQueryResultCachedVoice attribute), InlineQueryResultVenue (class in telegram), 136
221 InlineQueryResultVideo (class in telegram), 138
id (telegram.InlineQueryResultContact attribute), 222 InlineQueryResultVoice (class in telegram), 139
id (telegram.InlineQueryResultDocument attribute), input_message_content (InlineQueryResultArticle at-
223 tribute), 121
id (telegram.InlineQueryResultGame attribute), 231 input_message_content (InlineQueryResultAudio at-
id (telegram.InlineQueryResultGif attribute), 224 tribute), 123
id (telegram.InlineQueryResultLocation attribute), 225 input_message_content (InlineQueryResultCachedAu-
id (telegram.InlineQueryResultMpeg4Gif attribute), dio attribute), 123
226 input_message_content (InlineQueryResultCached-
id (telegram.InlineQueryResultPhoto attribute), 227 Document attribute), 124
id (telegram.InlineQueryResultVenue attribute), 228 input_message_content (InlineQueryResultCachedGif
id (telegram.InlineQueryResultVideo attribute), 229 attribute), 125
id (telegram.InlineQueryResultVoice attribute), 230 input_message_content (InlineQueryResultCachedM-
id (telegram.PreCheckoutQuery attribute), 257 peg4Gif attribute), 126
id (telegram.ShippingOption attribute), 256 input_message_content (InlineQueryResultCached-
id (telegram.ShippingQuery attribute), 259 Photo attribute), 127
id (telegram.User attribute), 249 input_message_content (InlineQueryResultCached-
id (User attribute), 113 Sticker attribute), 128
idle() (telegram.ext.Updater method), 4 input_message_content (InlineQueryResultCached-
inline_keyboard (InlineKeyboardMarkup attribute), 97 Video attribute), 128
inline_keyboard (telegram.InlineKeyboardMarkup at- input_message_content (InlineQueryResultCached-
tribute), 212 Voice attribute), 129
inline_message_id (CallbackQuery attribute), 85 input_message_content (InlineQueryResultContact at-
inline_message_id (ChosenInlineResult attribute), 142 tribute), 130
inline_message_id (telegram.CallbackQuery attribute), input_message_content (InlineQueryResultDocument
208 attribute), 131
inline_message_id (telegram.ChosenInlineResult at- input_message_content (InlineQueryResultGif at-
tribute), 207 tribute), 133
inline_query (telegram.Update attribute), 248 input_message_content (InlineQueryResultLocation at-
inline_query (Update attribute), 112 tribute), 134
InlineKeyboardButton (class in telegram), 96 input_message_content (InlineQueryResultMpeg4Gif
InlineKeyboardMarkup (class in telegram), 97 attribute), 135
InlineQuery (class in telegram), 120 input_message_content (InlineQueryResultPhoto at-
InlineQueryHandler (class in telegram.ext), 23 tribute), 136
InlineQueryResult (class in telegram), 121 input_message_content (InlineQueryResultVenue at-
InlineQueryResultArticle (class in telegram), 121 tribute), 137
InlineQueryResultAudio (class in telegram), 122 input_message_content (InlineQueryResultVideo at-
InlineQueryResultCachedAudio (class in telegram), tribute), 138
123 input_message_content (InlineQueryResultVoice at-
InlineQueryResultCachedDocument (class in tele- tribute), 139
gram), 124 input_message_content (tele-
InlineQueryResultCachedGif (class in telegram), 125 gram.InlineQueryResultArticle attribute),
InlineQueryResultCachedMpeg4Gif (class in tele- 215
gram), 126 input_message_content (tele-
InlineQueryResultCachedPhoto (class in telegram), 126 gram.InlineQueryResultAudio attribute),
InlineQueryResultCachedSticker (class in telegram), 216
127 input_message_content (tele-
InlineQueryResultCachedVideo (class in telegram), gram.InlineQueryResultCachedAudio
128 attribute), 216

Index 273
Python Telegram Bot Documentation, Release 8.0.0

input_message_content (tele- Invoice (class in telegram), 143

gram.InlineQueryResultCachedDocument invoice (Message attribute), 101
attribute), 217 invoice (telegram.ext.filters.Filters attribute), 9
input_message_content (tele- invoice (telegram.Message attribute), 236
gram.InlineQueryResultCachedGif attribute), invoice_payload (PreCheckoutQuery attribute), 147
218 invoice_payload (ShippingQuery attribute), 146
input_message_content (tele- invoice_payload (SuccessfulPayment attribute), 145
gram.InlineQueryResultCachedMpeg4Gif invoice_payload (telegram.PreCheckoutQuery at-
attribute), 219 tribute), 257
input_message_content (tele- invoice_payload (telegram.ShippingQuery attribute),
gram.InlineQueryResultCachedPhoto at- 259
tribute), 220 invoice_payload (telegram.SuccessfulPayment at-
input_message_content (tele- tribute), 255
gram.InlineQueryResultCachedSticker is_bot (telegram.User attribute), 249
attribute), 220 is_bot (User attribute), 113
input_message_content (tele- is_image() (telegram.InputFile static method), 98
gram.InlineQueryResultCachedVideo at- is_inputfile() (telegram.InputFile static method), 98
tribute), 221 ITALIC (telegram.MessageEntity attribute), 109
input_message_content (tele-
gram.InlineQueryResultCachedVoice at- J
tribute), 222 job_queue (Dispatcher attribute), 5
input_message_content (tele- job_queue (Updater attribute), 3
gram.InlineQueryResultContact attribute), JobQueue (class in telegram.ext), 11
222 jobs() (telegram.ext.JobQueue method), 11
input_message_content (tele-
gram.InlineQueryResultDocument attribute), K
223 keyboard (ReplyKeyboardMarkup attribute), 111
input_message_content (tele- keyboard (telegram.ReplyKeyboardMarkup attribute),
gram.InlineQueryResultGif attribute), 245
225 KeyboardButton (class in telegram), 98
input_message_content (tele- kick_chat_member() (telegram.Bot method), 54
gram.InlineQueryResultLocation attribute), kick_member() (telegram.Chat method), 89
225 kickChatMember() (telegram.Bot method), 54
input_message_content (tele- KICKED (telegram.ChatMember attribute), 92
gram.InlineQueryResultMpeg4Gif attribute),
227 L
input_message_content (tele-
label (LabeledPrice attribute), 142
gram.InlineQueryResultPhoto attribute),
label (telegram.LabeledPrice attribute), 255
228
LabeledPrice (class in telegram), 142
input_message_content (tele-
language_code (telegram.User attribute), 249
gram.InlineQueryResultVenue attribute),
language_code (User attribute), 114
228
last_error_date (telegram.WebhookInfo attribute), 252
input_message_content (tele-
last_error_date (WebhookInfo attribute), 117
gram.InlineQueryResultVideo attribute),
last_error_message (telegram.WebhookInfo attribute),
230
252
input_message_content (tele-
last_error_message (WebhookInfo attribute), 117
gram.InlineQueryResultVoice attribute),
last_name (Chat attribute), 87
231
last_name (Contact attribute), 93
InputContactMessageContent (class in telegram), 141
last_name (InlineQueryResultContact attribute), 130
InputFile (class in telegram), 97
last_name (InputContactMessageContent attribute),
InputLocationMessageContent (class in telegram), 140
141
InputMessageContent (class in telegram), 140
last_name (telegram.Bot attribute), 55
InputTextMessageContent (class in telegram), 140
last_name (telegram.Chat attribute), 202
InputVenueMessageContent (class in telegram), 141
last_name (telegram.Contact attribute), 209
InvalidToken, 94
last_name (telegram.InlineQueryResultContact at-
InvertedFilter (class in telegram.ext.filters), 10
tribute), 222
invite_link (Chat attribute), 87
last_name (telegram.InputContactMessageContent at-
invite_link (telegram.Chat attribute), 202
tribute), 232

274 Index
Python Telegram Bot Documentation, Release 8.0.0

last_name (telegram.User attribute), 249 MaskPosition (class in telegram), 119

last_name (User attribute), 113 MAX_CAPTION_LENGTH (in module tele-
latitude (InlineQueryResultLocation attribute), 133 gram.constants), 93
latitude (InlineQueryResultVenue attribute), 137 max_connections (telegram.WebhookInfo attribute),
latitude (InputLocationMessageContent attribute), 140 252
latitude (InputVenueMessageContent attribute), 141 max_connections (WebhookInfo attribute), 117
latitude (Location attribute), 99 MAX_FILESIZE_DOWNLOAD (in module tele-
latitude (telegram.InlineQueryResultLocation at- gram.constants), 93
tribute), 225 MAX_FILESIZE_UPLOAD (in module tele-
latitude (telegram.InlineQueryResultVenue attribute), gram.constants), 93
228 MAX_INLINE_QUERY_RESULTS (in module tele-
latitude (telegram.InputLocationMessageContent at- gram.constants), 93
tribute), 232 MAX_MESSAGE_ENTITIES (in module tele-
latitude (telegram.InputVenueMessageContent at- gram.constants), 93
tribute), 233 MAX_MESSAGE_LENGTH (in module tele-
latitude (telegram.Location attribute), 234 gram.constants), 92
leave() (telegram.Chat method), 89 MAX_MESSAGES_PER_MINUTE_PER_GROUP
leave_chat() (telegram.Bot method), 55 (in module telegram.constants), 93
leaveChat() (telegram.Bot method), 55 MAX_MESSAGES_PER_SECOND (in module tele-
LEFT (telegram.ChatMember attribute), 92 gram.constants), 93
left_chat_member (Message attribute), 100 MAX_MESSAGES_PER_SECOND_PER_CHAT (in
left_chat_member (telegram.ext.filters.Filters at- module telegram.constants), 93
tribute), 9 MEMBER (telegram.ChatMember attribute), 92
left_chat_member (telegram.Message attribute), 236 MENTION (telegram.MessageEntity attribute), 109
length (MessageEntity attribute), 108 mention_html() (telegram.User method), 114
length (telegram.MessageEntity attribute), 244 mention_markdown() (telegram.User method), 114
length (telegram.VideoNote attribute), 255 MergedFilter (class in telegram.ext.filters), 10
length (VideoNote attribute), 116 message (CallbackQuery attribute), 85
location (ChosenInlineResult attribute), 142 Message (class in telegram), 99
Location (class in telegram), 99 message (telegram.CallbackQuery attribute), 207
location (InlineQuery attribute), 120 message (telegram.Update attribute), 247
location (Message attribute), 100 message (Update attribute), 112
location (telegram.ChosenInlineResult attribute), 207 message_id (Message attribute), 99
location (telegram.ext.filters.Filters attribute), 9 message_id (telegram.Message attribute), 235
location (telegram.InlineQuery attribute), 213 message_text (InputTextMessageContent attribute),
location (telegram.Message attribute), 236 140
location (telegram.Venue attribute), 250 message_text (telegram.InputTextMessageContent at-
location (Venue attribute), 115 tribute), 233
longitude (InlineQueryResultLocation attribute), 133 message_updates (MessageHandler attribute), 24
longitude (InlineQueryResultVenue attribute), 137 MessageEntity (class in telegram), 108
longitude (InputLocationMessageContent attribute), MessageHandler (class in telegram.ext), 24
140 MessageQueue (class in telegram.ext), 13
longitude (InputVenueMessageContent attribute), 141 migrate (telegram.ext.filters.Filters attribute), 10
longitude (Location attribute), 99 migrate_from_chat_id (Message attribute), 101
longitude (telegram.InlineQueryResultLocation at- migrate_from_chat_id (telegram.Message attribute),
tribute), 225 236
longitude (telegram.InlineQueryResultVenue attribute), migrate_to_chat_id (Message attribute), 101
228 migrate_to_chat_id (telegram.Message attribute), 236
longitude (telegram.InputLocationMessageContent at- mime_type (Animation attribute), 149
tribute), 232 mime_type (Audio attribute), 33
longitude (telegram.InputVenueMessageContent mime_type (Document attribute), 94
attribute), 233 mime_type (InlineQueryResultDocument attribute),
longitude (telegram.Location attribute), 234 131
mime_type (InlineQueryResultVideo attribute), 138
M mime_type (telegram.Animation attribute), 252
MARKDOWN (telegram.ParseMode attribute), 109 mime_type (telegram.Audio attribute), 150
mask_position (Sticker attribute), 118 mime_type (telegram.Document attribute), 210
mask_position (telegram.Sticker attribute), 247

Index 275
Python Telegram Bot Documentation, Release 8.0.0

mime_type (telegram.InlineQueryResultDocument at- offset (telegram.MessageEntity attribute), 244

tribute), 223 one_time_keyboard (ReplyKeyboardMarkup attribute),
mime_type (telegram.InlineQueryResultVideo at- 111
tribute), 229 one_time_keyboard (telegram.ReplyKeyboardMarkup
mime_type (telegram.Video attribute), 251 attribute), 246
mime_type (telegram.Voice attribute), 251 order_info (PreCheckoutQuery attribute), 147
mime_type (Video attribute), 115 order_info (SuccessfulPayment attribute), 145
mime_type (Voice attribute), 116 order_info (telegram.PreCheckoutQuery attribute), 257
MOUTH (telegram.MaskPosition attribute), 120 order_info (telegram.SuccessfulPayment attribute), 256
mpeg4_duration (InlineQueryResultMpeg4Gif at- OrderInfo (class in telegram), 144
tribute), 135
mpeg4_duration (tele- P
gram.InlineQueryResultMpeg4Gif attribute), parse_entities() (telegram.Message method), 105
226 parse_entity() (telegram.Message method), 105
mpeg4_file_id (InlineQueryResultCachedMpeg4Gif at- parse_mode (InputTextMessageContent attribute), 140
tribute), 126 parse_mode (telegram.InputTextMessageContent at-
mpeg4_file_id (telegram.InlineQueryResultCachedMpeg4Gif tribute), 233
attribute), 219 parse_text_entities() (telegram.Game method), 149
mpeg4_height (InlineQueryResultMpeg4Gif attribute), parse_text_entity() (telegram.Game method), 149
135 ParseMode (class in telegram), 109
mpeg4_height (telegram.InlineQueryResultMpeg4Gif pass_args (CommandHandler attribute), 21
attribute), 226 pass_args (StringCommandHandler attribute), 30
mpeg4_url (InlineQueryResultMpeg4Gif attribute), pass_chat_data (CallbackQueryHandler attribute), 17
134 pass_chat_data (ChosenInlineResultHandler attribute),
mpeg4_url (telegram.InlineQueryResultMpeg4Gif at- 18
tribute), 226 pass_chat_data (CommandHandler attribute), 21
mpeg4_width (InlineQueryResultMpeg4Gif attribute), pass_chat_data (Handler attribute), 16
135 pass_chat_data (InlineQueryHandler attribute), 23
mpeg4_width (telegram.InlineQueryResultMpeg4Gif pass_chat_data (MessageHandler attribute), 24
attribute), 226 pass_chat_data (PreCheckoutQueryHandler attribute),
26
N pass_chat_data (RegexHandler attribute), 27
name (DelayQueue attribute), 14 pass_chat_data (ShippingQueryHandler attribute), 29
name (OrderInfo attribute), 144 pass_groupdict (CallbackQueryHandler attribute), 17
name (StickerSet attribute), 119 pass_groupdict (InlineQueryHandler attribute), 23
name (telegram.Bot attribute), 56 pass_groupdict (RegexHandler attribute), 27
name (telegram.ext.filters.BaseFilter attribute), 8 pass_groupdict (StringRegexHandler attribute), 31
name (telegram.OrderInfo attribute), 258 pass_groups (CallbackQueryHandler attribute), 17
name (telegram.StickerSet attribute), 261 pass_groups (InlineQueryHandler attribute), 23
name (telegram.User attribute), 114 pass_groups (RegexHandler attribute), 27
NetworkError, 94 pass_groups (StringRegexHandler attribute), 31
new_chat_member (telegram.Message attribute), 104 pass_job_queue (CallbackQueryHandler attribute), 17
new_chat_members (Message attribute), 100 pass_job_queue (ChosenInlineResultHandler attribute),
new_chat_members (telegram.ext.filters.Filters at- 18
tribute), 10 pass_job_queue (CommandHandler attribute), 21
new_chat_members (telegram.Message attribute), 236 pass_job_queue (Handler attribute), 15
new_chat_photo (Message attribute), 101 pass_job_queue (InlineQueryHandler attribute), 23
new_chat_photo (telegram.ext.filters.Filters attribute), pass_job_queue (MessageHandler attribute), 24
10 pass_job_queue (PreCheckoutQueryHandler attribute),
new_chat_photo (telegram.Message attribute), 236 26
new_chat_title (Message attribute), 101 pass_job_queue (RegexHandler attribute), 27
new_chat_title (telegram.ext.filters.Filters attribute), 10 pass_job_queue (ShippingQueryHandler attribute), 28
new_chat_title (telegram.Message attribute), 236 pass_job_queue (StringCommandHandler attribute), 30
pass_job_queue (StringRegexHandler attribute), 31
O pass_job_queue (TypeHandler attribute), 32
offset (InlineQuery attribute), 120 pass_update_queue (CallbackQueryHandler attribute),
offset (MessageEntity attribute), 108 17
offset (telegram.InlineQuery attribute), 213

276 Index
Python Telegram Bot Documentation, Release 8.0.0

pass_update_queue (ChosenInlineResultHandler photo (telegram.Chat attribute), 202

attribute), 18 photo (telegram.ext.filters.Filters attribute), 9
pass_update_queue (CommandHandler attribute), 21 photo (telegram.Game attribute), 253
pass_update_queue (Handler attribute), 15 photo (telegram.Message attribute), 236
pass_update_queue (InlineQueryHandler attribute), 23 photo_file_id (InlineQueryResultCachedPhoto at-
pass_update_queue (MessageHandler attribute), 24 tribute), 127
pass_update_queue (PreCheckoutQueryHandler photo_file_id (telegram.InlineQueryResultCachedPhoto
attribute), 26 attribute), 219
pass_update_queue (RegexHandler attribute), 27 photo_height (InlineQueryResultPhoto attribute), 136
pass_update_queue (ShippingQueryHandler attribute), photo_height (telegram.InlineQueryResultPhoto
28 attribute), 227
pass_update_queue (StringCommandHandler at- photo_url (InlineQueryResultPhoto attribute), 136
tribute), 30 photo_url (telegram.InlineQueryResultPhoto attribute),
pass_update_queue (StringRegexHandler attribute), 31 227
pass_update_queue (TypeHandler attribute), 32 photo_width (InlineQueryResultPhoto attribute), 136
pass_user_data (CallbackQueryHandler attribute), 17 photo_width (telegram.InlineQueryResultPhoto at-
pass_user_data (ChosenInlineResultHandler attribute), tribute), 227
18 photos (telegram.UserProfilePhotos attribute), 250
pass_user_data (CommandHandler attribute), 21 photos (UserProfilePhotos attribute), 114
pass_user_data (Handler attribute), 15 PhotoSize (class in telegram), 110
pass_user_data (InlineQueryHandler attribute), 23 pin_chat_message() (telegram.Bot method), 56
pass_user_data (MessageHandler attribute), 24 pinChatMessage() (telegram.Bot method), 56
pass_user_data (PreCheckoutQueryHandler attribute), pinned_message (Chat attribute), 87
26 pinned_message (Message attribute), 101
pass_user_data (RegexHandler attribute), 27 pinned_message (telegram.Chat attribute), 203
pass_user_data (ShippingQueryHandler attribute), 28 pinned_message (telegram.ext.filters.Filters attribute),
pattern (CallbackQueryHandler attribute), 17 10
pattern (InlineQueryHandler attribute), 23 pinned_message (telegram.Message attribute), 236
pattern (RegexHandler attribute), 27 point (MaskPosition attribute), 119
pattern (StringRegexHandler attribute), 31 point (telegram.MaskPosition attribute), 261
pay (InlineKeyboardButton attribute), 96 position (GameHighScore attribute), 150
pay (telegram.InlineKeyboardButton attribute), 212 position (telegram.GameHighScore attribute), 254
pending_update_count (telegram.WebhookInfo at- post_code (ShippingAddress attribute), 144
tribute), 252 post_code (telegram.ShippingAddress attribute), 257
pending_update_count (WebhookInfo attribute), 117 PRE (telegram.MessageEntity attribute), 109
per_chat (ConversationHandler attribute), 20 pre_checkout_query (telegram.Update attribute), 248
per_message (ConversationHandler attribute), 20 pre_checkout_query (Update attribute), 112
per_user (ConversationHandler attribute), 20 PreCheckoutQuery (class in telegram), 147
performer (Audio attribute), 33 PreCheckoutQueryHandler (class in telegram.ext), 26
performer (InlineQueryResultAudio attribute), 123 prices (ShippingOption attribute), 144
performer (telegram.Audio attribute), 150 prices (telegram.ShippingOption attribute), 256
performer (telegram.InlineQueryResultAudio at- PRIVATE (telegram.Chat attribute), 88
tribute), 216 private (telegram.ext.filters.Filters attribute), 9
phone_number (Contact attribute), 93 process_update() (telegram.ext.Dispatcher method), 6
phone_number (InlineQueryResultContact attribute), promote_chat_member() (telegram.Bot method), 57
130 promoteChatMember() (telegram.Bot method), 56
phone_number (InputContactMessageContent at- provider_payment_charge_id (SuccessfulPayment at-
tribute), 141 tribute), 145
phone_number (OrderInfo attribute), 144 provider_payment_charge_id (tele-
phone_number (telegram.Contact attribute), 209 gram.SuccessfulPayment attribute), 256
phone_number (telegram.InlineQueryResultContact at- put() (telegram.ext.JobQueue method), 11
tribute), 222
phone_number (telegram.InputContactMessageContent Q
attribute), 231 query (ChosenInlineResult attribute), 142
phone_number (telegram.OrderInfo attribute), 258 query (InlineQuery attribute), 120
photo (Chat attribute), 87 query (telegram.ChosenInlineResult attribute), 207
photo (Game attribute), 148 query (telegram.InlineQuery attribute), 213
photo (Message attribute), 100 queue (JobQueue attribute), 11

Index 277
Python Telegram Bot Documentation, Release 8.0.0

R reply_markup (telegram.InlineQueryResultCachedGif
RECORD_AUDIO (telegram.ChatAction attribute), 90 attribute), 218
RECORD_VIDEO (telegram.ChatAction attribute), 90 reply_markup (telegram.InlineQueryResultCachedMpeg4Gif
RECORD_VIDEO_NOTE (telegram.ChatAction at- attribute), 219
tribute), 90 reply_markup (telegram.InlineQueryResultCachedPhoto
RegexHandler (class in telegram.ext), 27 attribute), 219
remove_error_handler() (telegram.ext.Dispatcher reply_markup (telegram.InlineQueryResultCachedSticker
method), 6 attribute), 220
remove_handler() (telegram.ext.Dispatcher method), 7 reply_markup (telegram.InlineQueryResultCachedVideo
remove_keyboard (ReplyKeyboardRemove attribute), attribute), 221
110 reply_markup (telegram.InlineQueryResultCachedVoice
remove_keyboard (telegram.ReplyKeyboardRemove attribute), 222
attribute), 245 reply_markup (telegram.InlineQueryResultContact at-
reply (telegram.ext.filters.Filters attribute), 9 tribute), 222
reply_audio() (telegram.Message method), 105 reply_markup (telegram.InlineQueryResultDocument
reply_contact() (telegram.Message method), 105 attribute), 223
reply_document() (telegram.Message method), 106 reply_markup (telegram.InlineQueryResultGame at-
reply_location() (telegram.Message method), 106 tribute), 231
reply_markup (InlineQueryResultArticle attribute), 122 reply_markup (telegram.InlineQueryResultGif at-
reply_markup (InlineQueryResultAudio attribute), 123 tribute), 225
reply_markup (InlineQueryResultCachedAudio at- reply_markup (telegram.InlineQueryResultLocation at-
tribute), 123 tribute), 225
reply_markup (InlineQueryResultCachedDocument at- reply_markup (telegram.InlineQueryResultMpeg4Gif
tribute), 124 attribute), 227
reply_markup (InlineQueryResultCachedGif attribute), reply_markup (telegram.InlineQueryResultPhoto at-
125 tribute), 228
reply_markup (InlineQueryResultCachedMpeg4Gif at- reply_markup (telegram.InlineQueryResultVenue at-
tribute), 126 tribute), 228
reply_markup (InlineQueryResultCachedPhoto at- reply_markup (telegram.InlineQueryResultVideo at-
tribute), 127 tribute), 230
reply_markup (InlineQueryResultCachedSticker reply_markup (telegram.InlineQueryResultVoice at-
attribute), 127 tribute), 231
reply_markup (InlineQueryResultCachedVideo at- reply_photo() (telegram.Message method), 106
tribute), 128 reply_sticker() (telegram.Message method), 106
reply_markup (InlineQueryResultCachedVoice at- reply_text() (telegram.Message method), 106
tribute), 129 reply_to_message (Message attribute), 100
reply_markup (InlineQueryResultContact attribute), reply_to_message (telegram.Message attribute), 235
130 reply_venue() (telegram.Message method), 107
reply_markup (InlineQueryResultDocument attribute), reply_video() (telegram.Message method), 107
131 reply_video_note() (telegram.Message method), 107
reply_markup (InlineQueryResultGame attribute), 132 reply_voice() (telegram.Message method), 107
reply_markup (InlineQueryResultGif attribute), 133 ReplyKeyboardMarkup (class in telegram), 111
reply_markup (InlineQueryResultLocation attribute), ReplyKeyboardRemove (class in telegram), 110
134 ReplyMarkup (class in telegram), 111
reply_markup (InlineQueryResultMpeg4Gif attribute), request_contact (KeyboardButton attribute), 98
135 request_contact (telegram.KeyboardButton attribute),
reply_markup (InlineQueryResultPhoto attribute), 136 234
reply_markup (InlineQueryResultVenue attribute), 137 request_location (KeyboardButton attribute), 98
reply_markup (InlineQueryResultVideo attribute), 138 request_location (telegram.KeyboardButton attribute),
reply_markup (InlineQueryResultVoice attribute), 139 234
reply_markup (telegram.InlineQueryResultArticle at- resize_keyboard (ReplyKeyboardMarkup attribute),
tribute), 215 111
reply_markup (telegram.InlineQueryResultAudio at- resize_keyboard (telegram.ReplyKeyboardMarkup at-
tribute), 216 tribute), 245
reply_markup (telegram.InlineQueryResultCachedAudio restrict_chat_member() (telegram.Bot method), 58
attribute), 216 restrictChatMember() (telegram.Bot method), 58
reply_markup (telegram.InlineQueryResultCachedDocument RESTRICTED (telegram.ChatMember attribute), 92
attribute), 217 result_id (ChosenInlineResult attribute), 142

278 Index
Python Telegram Bot Documentation, Release 8.0.0

result_id (telegram.ChosenInlineResult attribute), 207

set_name (telegram.Sticker attribute), 247
RetryAfter, 94 set_sticker_position_in_set() (telegram.Bot method),
run() (telegram.ext.DelayQueue method), 15 81
run_async() (telegram.ext.Dispatcher method), 7 set_webhook() (telegram.Bot method), 82
run_async_timeout (ConversationHandler attribute), 20
setChatDescription() (telegram.Bot method), 77
run_daily() (telegram.ext.JobQueue method), 11 setChatPhoto() (telegram.Bot method), 77
run_once() (telegram.ext.JobQueue method), 12 setChatTitle() (telegram.Bot method), 77
run_repeating() (telegram.ext.JobQueue method), 12 setGameScore() (telegram.Bot method), 78
running (telegram.ext.Dispatcher attribute), 7 setStickerPositionInSet() (telegram.Bot method), 78
running (Updater attribute), 3 setWebhook() (telegram.Bot method), 79
shipping_address (OrderInfo attribute), 144
S shipping_address (ShippingQuery attribute), 146
scale (MaskPosition attribute), 119 shipping_address (telegram.OrderInfo attribute), 258
scale (telegram.MaskPosition attribute), 261 shipping_address (telegram.ShippingQuery attribute),
score (GameHighScore attribute), 150 259
score (telegram.GameHighScore attribute), 254 shipping_option_id (PreCheckoutQuery attribute), 147
selective (ForceReply attribute), 96 shipping_option_id (SuccessfulPayment attribute), 145
selective (ReplyKeyboardMarkup attribute), 111 shipping_option_id (telegram.PreCheckoutQuery at-
selective (ReplyKeyboardRemove attribute), 110 tribute), 257
selective (telegram.ForceReply attribute), 211 shipping_option_id (telegram.SuccessfulPayment at-
selective (telegram.ReplyKeyboardMarkup attribute), tribute), 255
246 shipping_query (telegram.Update attribute), 248
selective (telegram.ReplyKeyboardRemove attribute), shipping_query (Update attribute), 112
245 ShippingAddress (class in telegram), 143
send_action() (telegram.Chat method), 89 ShippingOption (class in telegram), 144
send_audio() (telegram.Bot method), 68 ShippingQuery (class in telegram), 146
send_chat_action() (telegram.Bot method), 68 ShippingQueryHandler (class in telegram.ext), 28
send_contact() (telegram.Bot method), 69 small_file_id (ChatPhoto attribute), 92
send_document() (telegram.Bot method), 69 small_file_id (telegram.ChatPhoto attribute), 260
send_game() (telegram.Bot method), 70 start() (telegram.ext.Dispatcher method), 7
send_invoice() (telegram.Bot method), 71 start() (telegram.ext.JobQueue method), 13
send_location() (telegram.Bot method), 72 start() (telegram.ext.MessageQueue method), 14
send_message() (telegram.Bot method), 72 start_parameter (Invoice attribute), 143
send_photo() (telegram.Bot method), 73 start_parameter (telegram.Invoice attribute), 259
send_sticker() (telegram.Bot method), 73 start_polling() (telegram.ext.Updater method), 4
send_venue() (telegram.Bot method), 74 start_webhook() (telegram.ext.Updater method), 4
send_video() (telegram.Bot method), 75 state (ShippingAddress attribute), 143
send_video_note() (telegram.Bot method), 75 state (telegram.ShippingAddress attribute), 256
send_voice() (telegram.Bot method), 76 states (ConversationHandler attribute), 20
sendAudio() (telegram.Bot method), 59 status (ChatMember attribute), 90
sendChatAction() (telegram.Bot method), 60 status (telegram.ChatMember attribute), 204
sendContact() (telegram.Bot method), 60 status_update (telegram.ext.filters.Filters attribute), 9
sendDocument() (telegram.Bot method), 61 Sticker (class in telegram), 118
sendGame() (telegram.Bot method), 61 sticker (Message attribute), 100
sendInvoice() (telegram.Bot method), 62 sticker (telegram.ext.filters.Filters attribute), 10
sendLocation() (telegram.Bot method), 63 sticker (telegram.Message attribute), 236
sendMessage() (telegram.Bot method), 63 sticker_file_id (InlineQueryResultCachedSticker
sendPhoto() (telegram.Bot method), 64 attribute), 127
sendSticker() (telegram.Bot method), 64 sticker_file_id (telegram.InlineQueryResultCachedSticker
sendVenue() (telegram.Bot method), 65 attribute), 220
sendVideo() (telegram.Bot method), 66 stickers (StickerSet attribute), 119
sendVideoNote() (telegram.Bot method), 66 stickers (telegram.StickerSet attribute), 261
sendVoice() (telegram.Bot method), 67 StickerSet (class in telegram), 118
set_chat_description() (telegram.Bot method), 80 stop() (telegram.ext.DelayQueue method), 15
set_chat_photo() (telegram.Bot method), 80 stop() (telegram.ext.Dispatcher method), 7
set_chat_title() (telegram.Bot method), 80 stop() (telegram.ext.JobQueue method), 13
set_game_score() (telegram.Bot method), 81 stop() (telegram.ext.MessageQueue method), 14
set_name (Sticker attribute), 118 stop() (telegram.ext.Updater method), 5

Index 279
Python Telegram Bot Documentation, Release 8.0.0

street_line1 (ShippingAddress attribute), 143 thumb (Document attribute), 94

street_line1 (telegram.ShippingAddress attribute), 257 thumb (Sticker attribute), 118
street_line2 (ShippingAddress attribute), 143 thumb (telegram.Animation attribute), 252
street_line2 (telegram.ShippingAddress attribute), 257 thumb (telegram.Document attribute), 210
strict (TypeHandler attribute), 32 thumb (telegram.Sticker attribute), 246
StringCommandHandler (class in telegram.ext), 29 thumb (telegram.Video attribute), 251
StringRegexHandler (class in telegram.ext), 30 thumb (telegram.VideoNote attribute), 255
successful_payment (Message attribute), 101 thumb (Video attribute), 115
successful_payment (telegram.ext.filters.Filters at- thumb (VideoNote attribute), 116
tribute), 10 thumb_height (InlineQueryResultArticle attribute), 122
successful_payment (telegram.Message attribute), 236 thumb_height (InlineQueryResultContact attribute),
SuccessfulPayment (class in telegram), 145 130
SUPERGROUP (telegram.Chat attribute), 88 thumb_height (InlineQueryResultDocument attribute),
supergroup_chat_created (Message attribute), 101 131
supergroup_chat_created (telegram.Message attribute), thumb_height (InlineQueryResultLocation attribute),
236 134
SUPPORTED_WEBHOOK_PORTS (in module tele- thumb_height (InlineQueryResultVenue attribute), 137
gram.constants), 93 thumb_height (telegram.InlineQueryResultArticle at-
switch_inline_query (InlineKeyboardButton attribute), tribute), 215
96 thumb_height (telegram.InlineQueryResultContact at-
switch_inline_query (telegram.InlineKeyboardButton tribute), 223
attribute), 212 thumb_height (telegram.InlineQueryResultDocument
switch_inline_query_current_chat (InlineKeyboard- attribute), 224
Button attribute), 96 thumb_height (telegram.InlineQueryResultLocation at-
switch_inline_query_current_chat (tele- tribute), 226
gram.InlineKeyboardButton attribute), thumb_height (telegram.InlineQueryResultVenue at-
212 tribute), 229
thumb_url (InlineQueryResultArticle attribute), 122
T thumb_url (InlineQueryResultContact attribute), 130
telegram.constants (module), 92 thumb_url (InlineQueryResultDocument attribute), 131
telegram.error (module), 94 thumb_url (InlineQueryResultGif attribute), 133
telegram.ext.filters (module), 7 thumb_url (InlineQueryResultLocation attribute), 134
telegram_payment_charge_id (SuccessfulPayment at- thumb_url (InlineQueryResultMpeg4Gif attribute), 135
tribute), 145 thumb_url (InlineQueryResultPhoto attribute), 136
telegram_payment_charge_id (tele- thumb_url (InlineQueryResultVenue attribute), 137
gram.SuccessfulPayment attribute), 256 thumb_url (InlineQueryResultVideo attribute), 138
TelegramError, 94 thumb_url (telegram.InlineQueryResultArticle at-
TelegramObject (class in telegram), 112 tribute), 215
text (Game attribute), 148 thumb_url (telegram.InlineQueryResultContact at-
text (InlineKeyboardButton attribute), 96 tribute), 222
text (KeyboardButton attribute), 98 thumb_url (telegram.InlineQueryResultDocument at-
text (Message attribute), 100 tribute), 223
text (telegram.ext.filters.Filters attribute), 10 thumb_url (telegram.InlineQueryResultGif attribute),
text (telegram.Game attribute), 253 224
text (telegram.InlineKeyboardButton attribute), 212 thumb_url (telegram.InlineQueryResultLocation
text (telegram.KeyboardButton attribute), 234 attribute), 225
text (telegram.Message attribute), 235 thumb_url (telegram.InlineQueryResultMpeg4Gif at-
text_entities (Game attribute), 148 tribute), 226
text_entities (telegram.Game attribute), 253 thumb_url (telegram.InlineQueryResultPhoto at-
text_html (telegram.Message attribute), 107 tribute), 227
text_html_urled (telegram.Message attribute), 108 thumb_url (telegram.InlineQueryResultVenue at-
TEXT_LINK (telegram.MessageEntity attribute), 109 tribute), 229
text_markdown (telegram.Message attribute), 108 thumb_url (telegram.InlineQueryResultVideo at-
text_markdown_urled (telegram.Message attribute), tribute), 229
108 thumb_width (InlineQueryResultArticle attribute), 122
TEXT_MENTION (telegram.MessageEntity attribute), thumb_width (InlineQueryResultContact attribute), 130
109 thumb_width (InlineQueryResultDocument attribute),
thumb (Animation attribute), 149 131

280 Index
Python Telegram Bot Documentation, Release 8.0.0

thumb_width (InlineQueryResultLocation attribute), title (telegram.InlineQueryResultCachedVoice at-

134 tribute), 222
thumb_width (InlineQueryResultVenue attribute), 137 title (telegram.InlineQueryResultDocument attribute),
thumb_width (telegram.InlineQueryResultArticle at- 223
tribute), 215 title (telegram.InlineQueryResultGif attribute), 224
thumb_width (telegram.InlineQueryResultContact at- title (telegram.InlineQueryResultLocation attribute),
tribute), 222 225
thumb_width (telegram.InlineQueryResultDocument title (telegram.InlineQueryResultMpeg4Gif attribute),
attribute), 224 226
thumb_width (telegram.InlineQueryResultLocation at- title (telegram.InlineQueryResultPhoto attribute), 227
tribute), 226 title (telegram.InlineQueryResultVenue attribute), 228
thumb_width (telegram.InlineQueryResultVenue title (telegram.InlineQueryResultVideo attribute), 229
attribute), 229 title (telegram.InlineQueryResultVoice attribute), 230
tick() (telegram.ext.JobQueue method), 13 title (telegram.InputVenueMessageContent attribute),
time_limit (DelayQueue attribute), 14 233
timed_out_behavior (ConversationHandler attribute), title (telegram.Invoice attribute), 259
20 title (telegram.ShippingOption attribute), 256
TimedOut, 94 title (telegram.StickerSet attribute), 261
title (Audio attribute), 33 title (telegram.Venue attribute), 250
title (Chat attribute), 87 title (Venue attribute), 115
title (Game attribute), 148 to_form() (telegram.InputFile method), 98
title (InlineQueryResultArticle attribute), 121 to_json() (telegram.TelegramObject method), 112
title (InlineQueryResultAudio attribute), 122 total_amount (Invoice attribute), 143
title (InlineQueryResultCachedDocument attribute), total_amount (PreCheckoutQuery attribute), 147
124 total_amount (SuccessfulPayment attribute), 145
title (InlineQueryResultCachedGif attribute), 125 total_amount (telegram.Invoice attribute), 259
title (InlineQueryResultCachedMpeg4Gif attribute), total_amount (telegram.PreCheckoutQuery attribute),
126 257
title (InlineQueryResultCachedPhoto attribute), 127 total_amount (telegram.SuccessfulPayment attribute),
title (InlineQueryResultCachedVideo attribute), 128 255
title (InlineQueryResultCachedVoice attribute), 129 total_count (telegram.UserProfilePhotos attribute), 250
title (InlineQueryResultDocument attribute), 131 total_count (UserProfilePhotos attribute), 114
title (InlineQueryResultGif attribute), 133 type (Chat attribute), 87
title (InlineQueryResultLocation attribute), 134 type (InlineQueryResult attribute), 121
title (InlineQueryResultMpeg4Gif attribute), 135 type (InlineQueryResultArticle attribute), 121
title (InlineQueryResultPhoto attribute), 136 type (InlineQueryResultAudio attribute), 122
title (InlineQueryResultVenue attribute), 137 type (InlineQueryResultCachedAudio attribute), 123
title (InlineQueryResultVideo attribute), 138 type (InlineQueryResultCachedDocument attribute),
title (InlineQueryResultVoice attribute), 139 124
title (InputVenueMessageContent attribute), 141 type (InlineQueryResultCachedGif attribute), 125
title (Invoice attribute), 143 type (InlineQueryResultCachedMpeg4Gif attribute),
title (ShippingOption attribute), 144 126
title (StickerSet attribute), 119 type (InlineQueryResultCachedPhoto attribute), 126
title (telegram.Audio attribute), 150 type (InlineQueryResultCachedSticker attribute), 127
title (telegram.Chat attribute), 202 type (InlineQueryResultCachedVideo attribute), 128
title (telegram.Game attribute), 253 type (InlineQueryResultCachedVoice attribute), 129
title (telegram.InlineQueryResultArticle attribute), 215 type (InlineQueryResultContact attribute), 130
title (telegram.InlineQueryResultAudio attribute), 216 type (InlineQueryResultDocument attribute), 131
title (telegram.InlineQueryResultCachedDocument at- type (InlineQueryResultGame attribute), 132
tribute), 217 type (InlineQueryResultGif attribute), 132
title (telegram.InlineQueryResultCachedGif attribute), type (InlineQueryResultLocation attribute), 133
218 type (InlineQueryResultMpeg4Gif attribute), 134
title (telegram.InlineQueryResultCachedMpeg4Gif at- type (InlineQueryResultPhoto attribute), 135
tribute), 219 type (InlineQueryResultVenue attribute), 137
title (telegram.InlineQueryResultCachedPhoto at- type (InlineQueryResultVideo attribute), 138
tribute), 219 type (InlineQueryResultVoice attribute), 139
title (telegram.InlineQueryResultCachedVideo at- type (MessageEntity attribute), 108
tribute), 221 type (telegram.Chat attribute), 202

Index 281
Python Telegram Bot Documentation, Release 8.0.0

type (telegram.InlineQueryResult attribute), 214 UPLOAD_VIDEO (telegram.ChatAction attribute), 90

type (telegram.InlineQueryResultArticle attribute), 214 UPLOAD_VIDEO_NOTE (telegram.ChatAction at-
type (telegram.InlineQueryResultAudio attribute), 215 tribute), 90
type (telegram.InlineQueryResultCachedAudio at- uploadStickerFile() (telegram.Bot method), 84
tribute), 216 url (InlineKeyboardButton attribute), 96
type (telegram.InlineQueryResultCachedDocument at- url (InlineQueryResultArticle attribute), 122
tribute), 217 url (MessageEntity attribute), 108
type (telegram.InlineQueryResultCachedGif attribute), url (telegram.InlineKeyboardButton attribute), 212
218 url (telegram.InlineQueryResultArticle attribute), 215
type (telegram.InlineQueryResultCachedMpeg4Gif at- URL (telegram.MessageEntity attribute), 109
tribute), 218 url (telegram.MessageEntity attribute), 244
type (telegram.InlineQueryResultCachedPhoto at- url (telegram.WebhookInfo attribute), 252
tribute), 219 url (WebhookInfo attribute), 117
type (telegram.InlineQueryResultCachedSticker user (ChatMember attribute), 90
attribute), 220 User (class in telegram), 113
type (telegram.InlineQueryResultCachedVideo at- user (GameHighScore attribute), 150
tribute), 221 user (MessageEntity attribute), 108
type (telegram.InlineQueryResultCachedVoice at- user (telegram.ChatMember attribute), 204
tribute), 221 user (telegram.GameHighScore attribute), 254
type (telegram.InlineQueryResultContact attribute), user (telegram.MessageEntity attribute), 244
222 user_data (telegram.ext.Dispatcher attribute), 7
type (telegram.InlineQueryResultDocument attribute), user_id (Contact attribute), 93
223 user_id (telegram.Contact attribute), 209
type (telegram.InlineQueryResultGame attribute), 231 user_sig_handler (Updater attribute), 3
type (telegram.InlineQueryResultGif attribute), 224 username (Chat attribute), 87
type (telegram.InlineQueryResultLocation attribute), username (telegram.Bot attribute), 85
225 username (telegram.Chat attribute), 202
type (telegram.InlineQueryResultMpeg4Gif attribute), username (telegram.User attribute), 249
226 username (User attribute), 113
type (telegram.InlineQueryResultPhoto attribute), 227 UserProfilePhotos (class in telegram), 114
type (telegram.InlineQueryResultVenue attribute), 228
type (telegram.InlineQueryResultVideo attribute), 229 V
type (telegram.InlineQueryResultVoice attribute), 230 Venue (class in telegram), 115
type (telegram.MessageEntity attribute), 243 venue (Message attribute), 100
type (TypeHandler attribute), 32 venue (telegram.ext.filters.Filters attribute), 10
TypeHandler (class in telegram.ext), 32 venue (telegram.Message attribute), 236
TYPING (telegram.ChatAction attribute), 90 Video (class in telegram), 115
video (Message attribute), 100
U video (telegram.ext.filters.Filters attribute), 10
Unauthorized, 94 video (telegram.Message attribute), 236
unban_chat_member() (telegram.Bot method), 83 video_duration (InlineQueryResultVideo attribute), 138
unban_member() (telegram.Chat method), 89 video_duration (telegram.InlineQueryResultVideo at-
unbanChatMember() (telegram.Bot method), 83 tribute), 230
unpin_chat_message() (telegram.Bot method), 84 video_file_id (InlineQueryResultCachedVideo at-
unpinChatMessage() (telegram.Bot method), 83 tribute), 128
until_date (ChatMember attribute), 90 video_file_id (telegram.InlineQueryResultCachedVideo
until_date (telegram.ChatMember attribute), 205 attribute), 221
Update (class in telegram), 112 video_height (InlineQueryResultVideo attribute), 138
update_id (telegram.Update attribute), 247 video_height (telegram.InlineQueryResultVideo
update_id (Update attribute), 112 attribute), 230
update_queue (Dispatcher attribute), 5 video_note (Message attribute), 100
update_queue (Updater attribute), 3 video_note (telegram.Message attribute), 236
Updater (class in telegram.ext), 3 video_url (InlineQueryResultVideo attribute), 138
UPLOAD_AUDIO (telegram.ChatAction attribute), 90 video_url (telegram.InlineQueryResultVideo attribute),
UPLOAD_DOCUMENT (telegram.ChatAction at- 229
tribute), 90 video_width (InlineQueryResultVideo attribute), 138
UPLOAD_PHOTO (telegram.ChatAction attribute), 90 video_width (telegram.InlineQueryResultVideo at-
upload_sticker_file() (telegram.Bot method), 84 tribute), 230

282 Index
Python Telegram Bot Documentation, Release 8.0.0

VideoNote (class in telegram), 116

Voice (class in telegram), 116
voice (Message attribute), 100
voice (telegram.ext.filters.Filters attribute), 10
voice (telegram.Message attribute), 236
voice_duration (InlineQueryResultVoice attribute), 139
voice_duration (telegram.InlineQueryResultVoice at-
tribute), 231
voice_file_id (InlineQueryResultCachedVoice at-
tribute), 129
voice_file_id (telegram.InlineQueryResultCachedVoice
attribute), 221
voice_url (InlineQueryResultVoice attribute), 139
voice_url (telegram.InlineQueryResultVoice attribute),
230

W
WebhookInfo (class in telegram), 117
width (PhotoSize attribute), 110
width (Sticker attribute), 118
width (telegram.PhotoSize attribute), 245
width (telegram.Sticker attribute), 246
width (telegram.Video attribute), 251
width (Video attribute), 115
workers (Dispatcher attribute), 5

X
x_shift (MaskPosition attribute), 119
x_shift (telegram.MaskPosition attribute), 261

Y
y_shift (MaskPosition attribute), 119
y_shift (telegram.MaskPosition attribute), 261

Index 283

Dr. Debra Ann Poole PHD - Interviewing Children - The Science of Conversation in Forensic Contexts-American Psychological Association (2016) (Z-Lib - Io)
100% (2)
Dr. Debra Ann Poole PHD - Interviewing Children - The Science of Conversation in Forensic Contexts-American Psychological Association (2016) (Z-Lib - Io)
244 pages
bypass-any-otp-hackers-pathway-to-bypass
100% (1)
bypass-any-otp-hackers-pathway-to-bypass
45 pages
Paypal 2FA Bypass HQ Guide
No ratings yet
Paypal 2FA Bypass HQ Guide
1 page
100+ Webmail Good
No ratings yet
100+ Webmail Good
2 pages
Book AngelsBook of Angels
95% (22)
Book AngelsBook of Angels
104 pages
The Config Guide
No ratings yet
The Config Guide
21 pages
Strox - Su: Best Platform
No ratings yet
Strox - Su: Best Platform
22 pages
Python Telegram Bot
No ratings yet
Python Telegram Bot
256 pages
BUS353 Project Management
No ratings yet
BUS353 Project Management
25 pages
Library Visit Assignment
100% (1)
Library Visit Assignment
8 pages
OtPokemon Spawn Locations - Kanto
No ratings yet
OtPokemon Spawn Locations - Kanto
6 pages
Package Telegram - Bot': R Topics Documented
No ratings yet
Package Telegram - Bot': R Topics Documented
56 pages
Writing Telegram Bots On Java
No ratings yet
Writing Telegram Bots On Java
66 pages
Personal Assistant With Telegram & Arduino
No ratings yet
Personal Assistant With Telegram & Arduino
8 pages
METHOD TikTok USA Post To American TikTok From PC - Create USA TikTok Accounts
No ratings yet
METHOD TikTok USA Post To American TikTok From PC - Create USA TikTok Accounts
5 pages
Telegram Case Study
No ratings yet
Telegram Case Study
11 pages
Free Temporary Phone Numbers For SMS Verification Receive SMS Online - Quackr
No ratings yet
Free Temporary Phone Numbers For SMS Verification Receive SMS Online - Quackr
1 page
Am
No ratings yet
Am
7 pages
All Links
No ratings yet
All Links
4 pages
Premium Facebook
No ratings yet
Premium Facebook
9 pages
Fake Shops Stay Safe
No ratings yet
Fake Shops Stay Safe
1 page
Extrators
No ratings yet
Extrators
2 pages
Telegram Bot API
No ratings yet
Telegram Bot API
57 pages
Email Hacking
No ratings yet
Email Hacking
96 pages
Insta Bot: Technology Workshop Craft Home Food Play Outside Costumes
No ratings yet
Insta Bot: Technology Workshop Craft Home Food Play Outside Costumes
5 pages
How to start Cracking With OpenBullet
No ratings yet
How to start Cracking With OpenBullet
2 pages
chatbot data
No ratings yet
chatbot data
15 pages
Loans to apply if you have credit score lower than 700
No ratings yet
Loans to apply if you have credit score lower than 700
15 pages
OTP Verification System
No ratings yet
OTP Verification System
6 pages
Single Sign On
No ratings yet
Single Sign On
8 pages
Redline Stealer Tut
No ratings yet
Redline Stealer Tut
2 pages
Tax Refund 2023 2
No ratings yet
Tax Refund 2023 2
131 pages
Url Log Pass - Free
No ratings yet
Url Log Pass - Free
11,114 pages
War Bot Net Tu T
No ratings yet
War Bot Net Tu T
3 pages
Otp Bot Zelle Tut
No ratings yet
Otp Bot Zelle Tut
1 page
SMS Spamming
No ratings yet
SMS Spamming
3 pages
G2 AMethod Tut
No ratings yet
G2 AMethod Tut
10 pages
CLeechurl
No ratings yet
CLeechurl
6 pages
How to open up Bank of America pdf thesaint
No ratings yet
How to open up Bank of America pdf thesaint
4 pages
⚡ HOW TO INSTANTLY CRACK TIKTOK ACCOUNTS ⚡ #1 ✅
No ratings yet
⚡ HOW TO INSTANTLY CRACK TIKTOK ACCOUNTS ⚡ #1 ✅
10 pages
Square 1$
100% (1)
Square 1$
4 pages
TUTS From Discord
100% (1)
TUTS From Discord
17 pages
HVNC Rat and Crypter Method
No ratings yet
HVNC Rat and Crypter Method
5 pages
S0nic Free Instagram Followers Generator 2020 PDF
100% (1)
S0nic Free Instagram Followers Generator 2020 PDF
2 pages
CHAT GPT 4o
No ratings yet
CHAT GPT 4o
3 pages
Checkbook Scope
No ratings yet
Checkbook Scope
2 pages
Phishing
0% (1)
Phishing
3 pages
Telegram Address
No ratings yet
Telegram Address
3 pages
DMM BIBLE
100% (1)
DMM BIBLE
118 pages
STEP 1:: Inurl:ftp "Password" Filetype:xls
No ratings yet
STEP 1:: Inurl:ftp "Password" Filetype:xls
5 pages
Email Spam Teacher File 13 07 2014
No ratings yet
Email Spam Teacher File 13 07 2014
7 pages
Group Crack Spam Hack
No ratings yet
Group Crack Spam Hack
6 pages
Spamm Tut Text
100% (1)
Spamm Tut Text
2 pages
100K MailAccess HQ Database
No ratings yet
100K MailAccess HQ Database
1,742 pages
ElevenLabs Voice Design Preview 2023-04-18T10!14!58.375Z
0% (1)
ElevenLabs Voice Design Preview 2023-04-18T10!14!58.375Z
3 pages
Paypal
No ratings yet
Paypal
79 pages
AT&T 0 PAYMENT iPHONE STEPS _LUCIFER
No ratings yet
AT&T 0 PAYMENT iPHONE STEPS _LUCIFER
14 pages
How To Hack Databases
No ratings yet
How To Hack Databases
11 pages
WWW Camwhores
No ratings yet
WWW Camwhores
251 pages
Shopwithscrip Log Are Available For Purchase @
No ratings yet
Shopwithscrip Log Are Available For Purchase @
1 page
Employment Part 3
No ratings yet
Employment Part 3
53 pages
InstaFollowers Trick by Telegram@FantabulousTV
No ratings yet
InstaFollowers Trick by Telegram@FantabulousTV
1 page
Python Telegram Bot
No ratings yet
Python Telegram Bot
305 pages
Python Telegram Bot Readthedocs Io en Stable
No ratings yet
Python Telegram Bot Readthedocs Io en Stable
282 pages
python-telegram-bot-readthedocs-io-en-stable
No ratings yet
python-telegram-bot-readthedocs-io-en-stable
284 pages
Fundamentals of The Mechanics of Conscious Creation by Mohsen Paul Sarfarazi, Ph.D. - Multidimensional Consciousness
No ratings yet
Fundamentals of The Mechanics of Conscious Creation by Mohsen Paul Sarfarazi, Ph.D. - Multidimensional Consciousness
18 pages
Business Management
No ratings yet
Business Management
2 pages
Hired For The Boss Bedroom
No ratings yet
Hired For The Boss Bedroom
181 pages
Accounting 52 Project Harry's Hamburger
No ratings yet
Accounting 52 Project Harry's Hamburger
3 pages
O&m Vsa 800-1000-1200 - en
No ratings yet
O&m Vsa 800-1000-1200 - en
53 pages
Fundamental Principle of Counting: Techniques/Methods
No ratings yet
Fundamental Principle of Counting: Techniques/Methods
12 pages
6 OS - PPT Compatibility Mode
No ratings yet
6 OS - PPT Compatibility Mode
33 pages
Multi-Analyte ELISArray
No ratings yet
Multi-Analyte ELISArray
1 page
Chipinge and Chimanimani Evaluation Report PDF
No ratings yet
Chipinge and Chimanimani Evaluation Report PDF
54 pages
Irins Expert Advisor v1.8 Manual File
No ratings yet
Irins Expert Advisor v1.8 Manual File
6 pages
Guidelines For Strategic Management Paper Oral Defense For The Panel Members
No ratings yet
Guidelines For Strategic Management Paper Oral Defense For The Panel Members
4 pages
Chapter 6: Wave: 6.1 Understanding Waves
No ratings yet
Chapter 6: Wave: 6.1 Understanding Waves
35 pages
Portal Frame
No ratings yet
Portal Frame
6 pages
1 1 Keyterms
No ratings yet
1 1 Keyterms
2 pages
Algebra Cheat Sheet: Basic Properties & Facts
No ratings yet
Algebra Cheat Sheet: Basic Properties & Facts
4 pages
UNIT 3 - Voice Your Mind in A Small Country Called A Class
No ratings yet
UNIT 3 - Voice Your Mind in A Small Country Called A Class
10 pages
IPPTCh 005
No ratings yet
IPPTCh 005
65 pages
Long Intl Intro To CII Adv Work Packaging-An Industry Best Practice
No ratings yet
Long Intl Intro To CII Adv Work Packaging-An Industry Best Practice
15 pages
Solution Manual Adms 2320 PDF
No ratings yet
Solution Manual Adms 2320 PDF
869 pages
LSS Roadmap
No ratings yet
LSS Roadmap
8 pages
Svm/Svmi E-Series Prompts and Prompts Utility: Voice Studio
No ratings yet
Svm/Svmi E-Series Prompts and Prompts Utility: Voice Studio
27 pages
Financial Times Top 50 Journals Used in Business School Research Rankings - McMaster University Library, Hamilton, Ontario, Canada
No ratings yet
Financial Times Top 50 Journals Used in Business School Research Rankings - McMaster University Library, Hamilton, Ontario, Canada
7 pages
Proposal Letter of Internship
No ratings yet
Proposal Letter of Internship
5 pages
Understanding The Self: Introduction and Module 1 "Getting To Know You: My Home, My School"
No ratings yet
Understanding The Self: Introduction and Module 1 "Getting To Know You: My Home, My School"
10 pages
The Nation - November 13-20 2023
No ratings yet
The Nation - November 13-20 2023
50 pages