telegram package¶

Submodules¶

Module contents¶

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

class telegram.Audio(file_id, duration, performer='', title='', mime_type='', file_size=0, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram Audio.

file_id¶: str

duration¶: int

performer¶: str

title¶: str

mime_type¶: str

file_size¶: int

Parameters:	file_id (str) – duration (int) – performer (Optional[str]) – title (Optional[str]) – mime_type (Optional[str]) – file_size (Optional[int]) – **kwargs – Arbitrary keyword arguments.

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.Audio

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

Bases: telegram.base.TelegramObject

This object represents a Telegram Bot.

id¶: int – Unique identifier for this bot.

first_name¶: str – Bot’s first name.

last_name¶: str – Bot’s last name.

username¶: str – Bot’s username.

name¶: str – Bot’s @username.

Parameters:	token (str) – Bot’s unique authentication. base_url (Optional[str]) – Telegram Bot API service URL. base_file_url (Optional[str]) – Telegram Bot API file URL. request (Optional[Request]) – Pre initialized Request class.

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.

Parameters:	callback_query_id (str) – Unique identifier for the query to be answered. text (Optional[str]) – Text of the notification. If not specified, nothing will be shown to the user. show_alert (Optional[bool]) – 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 (Optional[str]) – URL that will be opened by the user’s client. cache_time (Optional[int]) – The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, True is returned.
Return type:	bool
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 inline query. cache_time (Optional[int]) – The maximum amount of time the result of the inline query may be cached on the server. is_personal (Optional[bool]) – 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 (Optional[str]) – Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don’t support pagination. Offset length can’t exceed 64 bytes. switch_pm_text (Optional[str]) – 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 (Optional[str]) – Parameter for the start message sent to the bot when user presses the switch button. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, True is returned.
Return type:	bool
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.

Parameters:	callback_query_id (str) – Unique identifier for the query to be answered. text (Optional[str]) – Text of the notification. If not specified, nothing will be shown to the user. show_alert (Optional[bool]) – 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 (Optional[str]) – URL that will be opened by the user’s client. cache_time (Optional[int]) – The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, True is returned.
Return type:	bool
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 inline query. cache_time (Optional[int]) – The maximum amount of time the result of the inline query may be cached on the server. is_personal (Optional[bool]) – 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 (Optional[str]) – Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don’t support pagination. Offset length can’t exceed 64 bytes. switch_pm_text (Optional[str]) – 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 (Optional[str]) – Parameter for the start message sent to the bot when user presses the switch button. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, True is returned.
Return type:	bool
Raises:	`telegram.TelegramError`

static de_json(data, bot)¶

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 (Optional[str]) – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername). message_id (Optional[str]) – Required if inline_message_id is not specified. Unique identifier of the sent message. inline_message_id (Optional[str]) – Required if chat_id and message_id are not specified. Identifier of the inline message. caption (Optional[str]) – New caption of the message. reply_markup (Optional[`telegram.InlineKeyboardMarkup`]) – A JSON-serialized object for an inline keyboard. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *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 (Optional[str]) – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername). message_id (Optional[str]) – Required if inline_message_id is not specified. Unique identifier of the sent message. inline_message_id (Optional[str]) – Required if chat_id and message_id are not specified. Identifier of the inline message. reply_markup (Optional[`telegram.InlineKeyboardMarkup`]) – A JSON-serialized object for an inline keyboard. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *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`

editMessageText(*args, **kwargs)¶

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

Parameters:	text – New text of the message. chat_id – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername). message_id – Required if inline_message_id is not specified. Unique identifier of the sent message. inline_message_id – Required if chat_id and message_id are not specified. Identifier of the inline message. parse_mode – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot’s message. disable_web_page_preview – Disables link previews for links in this message. reply_markup (Optional[`telegram.ReplyMarkup`]) – A JSON-serialized object for an inline keyboard. reply_markup – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *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 (Optional[str]) – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername). message_id (Optional[str]) – Required if inline_message_id is not specified. Unique identifier of the sent message. inline_message_id (Optional[str]) – Required if chat_id and message_id are not specified. Identifier of the inline message. caption (Optional[str]) – New caption of the message. reply_markup (Optional[`telegram.InlineKeyboardMarkup`]) – A JSON-serialized object for an inline keyboard. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *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 (Optional[str]) – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername). message_id (Optional[str]) – Required if inline_message_id is not specified. Unique identifier of the sent message. inline_message_id (Optional[str]) – Required if chat_id and message_id are not specified. Identifier of the inline message. reply_markup (Optional[`telegram.InlineKeyboardMarkup`]) – A JSON-serialized object for an inline keyboard. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, if edited message is sent by the bot, the edited message is returned, otherwise True is returned.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

edit_message_text(*args, **kwargs)¶

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

Parameters:	text – New text of the message. chat_id – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername). message_id – Required if inline_message_id is not specified. Unique identifier of the sent message. inline_message_id – Required if chat_id and message_id are not specified. Identifier of the inline message. parse_mode – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot’s message. disable_web_page_preview – Disables link previews for links in this message. reply_markup (Optional[`telegram.ReplyMarkup`]) – A JSON-serialized object for an inline keyboard. reply_markup – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *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`

first_name

forwardMessage(*args, **kwargs)¶

Use this method to forward messages of any kind.

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. from_chat_id – Unique identifier for the chat where the original message was sent - Chat id. message_id – Unique message identifier. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message forwarded.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

forward_message(*args, **kwargs)¶

Use this method to forward messages of any kind.

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. from_chat_id – Unique identifier for the chat where the original message was sent - Chat id. message_id – Unique message identifier. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message forwarded.
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 – Unique identifier for the target chat or username of the target channel (in the format @channelusername). timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, `telegram.Chat` is returned.
Return type:	`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 – Unique identifier for the target chat or username of the target channel (in the format @channelusername). timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	A list of chat member objects.
Return type:	list[`telegram.ChatMember`]
Raises:	`telegram.TelegramError`

getChatMember(*args, **kwargs)¶

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

Parameters:	chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername). user_id – Unique identifier of the target user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, chat member object is returned.
Return type:	`telegram.ChatMember`
Raises:	`telegram.TelegramError`

getChatMembersCount(*args, **kwargs)¶

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

Parameters:	chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername). timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, an int is returned.
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.

Parameters:	file_id – File identifier to get info about. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, a `telegram.File` object is returned.
Return type:	`telegram.File`
Raises:	`telegram.TelegramError`

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

Use this method to get data for high score tables.

Returns:	Scores of the specified user and several of his neighbors in a game.
Return type:	list[`telegram.GameHighScore`]

getMe(*args, **kwargs)¶

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

Returns:	A `telegram.User` instance representing that bot if the credentials are valid, None otherwise.
Return type:	`telegram.User`
Raises:	`telegram.TelegramError`

getUpdates(*args, **kwargs)¶

Use this method to receive incoming updates using long polling.

Parameters:	offset (Optional[int]) – 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. limit (Optional[int]) – Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100. timeout (Optional[int]) – Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. network_delay (Optional[float]) – Additional timeout in seconds to allow the response from Telegram servers. This should cover network latency around the globe, SSL handshake and slowness of the Telegram servers (which unfortunately happens a lot recently - 2016-05-28). Defaults to 5. *kwargs (dict*) – Arbitrary keyword arguments.
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 – Unique identifier of the target user. offset (Optional[int]) – Sequential number of the first photo to be returned. By default, all photos are returned. limit (Optional[int]) – Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	A list of user profile photos objects is returned.
Return type:	list[`telegram.UserProfilePhotos`]
Raises:	`telegram.TelegramError`

getWebhookInfo(**kwargs)¶

Use this method to get current webhook status.

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

Returns:	class: 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 – Unique identifier for the target chat or username of the target channel (in the format @channelusername). timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, `telegram.Chat` is returned.
Return type:	`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 – Unique identifier for the target chat or username of the target channel (in the format @channelusername). timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	A list of chat member objects.
Return type:	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 – Unique identifier for the target chat or username of the target channel (in the format @channelusername). user_id – Unique identifier of the target user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, chat member object is returned.
Return type:	`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 – Unique identifier for the target chat or username of the target channel (in the format @channelusername). timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, an int is returned.
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.

Parameters:	file_id – File identifier to get info about. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, a `telegram.File` object is returned.
Return type:	`telegram.File`
Raises:	`telegram.TelegramError`

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

Use this method to get data for high score tables.

Returns:	Scores of the specified user and several of his neighbors in a game.
Return type:	list[`telegram.GameHighScore`]

get_me(*args, **kwargs)¶

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

Returns:	A `telegram.User` instance representing that bot if the credentials are valid, None otherwise.
Return type:	`telegram.User`
Raises:	`telegram.TelegramError`

get_updates(*args, **kwargs)¶

Use this method to receive incoming updates using long polling.

Parameters:	offset (Optional[int]) – 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. limit (Optional[int]) – Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100. timeout (Optional[int]) – Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. network_delay (Optional[float]) – Additional timeout in seconds to allow the response from Telegram servers. This should cover network latency around the globe, SSL handshake and slowness of the Telegram servers (which unfortunately happens a lot recently - 2016-05-28). Defaults to 5. *kwargs (dict*) – Arbitrary keyword arguments.
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 – Unique identifier of the target user. offset (Optional[int]) – Sequential number of the first photo to be returned. By default, all photos are returned. limit (Optional[int]) – Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	A list of user profile photos objects is returned.
Return type:	list[`telegram.UserProfilePhotos`]
Raises:	`telegram.TelegramError`

get_webhook_info(**kwargs)¶

Use this method to get current webhook status.

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

Returns:	class: telegram.WebhookInfo

id

info(func)¶

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 – Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername). user_id – Unique identifier of the target user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, True is returned.
Return type:	bool
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 – Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername). user_id – Unique identifier of the target user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, True is returned.
Return type:	bool
Raises:	`telegram.TelegramError`

last_name

leaveChat(*args, **kwargs)¶

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

Parameters:	chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername). timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, True is returned.
Return type:	bool
Raises:	`telegram.TelegramError`

leave_chat(*args, **kwargs)¶

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

Parameters:	chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername). timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, True is returned.
Return type:	bool
Raises:	`telegram.TelegramError`

log(func)¶

message(func)¶

name

request¶

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 an .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 backward compatibility, when both fields title and description are empty and mime-type of the sent file is not “audio/mpeg”, file is sent as playable voice message. In this case, your audio must be in an .ogg file encoded with OPUS. This will be removed in the future. You need to use sendVoice method instead.

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. audio – Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data. duration (Optional[int]) – Duration of sent audio in seconds. performer (Optional[str]) – Performer of sent audio. title (Optional[str]) – Title of sent audio. caption (Optional[str]) – Audio caption disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
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 bot’s side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status).

Parameters:

chat_id – Unique identifier for the message recipient - Chat id.
action –
Type of action to broadcast. Choose one, depending on what the user is about to receive:
- ChatAction.TYPING for text messages,
- ChatAction.UPLOAD_PHOTO for photos,
- ChatAction.UPLOAD_VIDEO for videos,
- ChatAction.UPLOAD_AUDIO for audio files,
- ChatAction.UPLOAD_DOCUMENT for general files,
- ChatAction.FIND_LOCATION for location data.
**kwargs (dict) – Arbitrary keyword arguments.

sendContact(*args, **kwargs)¶

Use this method to send phone contacts.

Parameters:	chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername). phone_number (str) – Contact’s phone number. first_name (str) – Contact’s first name. last_name (Optional[str]) – Contact’s last name. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

sendDocument(*args, **kwargs)¶

Use this method to send general files.

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. document – File to send. You can either pass a file_id as String to resend a file that is already on the Telegram servers, or upload a new file using multipart/form-data. filename (Optional[str]) – File name that shows in telegram message (it is usefull when you send file generated by temp module, for example). caption (Optional[str]) – Document caption (may also be used when resending documents by file_id), 0-200 characters. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

sendGame(*args, **kwargs)¶

Use this method to send a game.

Keyword Arguments:
Parameters:	chat_id – 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.
	disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations.
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.

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. latitude (float) – Latitude of location. longitude (float) – Longitude of location. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

sendMessage(*args, **kwargs)¶

Use this method to send text messages.

Parameters:	chat_id (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. The current maximum length is 4096 UTF-8 characters. parse_mode (Optional[str]) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot’s message. disable_web_page_preview (Optional[bool]) – Disables link previews for links in this message. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *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.

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. photo – Photo to send. You can either pass a file_id as String to resend a photo that is already on the Telegram servers, or upload a new photo using multipart/form-data. caption (Optional[str]) – Photo caption (may also be used when resending photos by file_id). disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

sendSticker(*args, **kwargs)¶

Use this method to send .webp stickers.

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. sticker – Sticker to send. You can either pass a file_id as String to resend a sticker that is already on the Telegram servers, or upload a new sticker using multipart/form-data. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

sendVenue(*args, **kwargs)¶

Use this method to send information about a venue.

Parameters:	chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername). latitude (float) – Latitude of the venue. longitude (float) – Longitude of the venue. title (str) – Name of the venue. address (str) – Address of the venue. foursquare_id (Optional[str]) – Foursquare identifier of the venue. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
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 telegram.Document).

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. video – Video to send. You can either pass a file_id as String to resend a video that is already on the Telegram servers, or upload a new video file using multipart/form-data. duration (Optional[int]) – Duration of sent video in seconds. caption (Optional[str]) – Video caption (may also be used when resending videos by file_id). disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations.
Returns:	On success, instance representing the message posted.
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). 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.

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. voice – Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data. duration (Optional[int]) – Duration of sent audio in seconds. caption (Optional[str]) – Voice caption disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
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 an .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 backward compatibility, when both fields title and description are empty and mime-type of the sent file is not “audio/mpeg”, file is sent as playable voice message. In this case, your audio must be in an .ogg file encoded with OPUS. This will be removed in the future. You need to use sendVoice method instead.

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. audio – Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data. duration (Optional[int]) – Duration of sent audio in seconds. performer (Optional[str]) – Performer of sent audio. title (Optional[str]) – Title of sent audio. caption (Optional[str]) – Audio caption disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
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 bot’s side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status).

Parameters:

chat_id – Unique identifier for the message recipient - Chat id.
action –
Type of action to broadcast. Choose one, depending on what the user is about to receive:
- ChatAction.TYPING for text messages,
- ChatAction.UPLOAD_PHOTO for photos,
- ChatAction.UPLOAD_VIDEO for videos,
- ChatAction.UPLOAD_AUDIO for audio files,
- ChatAction.UPLOAD_DOCUMENT for general files,
- ChatAction.FIND_LOCATION for location data.
**kwargs (dict) – Arbitrary keyword arguments.

send_contact(*args, **kwargs)¶

Use this method to send phone contacts.

Parameters:	chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername). phone_number (str) – Contact’s phone number. first_name (str) – Contact’s first name. last_name (Optional[str]) – Contact’s last name. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

send_document(*args, **kwargs)¶

Use this method to send general files.

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. document – File to send. You can either pass a file_id as String to resend a file that is already on the Telegram servers, or upload a new file using multipart/form-data. filename (Optional[str]) – File name that shows in telegram message (it is usefull when you send file generated by temp module, for example). caption (Optional[str]) – Document caption (may also be used when resending documents by file_id), 0-200 characters. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

send_game(*args, **kwargs)¶

Use this method to send a game.

Keyword Arguments:
Parameters:	chat_id – 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.
	disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations.
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.

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. latitude (float) – Latitude of location. longitude (float) – Longitude of location. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

send_message(*args, **kwargs)¶

Use this method to send text messages.

Parameters:	chat_id (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. The current maximum length is 4096 UTF-8 characters. parse_mode (Optional[str]) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot’s message. disable_web_page_preview (Optional[bool]) – Disables link previews for links in this message. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *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.

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. photo – Photo to send. You can either pass a file_id as String to resend a photo that is already on the Telegram servers, or upload a new photo using multipart/form-data. caption (Optional[str]) – Photo caption (may also be used when resending photos by file_id). disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

send_sticker(*args, **kwargs)¶

Use this method to send .webp stickers.

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. sticker – Sticker to send. You can either pass a file_id as String to resend a sticker that is already on the Telegram servers, or upload a new sticker using multipart/form-data. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

send_venue(*args, **kwargs)¶

Use this method to send information about a venue.

Parameters:	chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername). latitude (float) – Latitude of the venue. longitude (float) – Longitude of the venue. title (str) – Name of the venue. address (str) – Address of the venue. foursquare_id (Optional[str]) – Foursquare identifier of the venue. disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
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 telegram.Document).

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. video – Video to send. You can either pass a file_id as String to resend a video that is already on the Telegram servers, or upload a new video file using multipart/form-data. duration (Optional[int]) – Duration of sent video in seconds. caption (Optional[str]) – Video caption (may also be used when resending videos by file_id). disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations.
Returns:	On success, instance representing the message posted.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

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

Parameters:	chat_id – Unique identifier for the message recipient - Chat id. voice – Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data. duration (Optional[int]) – Duration of sent audio in seconds. caption (Optional[str]) – Voice caption disable_notification (Optional[bool]) – Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. reply_to_message_id (Optional[int]) – If the message is a reply, ID of the original message. reply_markup (Optional[`telegram.ReplyMarkup`]) – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, instance representing the message posted.
Return type:	`telegram.Message`
Raises:	`telegram.TelegramError`

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

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

Keyword Arguments:
Parameters:	user_id (int) – User identifier. score (int) – New score, must be non-negative. chat_id (Optional[int\|str]) – Required if inline_message_id is not specified. Unique identifier for the target chat (or username of the target channel in the format @channelusername) message_id (Optional[int]) – Required if inline_message_id is not specified. Identifier of the sent message. inline_message_id (Optional[str]) – Required if chat_id and message_id are not specified. Identifier of the inline message. force (Optional[bool]) – Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters. disable_edit_message (Optional[bool]) – Pass True, if the game message should not be automatically edited to include the current scoreboard. edit_message (Optional[bool]) – Deprecated. Has the opposite logic for disable_edit_message.
	timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations.
Returns:	The edited message, or if the message wasn’t sent by the bot, True.
Return type:	`telegram.Message` or True

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.

Parameters:	webhook_url – HTTPS url to send updates to. Use an empty string to remove webhook integration timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, True is returned.
Return type:	bool
Raises:	`telegram.TelegramError`

set_game_score(user_id, score, chat_id=None, message_id=None, inline_message_id=None, edit_message=None, force=None, disable_edit_message=None, **kwargs)¶

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

Keyword Arguments:
Parameters:	user_id (int) – User identifier. score (int) – New score, must be non-negative. chat_id (Optional[int\|str]) – Required if inline_message_id is not specified. Unique identifier for the target chat (or username of the target channel in the format @channelusername) message_id (Optional[int]) – Required if inline_message_id is not specified. Identifier of the sent message. inline_message_id (Optional[str]) – Required if chat_id and message_id are not specified. Identifier of the inline message. force (Optional[bool]) – Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters. disable_edit_message (Optional[bool]) – Pass True, if the game message should not be automatically edited to include the current scoreboard. edit_message (Optional[bool]) – Deprecated. Has the opposite logic for disable_edit_message.
	timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations.
Returns:	The edited message, or if the message wasn’t sent by the bot, True.
Return type:	`telegram.Message` or True

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.

Parameters:	webhook_url – HTTPS url to send updates to. Use an empty string to remove webhook integration timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, True is returned.
Return type:	bool
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 – Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername). user_id – Unique identifier of the target user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, True is returned.
Return type:	bool
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 – Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername). user_id – Unique identifier of the target user. timeout (Optional[float]) – If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations. *kwargs (dict*) – Arbitrary keyword arguments.
Returns:	On success, True is returned.
Return type:	bool
Raises:	`telegram.TelegramError`

username

class telegram.Chat(id, type, title='', username='', first_name='', last_name='', all_members_are_admins=False, bot=None, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram Chat.

id¶: int

type¶: str – Can be ‘private’, ‘group’, ‘supergroup’ or ‘channel’

title¶: str – Title, for channels and group chats

username¶: str – Username, for private chats and channels if available

first_name¶: str – First name of the other party in a private chat

last_name¶: str – Last name of the other party in a private chat

all_members_are_admins¶: bool – True if a group has ‘All Members Are Admins’ enabled.

Parameters:	id (int) – type (str) – title (Optional[str]) – username (Optional[str]) – first_name (Optional[str]) – last_name (Optional[str]) – bot (Optional[Bot]) – The Bot to use for instance methods *kwargs (dict*) – Arbitrary keyword arguments.

CHANNEL = 'channel'¶

GROUP = 'group'¶

PRIVATE = 'private'¶

SUPERGROUP = 'supergroup'¶

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.Chat

get_administrators(*args, **kwargs)¶: Shortcut for bot.getChatAdministrators(update.message.chat.id, *args, **kwargs)

get_member(*args, **kwargs)¶: Shortcut for bot.getChatMember(update.message.chat.id, *args, **kwargs)

get_members_count(*args, **kwargs)¶: Shortcut for bot.getChatMembersCount(update.message.chat.id, *args, **kwargs)

kick_member(*args, **kwargs)¶: Shortcut for bot.kickChatMember(update.message.chat.id, *args, **kwargs)

leave(*args, **kwargs)¶: Shortcut for bot.leaveChat(update.message.chat.id, *args, **kwargs)

send_action(*args, **kwargs)¶: Shortcut for bot.sendChatAction(update.message.chat.id, *args, **kwargs)

unban_member(*args, **kwargs)¶: Shortcut for bot.unbanChatMember(update.message.chat.id, *args, **kwargs)

class telegram.ChatMember(user, status, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram ChatMember.

user¶: telegram.User – Information about the user.

status¶: str – The member’s status in the chat. Can be ‘creator’, ‘administrator’, ‘member’, ‘left’ or ‘kicked’.

Parameters:	user (`telegram.User`) – status (str) – *kwargs (dict*) – Arbitrary keyword arguments.

ADMINISTRATOR = 'administrator'¶

CREATOR = 'creator'¶

KICKED = 'kicked'¶

LEFT = 'left'¶

MEMBER = 'member'¶

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.ChatMember

class telegram.ChatAction¶

Bases: object

This object represents a Telegram ChatAction.

FIND_LOCATION = 'find_location'¶

RECORD_AUDIO = 'record_audio'¶

RECORD_VIDEO = 'record_video'¶

TYPING = 'typing'¶

UPLOAD_AUDIO = 'upload_audio'¶

UPLOAD_DOCUMENT = 'upload_document'¶

UPLOAD_PHOTO = 'upload_photo'¶

UPLOAD_VIDEO = 'upload_video'¶

class telegram.ChosenInlineResult(result_id, from_user, query, location=None, inline_message_id=None, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram ChosenInlineResult.

Note

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

result_id¶: str

from_user¶: telegram.User

query¶: str

location¶: telegram.Location

inline_message_id¶: str

Parameters:	result_id (str) – from_user (`telegram.User`) – query (str) – location (Optional[`telegram.Location`]) – inline_message_id (Optional[str]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.ChosenInlineResult

to_dict()¶

Returns:
Return type:	dict

class telegram.CallbackQuery(id, from_user, chat_instance, message=None, data=None, inline_message_id=None, game_short_name=None, bot=None, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram CallbackQuery.

answer(*args, **kwargs)¶: Shortcut for bot.answerCallbackQuery(update.callback_query.id, *args, **kwargs)

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.CallbackQuery

edit_message_caption(*args, **kwargs)¶: Shortcut for either bot.editMessageCaption(chat_id=update.callback_query.message.chat_id, message_id=update.callback_query.message.message_id, *args, **kwargs) or bot.editMessageCaption(inline_message_id=update.callback_query.inline_message_id, *args, **kwargs)

edit_message_reply_markup(*args, **kwargs)¶: Shortcut for either bot.editMessageReplyMarkup(chat_id=update.callback_query.message.chat_id, message_id=update.callback_query.message.message_id, *args, **kwargs) or bot.editMessageReplyMarkup(inline_message_id=update.callback_query.inline_message_id, *args, **kwargs)

edit_message_text(*args, **kwargs)¶: Shortcut for either bot.editMessageText(chat_id=update.callback_query.message.chat_id, message_id=update.callback_query.message.message_id, *args, **kwargs) or bot.editMessageText(inline_message_id=update.callback_query.inline_message_id, *args, **kwargs)

to_dict()¶

Returns:
Return type:	dict

class telegram.Contact(phone_number, first_name, last_name='', user_id=0, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram Contact.

phone_number¶: str

first_name¶: str

last_name¶: str

user_id¶: int

Parameters:	phone_number (str) – first_name (str) – last_name (Optional[str]) – user_id (Optional[int]) – **kwargs – Arbitrary keyword arguments.

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.Contact

class telegram.Document(file_id, thumb=None, file_name='', mime_type='', file_size=0, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram Document.

file_id¶: str

thumb¶: telegram.PhotoSize

file_name¶: str

mime_type¶: str

file_size¶: int

Parameters:	file_id (str) – thumb (Optional[`telegram.PhotoSize`]) – file_name (Optional[str]) – mime_type (Optional[str]) – file_size (Optional[int]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.Document

class telegram.File(file_id, bot, file_size=0, file_path='', **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram File.

file_id¶: str

file_size¶: str

file_path¶: str

Parameters:	file_id (str) – bot (telegram.Bot) – file_size (Optional[int]) – file_path (Optional[str]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.File

download(custom_path=None)¶

Parameters:	custom_path (str) –

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

Bases: telegram.replymarkup.ReplyMarkup

This object represents a Telegram ForceReply.

force_reply¶: bool

selective¶: bool

Parameters:	force_reply (bool) – selective (Optional[bool]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.ForceReply

class telegram.InlineKeyboardButton(text, url=None, callback_data=None, switch_inline_query=None, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram InlineKeyboardButton.

text¶: str

url¶: str

callback_data¶: str

switch_inline_query¶: str

switch_inline_query_current_chat¶: str

callback_game¶: telegram.CallbackGame

Parameters:

text (str) – Label text on the button.
url (Optional[str]) – HTTP url to be opened when button is pressed.
callback_data (Optional[str]) – Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes.
switch_inline_query (Optional[str]) – If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot’s username and the specified inline query in the input field. Can be empty, in which case just the bot’s username will be inserted.
switch_inline_query_current_chat (Optional[str]) – If set, pressing the button will insert the bot’s username and the specified inline query in the current chat’s input field. Can be empty, in which case only the bot’s username will be inserted.
callback_game (Optional[telegram.CallbackGame]) – Description of the game that will be launched when the user presses the button.
**kwargs (dict) – Arbitrary keyword arguments.

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.InlineKeyboardButton

static de_list(data, bot)¶

class telegram.InlineKeyboardMarkup(inline_keyboard, **kwargs)¶

Bases: telegram.replymarkup.ReplyMarkup

This object represents a Telegram InlineKeyboardMarkup.

inline_keyboard¶: List[List[telegram.InlineKeyboardButton]]

Parameters:	inline_keyboard (List[List[`telegram.InlineKeyboardButton`]]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.InlineKeyboardMarkup

to_dict()¶

class telegram.InlineQuery(id, from_user, query, offset, location=None, bot=None, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram InlineQuery.

Note

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

id¶: str

from_user¶: telegram.User

query¶: str

offset¶: str

Parameters:	id (int) – from_user (`telegram.User`) – query (str) – offset (str) – location (optional[`telegram.Location`]) – bot (Optional[Bot]) – The Bot to use for instance methods *kwargs (dict*) – Arbitrary keyword arguments.

answer(*args, **kwargs)¶: Shortcut for bot.answerInlineQuery(update.inline_query.id, *args, **kwargs)

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.InlineQuery

to_dict()¶

Returns:
Return type:	dict

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

Bases: telegram.base.TelegramObject

This object represents a Telegram InlineQueryResult.

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.

static de_json(data, bot)¶

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

Bases: telegram.base.TelegramObject

This object represents a Telegram InlineQueryResult.

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.

static de_json(data, bot)

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

This object represents a Telegram InlineQueryResultArticle.

id¶: str

title¶: str

input_message_content¶: telegram.InputMessageContent

reply_markup¶: telegram.ReplyMarkup

url¶: str

hide_url¶: bool

description¶: str

thumb_url¶: str

thumb_width¶: int

thumb_height¶: int

Deprecated: 4.0

message_text (str): Use InputTextMessageContent instead.

parse_mode (str): Use InputTextMessageContent instead.

disable_web_page_preview (bool): Use InputTextMessageContent instead.

Parameters:

id (str) – Unique identifier for this result, 1-64 Bytes
title (str) –
reply_markup (telegram.ReplyMarkup) –
url (Optional[str]) –
hide_url (Optional[bool]) –
description (Optional[str]) –
thumb_url (Optional[str]) –
thumb_width (Optional[int]) –
thumb_height (Optional[int]) –
**kwargs (dict) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultAudio(id, audio_url, title, performer=None, audio_duration=None, caption=None, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.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.

id¶: str

audio_url¶: str

title¶: str

performer¶: Optional[str]

audio_duration¶: Optional[str]

caption¶: Optional[str]

reply_markup¶: Optional[telegram.InlineKeyboardMarkup]

input_message_content¶: Optional[telegram.input_message_content]

Deprecated: 4.0

message_text (str): Use InputTextMessageContent instead.

parse_mode (str): Use InputTextMessageContent instead.

disable_web_page_preview (bool): Use InputTextMessageContent instead.

Parameters:	audio_url (str) – title (str) – performer (Optional[str]) – audio_duration (Optional[str]) – caption (Optional[str]) – reply_markup (Optional[`telegram.InlineKeyboardMarkup`]) – input_message_content (Optional[`telegram.input_message_content`]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultCachedAudio(id, audio_file_id, caption=None, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.inlinequeryresult.InlineQueryResult

Represents a link to an mp3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

id¶: str

audio_file_id¶: str

caption¶: Optional[str]

reply_markup¶: Optional[telegram.InlineKeyboardMarkup]

input_message_content¶: Optional[telegram.input_message_content]

Deprecated: 4.0

message_text (str): Use InputTextMessageContent instead.

parse_mode (str): Use InputTextMessageContent instead.

disable_web_page_preview (bool): Use InputTextMessageContent instead.

Parameters:	audio_file_id (str) – caption (Optional[str]) – reply_markup (Optional[`telegram.InlineKeyboardMarkup`]) – input_message_content (Optional[`telegram.input_message_content`]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultCachedDocument(id, title, document_file_id, description=None, caption=None, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.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. Currently, only pdf-files and zip archives can be sent using this method.

title¶: str – Title for the result.

document_file_id¶: str – A valid file identifier for the file.

description¶: Optional[str] – Short description of the result.

caption¶: Optional[str] – Caption of the document to be sent, 0-200 characters.

reply_markup¶: Optional[telegram.InlineKeyboardMarkup] – Inline keyboard attached to the message.

input_message_content¶: Optional[telegram.InputMessageContent] – Content of the message to be sent instead of the file.

Parameters:	id (str) – title (str) – document_file_id (str) – description (Optional[str]) – caption (Optional[str]) – reply_markup (Optional[`telegram.InlineKeyboardMarkup`]) – input_message_content (Optional[`telegram.InputMessageContent`]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultCachedGif(id, gif_file_id, title=None, caption=None, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.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.

gif_file_id¶: str – A valid file identifier for the GIF file.

title¶: Optional[str] – Title for the result.

caption¶: Optional[str] – Caption of the GIF file to be sent, 0-200 characters.

reply_markup¶: Optional[telegram.InlineKeyboardMarkup] – Inline keyboard attached to the message.

input_message_content¶: Optional[telegram.InputMessageContent] – Content of the message to be sent instead of the GIF animation.

Parameters:	id (str) – gif_file_id (str) – title (Optional[str]) – caption (Optional[str]) – reply_markup (Optional[`telegram.InlineKeyboardMarkup`]) – input_message_content (Optional[`telegram.InputMessageContent`]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultCachedMpeg4Gif(id, mpeg4_file_id, title=None, caption=None, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.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. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

mpeg4_file_id¶: str – A valid file identifier for the MP4 file.

title¶: Optional[str] – Title for the result.

caption¶: Optional[str] – Caption of the MPEG-4 file to be sent, 0-200 characters.

reply_markup¶: Optional[telegram.InlineKeyboardMarkup] – Inline keyboard attached to the message.

input_message_content¶: Optional[telegram.InputMessageContent] – Content of the message to be sent instead of the video animation

Parameters:	id (str) – mpeg4_file_id (str) – title (Optional[str]) – caption (Optional[str]) – reply_markup (Optional[`telegram.InlineKeyboardMarkup`]) – input_message_content (Optional[`telegram.InputMessageContent`]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultCachedPhoto(id, photo_file_id, title=None, description=None, caption=None, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.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.

photo_file_id¶: str – A valid file identifier of the photo.

title¶: Optional[str] – Title for the result.

description¶: Optional[str] – Short description of the result.

caption¶: Optional[str] – Caption of the photo to be sent, 0-200 characters.

reply_markup¶: Optional[telegram.InlineKeyboardMarkup] – Inline keyboard attached to the message.

input_message_content¶: Optional[telegram.InputMessageContent] – Content of the message to be sent instead of the photo

Parameters:	id (str) – photo_file_id (str) – title (Optional[str]) – description (Optional[str]) – caption (Optional[str]) – reply_markup (Optional[`telegram.InlineKeyboardMarkup`]) – input_message_content (Optional[`telegram.InputMessageContent`]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultCachedSticker(id, sticker_file_id, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.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.

sticker_file_id¶: str – A valid file identifier of the sticker.

reply_markup¶: Optional[telegram.InlineKeyboardMarkup] – Inline keyboard attached to the message.

input_message_content¶: Optional[telegram.InputMessageContent] – Content of the message to be sent instead of the sticker.

Parameters:	id (str) – sticker_file_id (str) – reply_markup (Optional[`telegram.InlineKeyboardMarkup`]) – input_message_content (Optional[`telegram.InputMessageContent`]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultCachedVideo(id, video_file_id, title, description=None, caption=None, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.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.

video_file_id¶: str – A valid file identifier for the video file.

title¶: str – Title for the result.

description¶: Optional[str] – Short description of the result.

caption¶: Optional[str] – Caption of the video to be sent, 0-200 characters.

reply_markup¶: Optional[telegram.InlineKeyboardMarkup] – Inline keyboard attached to the message

input_message_content¶: Optional[telegram.InputMessageContent] – Content of the message to be sent instead of the video

Parameters:	id (str) – video_file_id (str) – title (str) – description (Optional[str]) – caption (Optional[str]) – reply_markup (Optional[`telegram.InlineKeyboardMarkup`]) – input_message_content (Optional[`telegram.InputMessageContent`]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultCachedVoice(id, voice_file_id, title, caption=None, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.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.

voice_file_id¶: str – A valid file identifier for the voice message.

title¶: str – Voice message title.

caption¶: Optional[str] – Caption, 0-200 characters.

reply_markup¶: Optional[telegram.InlineKeyboardMarkup] – Inline keyboard attached to the message.

input_message_content¶: Optional[telegram.InputMessageContent] – Content of the message to be sent instead of the voice message.

Parameters:	id (str) – voice_file_id (str) – title (str) – caption (Optional[str]) – reply_markup (Optional[`telegram.InlineKeyboardMarkup`]) – input_message_content (Optional[`telegram.InputMessageContent`]) – *kwargs (dict*) – Arbitrary keyword arguments.

static de_json(data, bot)¶

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

phone_number¶: str – Contact’s phone number.

first_name¶: str – Contact’s first name.

last_name¶: Optional[str] – Contact’s last name.

reply_markup¶: Optional[telegram.InlineKeyboardMarkup] – Inline keyboard attached to the message.

input_message_content¶: Optional[telegram.InputMessageContent] – Content of the message to be sent instead of the contact.

thumb_url¶: Optional[str] – Url of the thumbnail for the result.

thumb_width¶: Optional[int] – Thumbnail width.

thumb_height¶: Optional[int] – Thumbnail height.

Parameters:

id (str) –
phone_number (str) –
first_name (str) –
last_name (Optional[str]) –
reply_markup (Optional[telegram.InlineKeyboardMarkup]) –
input_message_content (Optional[telegram.InputMessageContent]) –
thumb_url (Optional[str]) – Url of the thumbnail for the result.
thumb_width (Optional[int]) –
thumb_height (Optional[int]) –
**kwargs (dict) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultDocument(id, document_url, title, mime_type, caption=None, description=None, reply_markup=None, input_message_content=None, thumb_url=None, thumb_width=None, thumb_height=None, **kwargs)¶

Bases: telegram.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.

title¶: str – Title for the result.

caption¶: Optional[str] – Caption of the document to be sent, 0-200 characters.

document_url¶: Optional[str] – A valid URL for the file.

mime_type¶: Optional[str] – Mime type of the content of the file, either “application/pdf” or “application/zip”.

description¶: Optional[str] – Short description of the result.

reply_markup¶: Optional[telegram.InlineKeyboardMarkup] – Inline keyboard attached to the message.

input_message_content¶: Optional[telegram.InputMessageContent] – Content of the message to be sent instead of the file.

thumb_url¶: Optional[str] – URL of the thumbnail (jpeg only) for the file.

thumb_width¶: Optional[int] – Thumbnail width.

thumb_height¶: Optional[int] – Thumbnail height.

Parameters:

id (str) –
document_url (str) –
title (str) –
mime_type (str) –
caption (Optional[str]) –
description (Optional[str]) –
reply_markup (Optional[telegram.InlineKeyboardMarkup]) –
input_message_content (Optional[telegram.InputMessageContent]) –
thumb_url (Optional[str]) –
thumb_width (Optional[int]) –
thumb_height (Optional[int]) –
**kwargs (dict) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultGif(id, gif_url, thumb_url, gif_width=None, gif_height=None, title=None, caption=None, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.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.

gif_url¶: str – A valid URL for the GIF file. File size must not exceed 1MB.

thumb_url¶: str – URL of the static thumbnail for the result (jpeg or gif).

gif_width¶: Optional[int] – Width of the GIF.

gif_height¶: Optional[int] – Height of the GIF.

title¶: Optional[str] – Title for the result.

caption¶: Optional[str] – Caption of the GIF file to be sent, 0-200 characters.

reply_markup¶: Optional[telegram.InlineKeyboardMarkup] – Inline keyboard attached to the message.

input_message_content¶: Optional[telegram.InputMessageContent] – Content of the message to be sent instead of the GIF animation.

Parameters:

id (str) –
gif_url (str) –
thumb_url (str) –
gif_width (Optional[int]) –
gif_height (Optional[int]) –
title (Optional[str]) –
caption (Optional[str]) –
reply_markup (Optional[telegram.InlineKeyboardMarkup]) –
input_message_content (Optional[telegram.InputMessageContent]) –
**kwargs (dict) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultLocation(id, latitude, longitude, title, reply_markup=None, input_message_content=None, thumb_url=None, thumb_width=None, thumb_height=None, **kwargs)¶

Bases: telegram.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.

latitude¶: float – Location latitude in degrees.

longitude¶: float – Location longitude in degrees.

title¶: str – Location title.

reply_markup¶: Optional[telegram.InlineKeyboardMarkup] – Inline keyboard attached to the message.

input_message_content¶: Optional[telegram.InputMessageContent] – Content of the message to be sent instead of the location.

thumb_url¶: Optional[str] – Url of the thumbnail for the result.

thumb_width¶: Optional[int] – Thumbnail width.

thumb_height¶: Optional[int] – Thumbnail height.

Parameters:

latitude (float) – Location latitude in degrees.
longitude (float) – Location longitude in degrees.
title (str) – Location title.
reply_markup (Optional[telegram.InlineKeyboardMarkup]) – Inline keyboard attached to the message.
input_message_content (Optional[telegram.InputMessageContent]) – Content of the message to be sent instead of the location.
thumb_url (Optional[str]) – Url of the thumbnail for the result.
thumb_width (Optional[int]) – Thumbnail width.
thumb_height (Optional[int]) – Thumbnail height.
**kwargs (dict) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultMpeg4Gif(id, mpeg4_url, thumb_url, mpeg4_width=None, mpeg4_height=None, title=None, caption=None, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.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.

mpeg4_url¶: str – A valid URL for the MP4 file. File size must not exceed 1MB.

thumb_url¶: str – URL of the static thumbnail (jpeg or gif) for the result.

mpeg4_width¶: Optional[int] – Video width.

mpeg4_height¶: Optional[int] – Video height.

title¶: Optional[str] – Title for the result.

caption¶: Optional[str] – Caption of the MPEG-4 file to be sent, 0-200 characters.

reply_markup¶: Optional[telegram.InlineKeyboardMarkup] – Inline keyboard attached to the message.

input_message_content¶: Optional[telegram.InputMessageContent] – Content of the message to be sent instead of the video animation.

Parameters:

mpeg4_url (str) – A valid URL for the MP4 file. File size must not exceed 1MB.
thumb_url (str) – URL of the static thumbnail (jpeg or gif) for the result.
mpeg4_width (Optional[int]) – Video width.
mpeg4_height (Optional[int]) – Video height.
title (Optional[str]) – Title for the result.
caption (Optional[str]) – Caption of the MPEG-4 file to be sent, 0-200 characters.
reply_markup (Optional[telegram.InlineKeyboardMarkup]) – Inline keyboard attached to the message.
input_message_content (Optional[telegram.InputMessageContent]) – Content of the message to be sent instead of the video animation.
**kwargs (dict) – Arbitrary keyword arguments.

static de_json(data, bot)¶

class telegram.InlineQueryResultPhoto(id, photo_url, thumb_url, photo_width=None, photo_height=None, title=None, description=None, caption=None, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.inlinequeryresult.InlineQueryResult

Represents a link to a photo. By default, this photo 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 photo.

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¶: Optional[int] – Width of the photo.

photo_height¶: Optional[int] – Height of the photo.

title¶: Optional[str] – Title for the result.

description¶: Optional[str] – Short description of the result.

caption¶: Optional[str] – Caption of the photo to be sent, 0-200 characters.

reply_markup¶: Optional[telegram.InlineKeyboardMarkup] – Inline keyboard attached to the message.

input_message_content¶: Optional[telegram.InputMessageContent] – Content of the message to be sent instead of the photo.

static de_json(data, bot)¶

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

static de_json(data, bot)¶

class telegram.InlineQueryResultVideo(id, video_url, mime_type, thumb_url, title, caption=None, video_width=None, video_height=None, video_duration=None, description=None, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.inlinequeryresult.InlineQueryResult

static de_json(data, bot)¶

class telegram.InlineQueryResultVoice(id, voice_url, title, voice_duration=None, caption=None, reply_markup=None, input_message_content=None, **kwargs)¶

Bases: telegram.inlinequeryresult.InlineQueryResult

static de_json(data, bot)¶

class telegram.InlineQueryResultGame(id, game_short_name, reply_markup=None, **kwargs)¶

Bases: telegram.inlinequeryresult.InlineQueryResult

static de_json(data, bot)¶

class telegram.InputContactMessageContent(phone_number, first_name, last_name=None, **kwargs)¶

Bases: telegram.inputmessagecontent.InputMessageContent

Base class for Telegram InputContactMessageContent Objects

static de_json(data, bot)¶

class telegram.InputFile(data)¶

Bases: object

This object represents a Telegram InputFile.

content_type¶: **Returns* – str*

headers¶: **Returns* – str*

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 mimetype of an image.
Return type:	str

static is_inputfile(data)¶

Check if the request is a file request.

Parameters:	data (dict) – A dict of (str, unicode) key/value pairs
Returns:	bool

to_form()¶

Returns:
Return type:	str

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

Bases: telegram.inputmessagecontent.InputMessageContent

Base class for Telegram InputLocationMessageContent Objects

static de_json(data, bot)¶

class telegram.InputMessageContent¶

Bases: telegram.base.TelegramObject

Base class for Telegram InputMessageContent Objects

static de_json(data, bot)¶

class telegram.InputTextMessageContent(message_text, parse_mode=None, disable_web_page_preview=None, **kwargs)¶

Bases: telegram.inputmessagecontent.InputMessageContent

Base class for Telegram InputTextMessageContent Objects

static de_json(data, bot)¶

class telegram.InputVenueMessageContent(latitude, longitude, title, address, foursquare_id=None, **kwargs)¶

Bases: telegram.inputmessagecontent.InputMessageContent

Base class for Telegram InputVenueMessageContent Objects

static de_json(data, bot)¶

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.

Parameters:	text (str) – request_location (Optional[bool]) – request_contact (Optional[bool]) –

static de_json(data, bot)¶

static de_list(data, bot)¶

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

Bases: telegram.base.TelegramObject

This object represents a Telegram Location.

longitude¶: float

latitude¶: float

Parameters:	longitude (float) – latitude (float) –

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.Location

class telegram.Message(message_id, from_user, date, chat, forward_from=None, forward_from_chat=None, forward_date=None, reply_to_message=None, edit_date=None, text='', entities=None, audio=None, document=None, photo=None, sticker=None, video=None, voice=None, caption='', contact=None, location=None, venue=None, new_chat_member=None, left_chat_member=None, new_chat_title='', new_chat_photo=None, delete_chat_photo=False, group_chat_created=False, supergroup_chat_created=False, migrate_to_chat_id=0, migrate_from_chat_id=0, channel_chat_created=False, pinned_message=None, forward_from_message_id=None, bot=None, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram Message.

Note

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

message_id¶: int

from_user¶: telegram.User

date¶: datetime.datetime

forward_from¶: telegram.User

forward_from_chat¶: telegram.Chat

forward_from_message_id¶: int

forward_date¶: datetime.datetime

reply_to_message¶: telegram.Message

edit_date¶: datetime.datetime

text¶: str

audio¶: telegram.Audio

document¶: telegram.Document

game¶: telegram.Game

photo¶: List[telegram.PhotoSize]

sticker¶: telegram.Sticker

video¶: telegram.Video

voice¶: telegram.Voice

caption¶: str

contact¶: telegram.Contact

location¶: telegram.Location

new_chat_member¶: telegram.User

left_chat_member¶: telegram.User

new_chat_title¶: str

new_chat_photo¶: List[telegram.PhotoSize]

delete_chat_photo¶: bool

group_chat_created¶: bool

supergroup_chat_created¶: bool

migrate_to_chat_id¶: int

migrate_from_chat_id¶: int

channel_chat_created¶: bool

Deprecated: 4.0

new_chat_participant (telegram.User): Use new_chat_member instead.

left_chat_participant (telegram.User): Use left_chat_member instead.

Parameters:

message_id (int) –
from_user (telegram.User) –
date (datetime.datetime) –
chat (telegram.Chat) –
forward_from (Optional[telegram.User]) –
forward_from_chat (Optional[telegram.Chat]) –
forward_from_message_id (Optional[int]) –
forward_date (Optional[datetime.datetime]) –
reply_to_message (Optional[telegram.Message]) –
edit_date (Optional[datetime.datetime]) –
text (Optional[str]) –
audio (Optional[telegram.Audio]) –
document (Optional[telegram.Document]) –
game (Optional[telegram.Game]) –
photo (Optional[List[telegram.PhotoSize]]) –
sticker (Optional[telegram.Sticker]) –
video (Optional[telegram.Video]) –
voice (Optional[telegram.Voice]) –
caption (Optional[str]) –
contact (Optional[telegram.Contact]) –
location (Optional[telegram.Location]) –
new_chat_member (Optional[telegram.User]) –
left_chat_member (Optional[telegram.User]) –
new_chat_title (Optional[str]) –
new_chat_photo (Optional[List[telegram.PhotoSize]) –
delete_chat_photo (Optional[bool]) –
group_chat_created (Optional[bool]) –
supergroup_chat_created (Optional[bool]) –
migrate_to_chat_id (Optional[int]) –
migrate_from_chat_id (Optional[int]) –
channel_chat_created (Optional[bool]) –
bot (Optional[Bot]) – The Bot to use for instance methods

chat_id¶: int – Short for Message.chat.id

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.Message

edit_caption(*args, **kwargs)¶

Shortcut for

>>> bot.editMessageCaption(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.

edit_reply_markup(*args, **kwargs)¶

Shortcut for

>>> bot.editReplyMarkup(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.

edit_text(*args, **kwargs)¶

Shortcut for

>>> bot.editMessageText(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.

forward(chat_id, disable_notification=False)¶

Shortcut for

>>> bot.forwardMessage(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`

parse_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 entities attribute, since it calculates the correct substring from the message text based on UTF-16 codepoints. See get_entity_text for more info.

Parameters:	types (Optional[list]) – 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 codepoint pairs, which some versions of Python don’t handle automatically. (That is, you can’t just slice Message.text with the offset and length.)

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

reply_audio(*args, **kwargs)¶

Shortcut for bot.sendAudio(update.message.chat_id, *args, **kwargs)

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

reply_contact(*args, **kwargs)¶

Shortcut for bot.sendContact(update.message.chat_id, *args, **kwargs)

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

reply_document(*args, **kwargs)¶

Shortcut for bot.sendDocument(update.message.chat_id, *args, **kwargs)

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

reply_location(*args, **kwargs)¶

Shortcut for bot.sendLocation(update.message.chat_id, *args, **kwargs)

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

reply_photo(*args, **kwargs)¶

Shortcut for bot.sendPhoto(update.message.chat_id, *args, **kwargs)

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

reply_sticker(*args, **kwargs)¶

Shortcut for bot.sendSticker(update.message.chat_id, *args, **kwargs)

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

reply_text(*args, **kwargs)¶

Shortcut for bot.sendMessage(update.message.chat_id, *args, **kwargs)

Keyword Arguments:
	quote (Optional[bool]) – 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.sendVenue(update.message.chat_id, *args, **kwargs)

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

reply_video(*args, **kwargs)¶

Shortcut for bot.sendVideo(update.message.chat_id, *args, **kwargs)

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

reply_voice(*args, **kwargs)¶

Shortcut for bot.sendVoice(update.message.chat_id, *args, **kwargs)

Keyword Arguments:
	quote (Optional[bool]) – If set to `True`, the voice 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`

to_dict()¶

Returns:
Return type:	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.

Parameters:	type (str) – offset (int) – length (int) – url (Optional[str]) – user (Optional[`telegram.User`]) –

ALL_TYPES = ['mention', 'hashtag', 'bot_command', 'url', 'email', 'bold', 'italic', 'code', 'pre', 'text_link', 'text_mention']¶

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'¶

static de_json(data, bot)¶

static de_list(data, bot)¶

Parameters:	data (list) –
Returns:
Return type:	List<telegram.MessageEntity>

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=0, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram PhotoSize.

file_id¶: str

width¶: int

height¶: int

file_size¶: int

Keyword Arguments:
Parameters:	file_id (str) – width (int) – height (int) – **kwargs – Arbitrary keyword arguments.
	file_size (Optional[int]) –

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.PhotoSize

static de_list(data, bot)¶

Parameters:	data (list) – bot (telegram.Bot) –
Returns:
Return type:	List<telegram.PhotoSize>

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

Bases: telegram.replymarkup.ReplyMarkup

This object represents a Telegram ReplyKeyboardRemove.

remove_keyboard¶: bool – Always True.

selective¶: bool

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

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:	telegram.ReplyKeyboardRemove

class telegram.ReplyKeyboardMarkup(keyboard, resize_keyboard=False, one_time_keyboard=False, selective=False, **kwargs)¶

Bases: telegram.replymarkup.ReplyMarkup

This object represents a Telegram ReplyKeyboardMarkup.

keyboard¶: List[List[telegram.KeyboardButton]]

resize_keyboard¶: bool

one_time_keyboard¶: bool

selective¶: bool

Keyword Arguments:
Parameters:	keyboard (List[List[str]]) – **kwargs – Arbitrary keyword arguments.
	resize_keyboard (Optional[bool]) – one_time_keyboard (Optional[bool]) – selective (Optional[bool]) –

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.ReplyKeyboardMarkup

to_dict()¶

class telegram.ReplyMarkup¶

Bases: telegram.base.TelegramObject

Base class for Telegram ReplyMarkup Objects

static de_json(data, bot)¶

class telegram.Sticker(file_id, width, height, thumb=None, emoji='', file_size=0, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram Sticker.

file_id¶: str

width¶: int

height¶: int

thumb¶: telegram.PhotoSize

emoji¶: str

file_size¶: int

Keyword Arguments:
Parameters:	file_id (str) – width (int) – height (int) – **kwargs – Arbitrary keyword arguments.
	thumb (Optional[`telegram.PhotoSize`]) – emoji (Optional[str]) – file_size (Optional[int]) –

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.Sticker

exception telegram.TelegramError(message)¶

Bases: exceptions.Exception

This object represents a Telegram Error.

class telegram.TelegramObject¶

Bases: object

Base class for most telegram objects.

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	dict

to_dict()¶

Returns:
Return type:	dict

to_json()¶

Returns:
Return type:	str

class telegram.Update(update_id, message=None, edited_message=None, inline_query=None, chosen_inline_result=None, callback_query=None, channel_post=None, edited_channel_post=None, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram Update.

update_id¶: int – The update’s unique identifier.

message¶: telegram.Message – New incoming message of any kind - text, photo, sticker, etc.

edited_message¶: telegram.Message – New version of a message that is known to the bot and was edited

inline_query¶: telegram.InlineQuery – New incoming inline query.

chosen_inline_result¶: telegram.ChosenInlineResult – The result of an inline query that was chosen by a user and sent to their chat partner.

callback_query¶: telegram.CallbackQuery – New incoming callback query.

channel_post¶: Optional[telegram.Message] – New incoming channel post of any kind - text, photo, sticker, etc.

edited_channel_post¶: Optional[telegram.Message] – New version of a channel post that is known to the bot and was edited.

Parameters:

update_id (int) –
message (Optional[telegram.Message]) –
edited_message (Optional[telegram.Message]) –
inline_query (Optional[telegram.InlineQuery]) –
chosen_inline_result (Optional[telegram.ChosenInlineResult]) –
callback_query (Optional[telegram.CallbackQuery]) –
channel_post (Optional[telegram.Message]) –
edited_channel_post (Optional[telegram.Message]) –
**kwargs – Arbitrary keyword arguments.

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.Update

class telegram.User(id, first_name, type='', last_name='', username='', bot=None, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram User.

id¶: int

first_name¶: str

last_name¶: str

username¶: str

type¶: str

Keyword Arguments:
Parameters:	id (int) – first_name (str) – **kwargs – Arbitrary keyword arguments.
	type (Optional[str]) – last_name (Optional[str]) – username (Optional[str]) – bot (Optional[Bot]) – The Bot to use for instance methods

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.User

get_profile_photos(*args, **kwargs)¶: Shortcut for bot.getUserProfilePhotos(update.message.from_user.id, *args, **kwargs)

name¶: str

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

Bases: telegram.base.TelegramObject

This object represents a Telegram UserProfilePhotos.

total_count¶: int

photos¶: List[List[telegram.PhotoSize]]

Parameters:	total_count (int) – photos (List[List[`telegram.PhotoSize`]]) –

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.UserProfilePhotos

to_dict()¶

Returns:
Return type:	dict

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

Bases: telegram.base.TelegramObject

This object represents a venue.

Parameters:	location (`telegram.Location`) – title (str) – address (str) – foursquare_id (Optional[str]) –

static de_json(data, bot)¶

class telegram.Video(file_id, width, height, duration, thumb=None, mime_type='', file_size=0, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram Video.

file_id¶: str

width¶: int

height¶: int

duration¶: int

thumb¶: telegram.PhotoSize

mime_type¶: str

file_size¶: int

Keyword Arguments:
Parameters:	file_id (str) – width (int) – height (int) – duration (int) – **kwargs – Arbitrary keyword arguments.
	thumb (Optional[`telegram.PhotoSize`]) – mime_type (Optional[str]) – file_size (Optional[int]) –

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.Video

class telegram.Voice(file_id, duration, mime_type='', file_size=0, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram Voice.

file_id¶: str

duration¶: int

mime_type¶: str

file_size¶: int

Keyword Arguments:
Parameters:	file_id (str) – duration (Optional[int]) – **kwargs – Arbitrary keyword arguments.
	mime_type (Optional[str]) – file_size (Optional[int]) –

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.Voice

class telegram.WebhookInfo(url, has_custom_certificate, pending_update_count, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram WebhookInfo.

url¶: str – Webhook URL, may be empty if webhook is not set up.

has_custom_certificate¶: bool

pending_update_count¶: int

last_error_date¶: int

last_error_message¶: str

Parameters:	url (str) – Webhook URL, may be empty if webhook is not set up. has_custom_certificate (bool) – pending_update_count (int) – last_error_date (Optional[int]) – last_error_message (Optional[str]) –

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.WebhookInfo

class telegram.Animation(file_id, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram Animation.

file_id¶: str – Unique file identifier.

Keyword Arguments:
	thumb (Optional[`telegram.PhotoSize`]) – Animation thumbnail as defined by sender. file_name (Optional[str]) – Original animation filename as defined by sender. mime_type (Optional[str]) – MIME type of the file as defined by sender. file_size (Optional[int]) – File size.

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.Game

class telegram.Game(title, description, photo, text='', text_entities=None, animation=None, **kwargs)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram Game.

title¶: str – Title of the game.

description¶: str – Description of the game.

photo¶: list[telegram.PhotoSize] – List of photos that will be displayed in the game message in chats.

Keyword Arguments:

text (Optional[str]) – 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 setGameScore, or manually edited using editMessageText. 0-4096 characters.
text_entities (Optional[list[telegram.MessageEntity]]) – Special entities that appear in text, such as usernames, URLs, bot commands, etc.
animation (Optional[telegram.Animation]) – Animation that will be displayed in the game message in chats. Upload via BotFather.

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.Game

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 entities attribute, since it calculates the correct substring from the message text based on UTF-16 codepoints. See get_entity_text for more info.

Parameters:	types (Optional[list]) – List of `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_text_entity(entity)¶

Returns the text from a given telegram.MessageEntity.

Note

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

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

to_dict()¶

Returns:
Return type:	dict

class telegram.GameHighScore(position, user, score)¶

Bases: telegram.base.TelegramObject

This object represents a Telegram GameHighScore.

position¶: int – Position in high score table for the game.

user¶: telegram.User – User object.

score¶: int – Score.

static de_json(data, bot)¶

Parameters:	data (dict) – bot (telegram.Bot) –
Returns:
Return type:	telegram.Game