telegram.Bot¶
- class telegram.Bot(token, base_url='https://api.telegram.org/bot', base_file_url='https://api.telegram.org/file/bot', request=None, get_updates_request=None, private_key=None, private_key_password=None, local_mode=False)[source]¶
Bases:
telegram.TelegramObject
,AbstractAsyncContextManager
This object represents a Telegram Bot.
Instances of this class can be used as asyncio context managers, where
async with bot: # code
is roughly equivalent to
try: await bot.initialize() # code finally: await request_object.shutdown()
Note
Most bot methods have the argument
api_kwargs
which allows passing arbitrary keywords to the Telegram API. This can be used to access new features of the API before they are incorporated into PTB. However, this is not guaranteed to work, i.e. it will fail for passing files.Bots should not be serialized since if you for e.g. change the bots token, then your serialized instance will not reflect that change. Trying to pickle a bot instance will raise
pickle.PicklingError
. Trying to deepcopy a bot instance will raiseTypeError
.
Examples
See also
telegram.ext.Application.bot
,telegram.ext.CallbackContext.bot
,telegram.ext.Updater.bot
, Your First Bot, Builder PatternNew in version 13.2: Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their
bot
is equal.Changed in version 20.0:
Removed the deprecated methods
kick_chat_member
,kickChatMember
,get_chat_members_count
andgetChatMembersCount
.Removed the deprecated property
commands
.Removed the deprecated
defaults
parameter. If you want to usetelegram.ext.Defaults
, please use the subclasstelegram.ext.ExtBot
instead.Attempting to pickle a bot instance will now raise
pickle.PicklingError
.Attempting to deepcopy a bot instance will now raise
TypeError
.The following are now keyword-only arguments in Bot methods:
location
,filename
,venue
,contact
,{read, write, connect, pool}_timeout
,api_kwargs
. Use a named argument for those, and notice that some positional arguments changed position as a result.For uploading files, file paths are now always accepted. If
local_mode
isFalse
, the file contents will be read in binary mode and uploaded. Otherwise, the file path will be passed in the file URI scheme.
- Parameters
base_file_url (
str
, optional) – Telegram Bot API file URL.request (
telegram.request.BaseRequest
, optional) – Pre initializedtelegram.request.BaseRequest
instances. Will be used for all bot methods except forget_updates()
. If not passed, an instance oftelegram.request.HTTPXRequest
will be used.get_updates_request (
telegram.request.BaseRequest
, optional) – Pre initializedtelegram.request.BaseRequest
instances. Will be used exclusively forget_updates()
. If not passed, an instance oftelegram.request.HTTPXRequest
will be used.private_key (
bytes
, optional) – Private key for decryption of telegram passport data.private_key_password (
bytes
, optional) – Password for above private key.local_mode (
bool
, optional) –Set to
True
, if thebase_url
is the URI of a Local Bot API Server that runs with the--local
flag. Currently, the only effect of this is that files are uploaded using their local path in the file URI scheme. Defaults toFalse
.New in version 20.0..
Since this class has a large number of methods and attributes, below you can find a quick overview.
Sending Messages
Used for sending animations
Used for sending audio files
Used for sending chat actions
Used for sending contacts
Used for sending dice messages
Used for sending documents
Used for sending a game
Used for sending an invoice
Used for sending location
Used for sending media grouped together
Used for sending text messages
Used for sending photos
Used for sending polls
Used for sending stickers
Used for sending venue locations.
Used for sending videos
Used for sending video notes
Used for sending voice messages
Used for copying the contents of an arbitrary message
Used for forwarding messages
Updating Messages
Used for answering the callback query
Used for answering the inline query
Used for answering a pre checkout query
Used for answering a shipping query
Used for answering a web app query
Used for editing captions
Used for editing the media on messages
Used for editing the location in live location messages
Used for editing the reply markup on messages
Used for editing text messages
Used for stopping the running poll
Used for deleting messages.
Chat Moderation and information
Used for banning a member from the chat
Used for unbanning a member from the chat
Used for banning a channel in a channel or supergroup
Used for unbanning a channel in a channel or supergroup
Used for restricting a chat member
Used for promoting a chat member
Used for assigning a custom admin title to an admin
Used for setting the permissions of a chat
Used for creating a new primary invite link for a chat
Used for creating an additional invite link for a chat
Used for editing a non-primary invite link
Used for revoking an invite link created by the bot
Used for approving a chat join request
Used for declining a chat join request
Used for setting a photo to a chat
Used for deleting a chat photo
Used for setting a chat title
Used for setting the description of a chat
Used for pinning a message
Used for unpinning a message
Used for unpinning all pinned chat messages
Used for obtaining user’s profile pictures
Used for getting information about a chat
Used for getting the list of admins in a chat
Used for getting the number of members in a chat
Used for getting a member of a chat
Used for setting the list of commands
Used for deleting the list of commands
Used for obtaining the list of commands
Used for obtaining the default administrator rights for the bot
Used for setting the default administrator rights for the bot
Used for obtaining the menu button of a private chat or the default menu button
Used for setting the menu button of a private chat or the default menu button
Used for leaving a chat
Stickerset management
Used for adding a sticker to a set
Used for deleting a sticker from a set
Used for creating a new sticker set
Used for setting a sticker set
Used for deleting the set sticker set
Used for moving a sticker’s position in the set
Used for setting the thumbnail of a sticker set
Used for getting a sticker set
Used for uploading a sticker file
Used for getting custom emoji files based on their IDs
Games
Used for getting the game high scores
Used for setting the game score
Getting updates
Used for getting updates using long polling
Used for getting current webhook status
Used for setting a webhook to receive updates
Used for removing webhook integration
Forum topic management
Used for closing a forum topic
Used for closing the general forum topic
Used to create a topic
Used for deleting a forum topic
Used to edit a topic
Used to edit the general topic
Used to get custom emojis to use as topic icons
Used to hide the general topic
Used to unhide the general topic
Used to reopen a topic
Used to reopen the general topic
Used to unpin all messages in a forum topic
Miscellaneous
Used to generate an HTTP link for an invoice
Used for closing server instance when switching to another local server
Used for logging out from cloud Bot API server
Used for getting basic info about a file
Used for getting basic information about the bot
Properties
Telegram Bot API file URL
Telegram Bot API service URL
The user instance of the bot as returned by
get_me()
Whether the bot can join groups
Whether the bot can read all incoming group messages
The user id of the bot
The username of the bot, with leading
@
The first name of the bot
The last name of the bot
Whether the bot is running in local mode
The username of the bot, without leading
@
The t.me link of the bot
Deserialized private key for decryption of telegram passport data
Whether the bot supports inline queries
Bot’s unique authentication token
- __deepcopy__(memodict)[source]¶
Customizes how
copy.deepcopy()
processes objects of this type. Bots can not be deepcopied and this method will always raise an exception.New in version 20.0.
- Raises
- __reduce__()[source]¶
Customizes how
copy.deepcopy()
processes objects of this type. Bots can not be pickled and this method will always raise an exception.New in version 20.0.
- Raises
- async addStickerToSet(user_id, name, emojis, png_sticker=None, mask_position=None, tgs_sticker=None, webm_sticker=None, *, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
add_sticker_to_set()
- async add_sticker_to_set(user_id, name, emojis, png_sticker=None, mask_position=None, tgs_sticker=None, webm_sticker=None, *, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields
png_sticker
,tgs_sticker
orwebm_sticker
. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers.Warning
As of API 4.7
png_sticker
is an optional argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly.- Parameters
user_id (
int
) – User identifier of created sticker set owner.emojis (
str
) – One or more emoji corresponding to the sticker.png_sticker (
str
| file object |bytes
|pathlib.Path
, optional) –PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a
file_id
as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one. To upload a file, you can either pass a file object (e.g.open("filename", "rb")
), the file contents as bytes or the path of the file (as string orpathlib.Path
object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on thelocal_mode
setting.Changed in version 13.2: Accept
bytes
as input.Changed in version 20.0: File paths as input is also accepted for bots not running in
local_mode
.mask_position (
telegram.MaskPosition
, optional) – Position where the mask should be placed on faces.tgs_sticker (
str
| file object |bytes
|pathlib.Path
, optional) –TGS animation with the sticker. To upload a file, you can either pass a file object (e.g.
open("filename", "rb")
), the file contents as bytes or the path of the file (as string orpathlib.Path
object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on thelocal_mode
setting. See https://core.telegram.org/stickers#animation-requirements for technical requirements.Changed in version 13.2: Accept
bytes
as input.Changed in version 20.0: File paths as input is also accepted for bots not running in
local_mode
.webm_sticker (
str
| file object |bytes
|pathlib.Path
, optional) –WEBM video with the sticker. To upload a file, you can either pass a file object (e.g.
open("filename", "rb")
), the file contents as bytes or the path of the file (as string orpathlib.Path
object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on thelocal_mode
setting. See https://core.telegram.org/stickers#video-requirements for technical requirements.New in version 13.11.
Changed in version 20.0: File paths as input is also accepted for bots not running in
local_mode
.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults to20
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async answerCallbackQuery(callback_query_id, text=None, show_alert=None, url=None, cache_time=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
answer_callback_query()
- async answerInlineQuery(inline_query_id, results, cache_time=None, is_personal=None, next_offset=None, switch_pm_text=None, switch_pm_parameter=None, *, current_offset=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
answer_inline_query()
- async answerPreCheckoutQuery(pre_checkout_query_id, ok, error_message=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
answer_pre_checkout_query()
- async answerShippingQuery(shipping_query_id, ok, shipping_options=None, error_message=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
answer_shipping_query()
- async answerWebAppQuery(web_app_query_id, result, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
answer_web_app_query()
- async answer_callback_query(callback_query_id, text=None, show_alert=None, url=None, cache_time=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
See also
- Parameters
callback_query_id (
str
) – Unique identifier for the query to be answered.text (
str
, optional) – Text of the notification. If not specified, nothing will be shown to the user, 0-200
characters.show_alert (
bool
, optional) – IfTrue
, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults toFalse
.URL that will be opened by the user’s client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback game button. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
cache_time (
int
, optional) – The maximum amount of time in seconds that the result of the callback query may be cached client-side. Defaults to 0.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
- Raises
- async answer_inline_query(inline_query_id, results, cache_time=None, is_personal=None, next_offset=None, switch_pm_text=None, switch_pm_parameter=None, *, current_offset=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to send answers to an inline query. No more than
50
results per query are allowed.Example
An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a ‘Connect your YouTube account’ button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot’s inline capabilities.
Warning
In most use cases
current_offset
should not be passed manually. Instead of calling this method directly, use the shortcuttelegram.InlineQuery.answer()
withtelegram.InlineQuery.answer.auto_pagination
set toTrue
, which will take care of passing the correct value.- Parameters
inline_query_id (
str
) – Unique identifier for the answered query.results (List[
telegram.InlineQueryResult
] | Callable) – A list of results for the inline query. In casecurrent_offset
is passed,results
may also be a callable that accepts the current page index starting from 0. It must return either a list oftelegram.InlineQueryResult
instances orNone
if there are no more results.cache_time (
int
, optional) – The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to300
.is_personal (
bool
, optional) – PassTrue
, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.next_offset (
str
, optional) – Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don’t support pagination. Offset length can’t exceed64
bytes.switch_pm_text (
str
, optional) – If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameterswitch_pm_parameter
.switch_pm_parameter (
str
, optional) – Deep-linking parameter for the /start message sent to the bot when user presses the switch button.1
-64
characters, onlyA-Z
,a-z
,0-9
,_
and-
are allowed.
- Keyword Arguments
current_offset (
str
, optional) – Thetelegram.InlineQuery.offset
of the inline query to answer. If passed, PTB will automatically take care of the pagination for you, i.e. pass the correctnext_offset
and truncate the results list/get the results from the callable you passed.read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async answer_pre_checkout_query(pre_checkout_query_id, ok, error_message=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an
telegram.Update
with the fieldtelegram.Update.pre_checkout_query
. Use this method to respond to such pre-checkout queries.Note
The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.
See also
- Parameters
pre_checkout_query_id (
str
) – Unique identifier for the query to be answered.ok (
bool
) – SpecifyTrue
if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. UseFalse
if there are any problems.error_message (
str
, optional) – Required ifok
isFalse
. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. “Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!”). Telegram will display this message to the user.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned- Return type
- Raises
- async answer_shipping_query(shipping_query_id, ok, shipping_options=None, error_message=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
If you sent an invoice requesting a shipping address and the parameter
send_invoice.is_flexible
was specified, the Bot API will send antelegram.Update
with atelegram.Update.shipping_query
field to the bot. Use this method to reply to shipping queries.See also
- Parameters
shipping_query_id (
str
) – Unique identifier for the query to be answered.ok (
bool
) – SpecifyTrue
if delivery to the specified address is possible andFalse
if there are any problems (for example, if delivery to the specified address is not possible).shipping_options (Sequence[
telegram.ShippingOption
]), optional) –Required if
ok
isTrue
. A sequence of available shipping options.Changed in version 20.0: Accepts any
collections.abc.Sequence
as input instead of just a list.error_message (
str
, optional) – Required ifok
isFalse
. Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”). Telegram will display this message to the user.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async answer_web_app_query(web_app_query_id, result, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated.
New in version 20.0.
- Parameters
web_app_query_id (
str
) – Unique identifier for the query to be answered.result (
telegram.InlineQueryResult
) – An object describing the message to be sent.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success, a sent
telegram.SentWebAppMessage
is returned.- Return type
- Raises
- async approveChatJoinRequest(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
approve_chat_join_request()
- async approve_chat_join_request(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to approve a chat join request.
The bot must be an administrator in the chat for this to work and must have the
telegram.ChatPermissions.can_invite_users
administrator right.See also
telegram.Chat.approve_join_request()
,telegram.ChatJoinRequest.approve()
,telegram.User.approve_join_request()
New in version 13.8.
- Parameters
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async banChatMember(chat_id, user_id, until_date=None, revoke_messages=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
ban_chat_member()
- async banChatSenderChat(chat_id, sender_chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
ban_chat_sender_chat()
- async ban_chat_member(chat_id, user_id, until_date=None, revoke_messages=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to ban a user from a group, supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
See also
New in version 13.7.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target group or username of the target supergroup or channel (in the format@channelusername
).until_date (
int
|datetime.datetime
, optional) – Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only. For timezone naivedatetime.datetime
objects, the default timezone of the bot will be used, which is UTC unlesstelegram.ext.Defaults.tzinfo
is used.revoke_messages (
bool
, optional) –Pass
True
to delete all messages from the chat for the user that is being removed. IfFalse
, the user will be able to see messages in the group that were sent before the user was removed. AlwaysTrue
for supergroups and channels.New in version 13.4.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async ban_chat_sender_chat(chat_id, sender_chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won’t be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights.
New in version 13.9.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target group or username of the target supergroup or channel (in the format@channelusername
).sender_chat_id (
int
) – Unique identifier of the target sender chat.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- property base_file_url[source]¶
Telegram Bot API file URL, built from
Bot.base_file_url
andBot.token
.New in version 20.0.
- Type
- property base_url[source]¶
Telegram Bot API service URL, built from
Bot.base_url
andBot.token
.New in version 20.0.
- Type
- property bot[source]¶
User instance for the bot as returned by
get_me()
.Warning
This value is the cached return value of
get_me()
. If the bots profile is changed during runtime, this value won’t reflect the changes untilget_me()
is called again.See also
- Type
- property can_join_groups[source]¶
Bot’s
telegram.User.can_join_groups
attribute. Shortcut for the corresponding attribute ofbot
.- Type
- property can_read_all_group_messages[source]¶
Bot’s
telegram.User.can_read_all_group_messages
attribute. Shortcut for the corresponding attribute ofbot
.- Type
- async close(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn’t launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success
- Return type
- Raises
- async closeForumTopic(chat_id, message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
close_forum_topic()
- async closeGeneralForumTopic(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
close_general_forum_topic()
- async close_forum_topic(chat_id, message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have
can_manage_topics
administrator rights, unless it is the creator of the topic.New in version 20.0.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
).message_thread_id (
int
) – Unique identifier for the target message thread of the forum topic.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async close_general_forum_topic(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to close an open ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have
can_manage_topics
administrator rights.New in version 20.0.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
).- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async copyMessage(chat_id, from_chat_id, message_id, caption=None, parse_mode=None, caption_entities=None, disable_notification=None, reply_to_message_id=None, allow_sending_without_reply=None, reply_markup=None, protect_content=None, message_thread_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
copy_message()
- async copy_message(chat_id, from_chat_id, message_id, caption=None, parse_mode=None, caption_entities=None, disable_notification=None, reply_to_message_id=None, allow_sending_without_reply=None, reply_markup=None, protect_content=None, message_thread_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to copy messages of any kind. Service messages and invoice messages can’t be copied. The method is analogous to the method
forward_message()
, but the copied message doesn’t have a link to the original message.See also
telegram.Message.copy()
,telegram.Chat.send_copy()
,telegram.Chat.copy_message()
,telegram.User.send_copy()
,telegram.User.copy_message()
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).from_chat_id (
int
|str
) – Unique identifier for the chat where the original message was sent (or channel username in the format@channelusername
).message_id (
int
) – Message identifier in the chat specified in from_chat_id.caption (
str
, optional) – New caption for media, 0-1024
characters after entities parsing. If not specified, the original caption is kept.parse_mode (
str
, optional) – Mode for parsing entities in the new caption. See the constants intelegram.constants.ParseMode
for the available modes.caption_entities (Sequence[
telegram.MessageEntity
], optional) –Sequence of special entities that appear in the caption, which can be specified instead of
parse_mode
.Changed in version 20.0: Accepts any
collections.abc.Sequence
as input instead of just a list.disable_notification (
bool
, optional) – Sends the message silently. Users will receive a notification with no sound.protect_content (
bool
, optional) –Protects the contents of the sent message from forwarding and saving.
New in version 13.10.
message_thread_id (
int
, optional) –Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.
New in version 20.0.
reply_to_message_id (
int
, optional) – If the message is a reply, ID of the original message.allow_sending_without_reply (
bool
, optional) – PassTrue
, if the message should be sent even if the specified replied-to message is not found.reply_markup (
InlineKeyboardMarkup
|ReplyKeyboardMarkup
|ReplyKeyboardRemove
|ForceReply
, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success
- Return type
- Raises
- async createChatInviteLink(chat_id, expire_date=None, member_limit=None, name=None, creates_join_request=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
create_chat_invite_link()
- async createForumTopic(chat_id, name, icon_color=None, icon_custom_emoji_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
create_forum_topic()
- async createInvoiceLink(title, description, payload, provider_token, currency, prices, max_tip_amount=None, suggested_tip_amounts=None, provider_data=None, photo_url=None, photo_size=None, photo_width=None, photo_height=None, need_name=None, need_phone_number=None, need_email=None, need_shipping_address=None, send_phone_number_to_provider=None, send_email_to_provider=None, is_flexible=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
create_invoice_link()
- async createNewStickerSet(user_id, name, title, emojis, png_sticker=None, mask_position=None, tgs_sticker=None, webm_sticker=None, sticker_type=None, *, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
create_new_sticker_set()
- async create_chat_invite_link(chat_id, expire_date=None, member_limit=None, name=None, creates_join_request=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The link can be revoked using the method
revoke_chat_invite_link()
.See also
New in version 13.4.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).expire_date (
int
|datetime.datetime
, optional) – Date when the link will expire. Integer input will be interpreted as Unix timestamp. For timezone naivedatetime.datetime
objects, the default timezone of the bot will be used, which is UTC unlesstelegram.ext.Defaults.tzinfo
is used.member_limit (
int
, optional) – Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link;1
-99999
.Invite link name; 0-
32
characters.New in version 13.8.
creates_join_request (
bool
, optional) –True
, if users joining the chat via the link need to be approved by chat administrators. IfTrue
,member_limit
can’t be specified.New in version 13.8.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
- Raises
- async create_forum_topic(chat_id, name, icon_color=None, icon_custom_emoji_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have
can_manage_topics
administrator rights.See also
New in version 20.0.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
).icon_color (
int
, optional) – Color of the topic icon in RGB format. Currently, must be one oftelegram.constants.ForumIconColor.BLUE
,telegram.constants.ForumIconColor.YELLOW
,telegram.constants.ForumIconColor.PURPLE
,telegram.constants.ForumIconColor.GREEN
,telegram.constants.ForumIconColor.PINK
, ortelegram.constants.ForumIconColor.RED
.icon_custom_emoji_id (
str
, optional) – New unique identifier of the custom emoji shown as the topic icon. Useget_forum_topic_icon_stickers()
to get all allowed custom emoji identifiers.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
- Raises
- async create_invoice_link(title, description, payload, provider_token, currency, prices, max_tip_amount=None, suggested_tip_amounts=None, provider_data=None, photo_url=None, photo_size=None, photo_width=None, photo_height=None, need_name=None, need_phone_number=None, need_email=None, need_shipping_address=None, send_phone_number_to_provider=None, send_email_to_provider=None, is_flexible=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to create a link for an invoice.
New in version 20.0.
- Parameters
description (
str
) – Product description.1
-255
characters.payload (
str
) – Bot-defined invoice payload.1
-128
bytes. This will not be displayed to the user, use for your internal processes.provider_token (
str
) –Payments provider token, obtained via @BotFather.
currency (
str
) – Three-letter ISO 4217 currency code, see more on currencies.prices (Sequence[
telegram.LabeledPrice
) –Price breakdown, a sequence of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).
Changed in version 20.0: Accepts any
collections.abc.Sequence
as input instead of just a list.max_tip_amount (
int
, optional) – The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 passmax_tip_amount = 145
. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to0
.suggested_tip_amounts (Sequence[
int
], optional) –An array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most
4
suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceedmax_tip_amount
.Changed in version 20.0: Accepts any
collections.abc.Sequence
as input instead of just a list.provider_data (
str
|object
, optional) – Data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. When an object is passed, it will be encoded as JSON.photo_url (
str
, optional) – URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.photo_size (
int
, optional) – Photo size in bytes.photo_width (
int
, optional) – Photo width.photo_height (
int
, optional) – Photo height.need_name (
bool
, optional) – PassTrue
, if you require the user’s full name to complete the order.need_phone_number (
bool
, optional) – PassTrue
, if you require the user’s phone number to complete the order.need_email (
bool
, optional) – PassTrue
, if you require the user’s email address to complete the order.need_shipping_address (
bool
, optional) – PassTrue
, if you require the user’s shipping address to complete the order.send_phone_number_to_provider (
bool
, optional) – PassTrue
, if user’s phone number should be sent to provider.send_email_to_provider (
bool
, optional) – PassTrue
, if user’s email address should be sent to provider.is_flexible (
bool
, optional) – PassTrue
, if the final price depends on the shipping method.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success, the created invoice link is returned.
- Return type
- async create_new_sticker_set(user_id, name, title, emojis, png_sticker=None, mask_position=None, tgs_sticker=None, webm_sticker=None, sticker_type=None, *, read_timeout=None, write_timeout=20, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. You must use exactly one of the fields
png_sticker
,tgs_sticker
, orwebm_sticker
.Warning
As of API 4.7
png_sticker
is an optional argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly.Changed in version 20.0: The parameter
contains_masks
has been removed. Usesticker_type
instead.- Parameters
user_id (
int
) – User identifier of created sticker set owner.name (
str
) – Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can’t contain consecutive underscores and must end in “_by_<bot username>”. <bot_username> is case insensitive.1
-64
characters.png_sticker (
str
| file object |bytes
|pathlib.Path
, optional) –PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a
file_id
as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one. To upload a file, you can either pass a file object (e.g.open("filename", "rb")
), the file contents as bytes or the path of the file (as string orpathlib.Path
object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on thelocal_mode
setting.Changed in version 13.2: Accept
bytes
as input.Changed in version 20.0: File paths as input is also accepted for bots not running in
local_mode
.tgs_sticker (
str
| file object |bytes
|pathlib.Path
, optional) –TGS animation with the sticker. To upload a file, you can either pass a file object (e.g.
open("filename", "rb")
), the file contents as bytes or the path of the file (as string orpathlib.Path
object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on thelocal_mode
setting. See https://core.telegram.org/stickers#animation-requirements for technical requirements.Changed in version 13.2: Accept
bytes
as input.Changed in version 20.0: File paths as input is also accepted for bots not running in
local_mode
.webm_sticker (
str
| file object |bytes
|pathlib.Path
, optional) –WEBM video with the sticker. To upload a file, you can either pass a file object (e.g.
open("filename", "rb")
), the file contents as bytes or the path of the file (as string orpathlib.Path
object). In the latter case, the file contents will either be read as bytes or the file path will be passed to Telegram, depending on thelocal_mode
setting. See https://core.telegram.org/stickers#video-requirements for technical requirements.New in version 13.11.
Changed in version 20.0: File paths as input is also accepted for bots not running in
local_mode
.emojis (
str
) – One or more emoji corresponding to the sticker.mask_position (
telegram.MaskPosition
, optional) – Position where the mask should be placed on faces.sticker_type (
str
, optional) –Type of stickers in the set, pass
telegram.Sticker.REGULAR
ortelegram.Sticker.MASK
. Custom emoji sticker sets can’t be created via the Bot API at the moment. By default, a regular sticker set is created.New in version 20.0.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults to20
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async declineChatJoinRequest(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
decline_chat_join_request()
- async decline_chat_join_request(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to decline a chat join request.
The bot must be an administrator in the chat for this to work and must have the
telegram.ChatPermissions.can_invite_users
administrator right.See also
telegram.Chat.decline_join_request()
,telegram.ChatJoinRequest.decline()
,telegram.User.decline_join_request()
New in version 13.8.
- Parameters
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async deleteChatPhoto(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
delete_chat_photo()
- async deleteChatStickerSet(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
delete_chat_sticker_set()
- async deleteForumTopic(chat_id, message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
delete_forum_topic()
- async deleteMessage(chat_id, message_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
delete_message()
- async deleteMyCommands(scope=None, language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
delete_my_commands()
- async deleteStickerFromSet(sticker, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
delete_sticker_from_set()
- async deleteWebhook(drop_pending_updates=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
delete_webhook()
- async delete_chat_photo(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to delete a chat photo. Photos can’t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
See also
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async delete_chat_sticker_set(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field
telegram.Chat.can_set_sticker_set
optionally returned inget_chat()
requests to check if the bot can use this method.- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
).- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- async delete_forum_topic(chat_id, message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have
can_delete_messages
administrator rights.New in version 20.0.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
).message_thread_id (
int
) – Unique identifier for the target message thread of the forum topic.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async delete_message(chat_id, message_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to delete a message, including service messages, with the following limitations:
A message can only be deleted if it was sent less than 48 hours ago.
Service messages about a supergroup, channel, or forum topic creation can’t be deleted.
A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
Bots can delete outgoing messages in private chats, groups, and supergroups.
Bots can delete incoming messages in private chats.
Bots granted
can_post_messages
permissions can delete outgoing messages in channels.If the bot is an administrator of a group, it can delete any message there.
If the bot has
can_delete_messages
permission in a supergroup or a channel, it can delete any message there.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).message_id (
int
) – Identifier of the message to delete.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async delete_my_commands(scope=None, language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to delete the list of the bot’s commands for the given scope and user language. After deletion, higher level commands will be shown to affected users.
New in version 13.7.
See also
- Parameters
scope (
telegram.BotCommandScope
, optional) – An object, describing scope of users for which the commands are relevant. Defaults totelegram.BotCommandScopeDefault
.language_code (
str
, optional) – A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async delete_sticker_from_set(sticker, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to delete a sticker from a set created by the bot.
- Parameters
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async delete_webhook(drop_pending_updates=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to remove webhook integration if you decide to switch back to
get_updates()
.- Parameters
drop_pending_updates (
bool
, optional) – PassTrue
to drop all pending updates.- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async editChatInviteLink(chat_id, invite_link, expire_date=None, member_limit=None, name=None, creates_join_request=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
edit_chat_invite_link()
- async editForumTopic(chat_id, message_thread_id, name=None, icon_custom_emoji_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
edit_forum_topic()
- async editGeneralForumTopic(chat_id, name, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
edit_general_forum_topic()
- async editMessageCaption(chat_id=None, message_id=None, inline_message_id=None, caption=None, reply_markup=None, parse_mode=None, caption_entities=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
edit_message_caption()
- async editMessageLiveLocation(chat_id=None, message_id=None, inline_message_id=None, latitude=None, longitude=None, reply_markup=None, horizontal_accuracy=None, heading=None, proximity_alert_radius=None, *, location=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
edit_message_live_location()
- async editMessageMedia(media, chat_id=None, message_id=None, inline_message_id=None, reply_markup=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
edit_message_media()
- async editMessageReplyMarkup(chat_id=None, message_id=None, inline_message_id=None, reply_markup=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
edit_message_reply_markup()
- async editMessageText(text, chat_id=None, message_id=None, inline_message_id=None, parse_mode=None, disable_web_page_preview=None, reply_markup=None, entities=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
edit_message_text()
- async edit_chat_invite_link(chat_id, invite_link, expire_date=None, member_limit=None, name=None, creates_join_request=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Note
Though not stated explicitly in the official docs, Telegram changes not only the optional parameters that are explicitly passed, but also replaces all other optional parameters to the default values. However, since not documented, this behaviour may change unbeknown to PTB.
See also
New in version 13.4.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).invite_link (
str
|telegram.ChatInviteLink
) –The invite link to edit.
Changed in version 20.0: Now also accepts
telegram.ChatInviteLink
instances.expire_date (
int
|datetime.datetime
, optional) – Date when the link will expire. For timezone naivedatetime.datetime
objects, the default timezone of the bot will be used, which is UTC unlesstelegram.ext.Defaults.tzinfo
is used.member_limit (
int
, optional) – Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link;1
-99999
.Invite link name; 0-
32
characters.New in version 13.8.
creates_join_request (
bool
, optional) –True
, if users joining the chat via the link need to be approved by chat administrators. IfTrue
,member_limit
can’t be specified.New in version 13.8.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
- Raises
- async edit_forum_topic(chat_id, message_thread_id, name=None, icon_custom_emoji_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have
can_manage_topics
administrator rights, unless it is the creator of the topic.New in version 20.0.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
).message_thread_id (
int
) – Unique identifier for the target message thread of the forum topic.name (
str
, optional) – New topic name,1
-128
characters. If not specified or empty, the current name of the topic will be kept.icon_custom_emoji_id (
str
, optional) – New unique identifier of the custom emoji shown as the topic icon. Useget_forum_topic_icon_stickers()
to get all allowed custom emoji identifiers.Pass an empty string to remove the icon. If not specified, the current icon will be kept.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async edit_general_forum_topic(chat_id, name, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to edit the name of the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have
can_manage_topics
administrator rights.New in version 20.0.
- Parameters
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async edit_message_caption(chat_id=None, message_id=None, inline_message_id=None, caption=None, reply_markup=None, parse_mode=None, caption_entities=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to edit captions of messages.
Note
It is currently only possible to edit messages without
telegram.Message.reply_markup
or with inline keyboards.- Parameters
chat_id (
int
|str
, optional) – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format@channelusername
).message_id (
int
, optional) – Required if inline_message_id is not specified. Identifier of the message to edit.inline_message_id (
str
, optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.caption (
str
, optional) – New caption of the message, 0-1024
characters after entities parsing.parse_mode (
str
, optional) – Mode for parsing entities. Seetelegram.constants.ParseMode
and formatting options for more details.caption_entities (Sequence[
telegram.MessageEntity
], optional) –Sequence of special entities that appear in the caption, which can be specified instead of
parse_mode
.Changed in version 20.0: Accepts any
collections.abc.Sequence
as input instead of just a list.reply_markup (
telegram.InlineKeyboardMarkup
, optional) – An object for an inline keyboard.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success, if edited message is not an inline message, the edited message is returned, otherwise
True
is returned.- Return type
- Raises
- async edit_message_live_location(chat_id=None, message_id=None, inline_message_id=None, latitude=None, longitude=None, reply_markup=None, horizontal_accuracy=None, heading=None, proximity_alert_radius=None, *, location=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to edit live location messages sent by the bot or via the bot (for inline bots). A location can be edited until its
telegram.Location.live_period
expires or editing is explicitly disabled by a call tostop_message_live_location()
.- Parameters
chat_id (
int
|str
, optional) – Required ifinline_message_id
is not specified. Unique identifier for the target chat or username of the target channel (in the format@channelusername
).message_id (
int
, optional) – Required ifinline_message_id
is not specified. Identifier of the message to edit.inline_message_id (
str
, optional) – Required ifchat_id
andmessage_id
are not specified. Identifier of the inline message.horizontal_accuracy (
float
, optional) – The radius of uncertainty for the location, measured in meters; 0-1500
.heading (
int
, optional) – Direction in which the user is moving, in degrees. Must be between1
and360
if specified.proximity_alert_radius (
int
, optional) – Maximum distance for proximity alerts about approaching another chat member, in meters. Must be between1
and100000
if specified.reply_markup (
telegram.InlineKeyboardMarkup
, optional) – An object for a new inline keyboard.
- Keyword Arguments
location (
telegram.Location
, optional) – The location to send.read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success, if edited message is not an inline message, the edited message is returned, otherwise
True
is returned.- Return type
- async edit_message_media(media, chat_id=None, message_id=None, inline_message_id=None, reply_markup=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can’t be uploaded; use a previously uploaded file via its
file_id
or specify a URL.Note
It is currently only possible to edit messages without
telegram.Message.reply_markup
or with inline keyboards.See also
telegram.Message.edit_media()
,telegram.CallbackQuery.edit_message_media()
, Working with Files and Media- Parameters
media (
telegram.InputMedia
) – An object for a new media content of the message.chat_id (
int
|str
, optional) – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format@channelusername
).message_id (
int
, optional) – Required if inline_message_id is not specified. Identifier of the message to edit.inline_message_id (
str
, optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.reply_markup (
telegram.InlineKeyboardMarkup
, optional) – An object for an inline keyboard.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success, if edited message is not an inline message, the edited Message is returned, otherwise
True
is returned.- Return type
- Raises
- async edit_message_reply_markup(chat_id=None, message_id=None, inline_message_id=None, reply_markup=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots).
Note
It is currently only possible to edit messages without
telegram.Message.reply_markup
or with inline keyboards.- Parameters
chat_id (
int
|str
, optional) – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format@channelusername
).message_id (
int
, optional) – Required if inline_message_id is not specified. Identifier of the message to edit.inline_message_id (
str
, optional) – Required if chat_id and message_id are not specified. Identifier of the inline message.reply_markup (
telegram.InlineKeyboardMarkup
, optional) – An object for an inline keyboard.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success, if edited message is not an inline message, the edited message is returned, otherwise
True
is returned.- Return type
- Raises
- async edit_message_text(text, chat_id=None, message_id=None, inline_message_id=None, parse_mode=None, disable_web_page_preview=None, reply_markup=None, entities=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to edit text and game messages.
Note
It is currently only possible to edit messages without
telegram.Message.reply_markup
or with inline keyboards..See also
telegram.Message.edit_text()
,telegram.CallbackQuery.edit_message_text()
,telegram.Game.text
- Parameters
chat_id (
int
|str
, optional) – Required ifinline_message_id
is not specified. Unique identifier for the target chat or username of the target channel (in the format@channelusername
).message_id (
int
, optional) – Required ifinline_message_id
is not specified. Identifier of the message to edit.inline_message_id (
str
, optional) – Required ifchat_id
andmessage_id
are not specified. Identifier of the inline message.text (
str
) – New text of the message,1
-4096
characters after entities parsing.parse_mode (
str
, optional) – Mode for parsing entities. Seetelegram.constants.ParseMode
and formatting options for more details.entities (Sequence[
telegram.MessageEntity
], optional) –Sequence of special entities that appear in message text, which can be specified instead of
parse_mode
.Changed in version 20.0: Accepts any
collections.abc.Sequence
as input instead of just a list.disable_web_page_preview (
bool
, optional) – Disables link previews for links in this message.reply_markup (
telegram.InlineKeyboardMarkup
, optional) – An object for an inline keyboard.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success, if edited message is not an inline message, the edited message is returned, otherwise
True
is returned.- Return type
- Raises
- async exportChatInviteLink(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
export_chat_invite_link()
- async export_chat_invite_link(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to generate a new primary invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Note
Each administrator in a chat generates their own invite links. Bots can’t use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using
export_chat_invite_link()
or by calling theget_chat()
method. If your bot needs to generate a new primary invite link replacing its previous one, useexport_chat_invite_link()
again.See also
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
New invite link on success.
- Return type
- Raises
- property first_name[source]¶
Bot’s first name. Shortcut for the corresponding attribute of
bot
.- Type
- async forwardMessage(chat_id, from_chat_id, message_id, disable_notification=None, protect_content=None, message_thread_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
forward_message()
- async forward_message(chat_id, from_chat_id, message_id, disable_notification=None, protect_content=None, message_thread_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to forward messages of any kind. Service messages can’t be forwarded.
Note
Since the release of Bot API 5.5 it can be impossible to forward messages from some chats. Use the attributes
telegram.Message.has_protected_content
andtelegram.Chat.has_protected_content
to check this.As a workaround, it is still possible to use
copy_message()
. However, this behaviour is undocumented and might be changed by Telegram.- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).from_chat_id (
int
|str
) – Unique identifier for the chat where the original message was sent (or channel username in the format@channelusername
).message_id (
int
) – Message identifier in the chat specified infrom_chat_id
.disable_notification (
bool
, optional) – Sends the message silently. Users will receive a notification with no sound.protect_content (
bool
, optional) –Protects the contents of the sent message from forwarding and saving.
New in version 13.10.
message_thread_id (
int
, optional) –Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.
New in version 20.0.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success, the sent Message is returned.
- Return type
- Raises
- async getChat(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_chat()
- async getChatAdministrators(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_chat_administrators()
- async getChatMember(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_chat_member()
- async getChatMemberCount(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_chat_member_count()
- async getChatMenuButton(chat_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_chat_menu_button()
- async getCustomEmojiStickers(custom_emoji_ids, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_custom_emoji_stickers()
- async getFile(file_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_file()
- async getForumTopicIconStickers(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_forum_topic_icon_stickers()
- async getGameHighScores(user_id, chat_id=None, message_id=None, inline_message_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_game_high_scores()
- async getMe(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_me()
- async getMyCommands(scope=None, language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_my_commands()
- async getMyDefaultAdministratorRights(for_channels=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_my_default_administrator_rights()
- async getStickerSet(name, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_sticker_set()
- async getUpdates(offset=None, limit=None, timeout=None, allowed_updates=None, *, read_timeout=2, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_updates()
- async getUserProfilePhotos(user_id, offset=None, limit=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_user_profile_photos()
- async getWebhookInfo(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_webhook_info()
- async get_chat(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.).
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
- Raises
- async get_chat_administrators(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to get a list of administrators in a chat.
See also
Changed in version 20.0: Returns a tuple instead of a list.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success, returns a tuple of
ChatMember
objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.- Return type
Tuple[
telegram.ChatMember
]- Raises
- async get_chat_member(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat.
See also
- Parameters
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
- Raises
- async get_chat_member_count(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to get the number of members in a chat.
See also
New in version 13.7.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
Number of members in the chat.
- Return type
- Raises
Use this method to get the current value of the bot’s menu button in a private chat, or the default menu button.
See also
set_chat_menu_button()
,telegram.Chat.get_menu_button()
,telegram.Chat.set_menu_button()
,telegram.User.get_menu_button()
,telegram.User.set_menu_button()
New in version 20.0.
- Parameters
chat_id (
int
, optional) – Unique identifier for the target private chat. If not specified, default bot’s menu button will be returned.- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success, the current menu button is returned.
- Return type
- async get_custom_emoji_stickers(custom_emoji_ids, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to get information about emoji stickers by their identifiers.
Changed in version 20.0: Returns a tuple instead of a list.
- Parameters
custom_emoji_ids (Sequence[
str
]) –Sequence of custom emoji identifiers. At most
200
custom emoji identifiers can be specified.Changed in version 20.0: Accepts any
collections.abc.Sequence
as input instead of just a list.- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
Tuple[
telegram.Sticker
]- Raises
- async get_file(file_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to
20 MB
in size. The file can then be e.g. downloaded withtelegram.File.download_to_drive()
. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling get_file again.Note
This function may not preserve the original file name and MIME type. You should save the file’s MIME type and name (if available) when the File object is received.
See also
telegram.Animation.get_file()
,telegram.Audio.get_file()
,telegram.ChatPhoto.get_big_file()
,telegram.ChatPhoto.get_small_file()
,telegram.Document.get_file()
,telegram.PassportFile.get_file()
,telegram.PhotoSize.get_file()
,telegram.Sticker.get_file()
,telegram.Video.get_file()
,telegram.VideoNote.get_file()
,telegram.Voice.get_file()
, Working with Files and Media- Parameters
file_id (
str
|telegram.Animation
|telegram.Audio
|telegram.ChatPhoto
|telegram.Document
|telegram.PhotoSize
|telegram.Sticker
|telegram.Video
|telegram.VideoNote
|telegram.Voice
) – Either the file identifier or an object that has a file_id attribute to get file information about.- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
- Raises
- async get_forum_topic_icon_stickers(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
- Use this method to get custom emoji stickers, which can be used as a forum topic
icon by any user. Requires no parameters.
New in version 20.0.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
Tuple[
telegram.Sticker
]- Raises
- async get_game_high_scores(user_id, chat_id=None, message_id=None, inline_message_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game.
Changed in version 20.0: Returns a tuple instead of a list.
Note
This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change.
- Parameters
chat_id (
int
|str
, optional) – Required ifinline_message_id
is not specified. Unique identifier for the target chat.message_id (
int
, optional) – Required ifinline_message_id
is not specified. Identifier of the sent message.inline_message_id (
str
, optional) – Required ifchat_id
andmessage_id
are not specified. Identifier of the inline message.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
Tuple[
telegram.GameHighScore
]- Raises
- async get_me(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
A simple method for testing your bot’s auth token. Requires no parameters.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
A
telegram.User
instance representing that bot if the credentials are valid,None
otherwise.- Return type
- Raises
- async get_my_commands(scope=None, language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to get the current list of the bot’s commands for the given scope and user language.
See also
Changed in version 20.0: Returns a tuple instead of a list.
- Parameters
scope (
telegram.BotCommandScope
, optional) –An object, describing scope of users. Defaults to
telegram.BotCommandScopeDefault
.New in version 13.7.
language_code (
str
, optional) –A two-letter ISO 639-1 language code or an empty string.
New in version 13.7.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success, the commands set for the bot. An empty tuple is returned if commands are not set.
- Return type
Tuple[
telegram.BotCommand
]- Raises
- async get_my_default_administrator_rights(for_channels=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to get the current default administrator rights of the bot.
New in version 20.0.
- Parameters
for_channels (
bool
, optional) – PassTrue
to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success.
- Return type
- Raises
- async get_sticker_set(name, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to get a sticker set.
- Parameters
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
- Raises
- async get_updates(offset=None, limit=None, timeout=None, allowed_updates=None, *, read_timeout=2, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to receive incoming updates using long polling.
Changed in version 20.0: Returns a tuple instead of a list.
Note
This method will not work if an outgoing webhook is set up.
In order to avoid getting duplicate updates, recalculate offset after each server response.
To take full advantage of this library take a look at
telegram.ext.Updater
- Parameters
offset (
int
, optional) – Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as this method is called with an offset higher than itstelegram.Update.update_id
. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.limit (
int
, optional) – Limits the number of updates to be retrieved. Values between1
-100
are accepted. Defaults to100
.timeout (
int
, optional) – Timeout in seconds for long polling. Defaults to0
, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.allowed_updates (Sequence[
str
]), optional) –A sequence the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See
telegram.Update
for a complete list of available update types. Specify an empty sequence to receive all updates excepttelegram.Update.chat_member
(default). If not specified, the previous setting will be used. Please note that this parameter doesn’t affect updates created before the call to the get_updates, so unwanted updates may be received for a short period of time.Changed in version 20.0: Accepts any
collections.abc.Sequence
as input instead of just a list.
- Keyword Arguments
read_timeout (
float
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults to2
.timeout
will be added to this value.write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
Tuple[
telegram.Update
]- Raises
- async get_user_profile_photos(user_id, offset=None, limit=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to get a list of profile pictures for a user.
See also
- Parameters
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
- Raises
- async get_webhook_info(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to get current webhook status. Requires no parameters.
If the bot is using
get_updates()
, will return an object with thetelegram.WebhookInfo.url
field empty.- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
- async hideGeneralForumTopic(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
hide_general_forum_topic()
- async hide_general_forum_topic(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to hide the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have
can_manage_topics
administrator rights. The topic will be automatically closed if it was open.New in version 20.0.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
).- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- property id[source]¶
Unique identifier for this bot. Shortcut for the corresponding attribute of
bot
.- Type
- async initialize()[source]¶
Initialize resources used by this class. Currently calls
get_me()
to cachebot
and callstelegram.request.BaseRequest.initialize()
for the request objects used by this bot.See also
New in version 20.0.
- property last_name[source]¶
Optional. Bot’s last name. Shortcut for the corresponding attribute of
bot
.- Type
- async leaveChat(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
leave_chat()
- async leave_chat(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method for your bot to leave a group, supergroup or channel.
See also
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async logOut(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
log_out()
- async log_out(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success
- Return type
- Raises
- async pinChatMessage(chat_id, message_id, disable_notification=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
pin_chat_message()
- async pin_chat_message(chat_id, message_id, disable_notification=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the
can_pin_messages
admin right in a supergroup orcan_edit_messages
admin right in a channel.- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).message_id (
int
) – Identifier of a message to pin.disable_notification (
bool
, optional) – PassTrue
, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- property private_key[source]¶
Deserialized private key for decryption of telegram passport data.
New in version 20.0.
- async promoteChatMember(chat_id, user_id, can_change_info=None, can_post_messages=None, can_edit_messages=None, can_delete_messages=None, can_invite_users=None, can_restrict_members=None, can_pin_messages=None, can_promote_members=None, is_anonymous=None, can_manage_chat=None, can_manage_video_chats=None, can_manage_topics=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
promote_chat_member()
- async promote_chat_member(chat_id, user_id, can_change_info=None, can_post_messages=None, can_edit_messages=None, can_delete_messages=None, can_invite_users=None, can_restrict_members=None, can_pin_messages=None, can_promote_members=None, is_anonymous=None, can_manage_chat=None, can_manage_video_chats=None, can_manage_topics=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass
False
for all boolean parameters to demote a user.See also
Changed in version 20.0: The argument
can_manage_voice_chats
was renamed tocan_manage_video_chats
in accordance to Bot API 6.0.- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).is_anonymous (
bool
, optional) – PassTrue
, if the administrator’s presence in the chat is hidden.can_manage_chat (
bool
, optional) –Pass
True
, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege.New in version 13.4.
can_manage_video_chats (
bool
, optional) –Pass
True
, if the administrator can manage video chats.New in version 20.0.
can_change_info (
bool
, optional) – PassTrue
, if the administrator can change chat title, photo and other settings.can_post_messages (
bool
, optional) – PassTrue
, if the administrator can create channel posts, channels only.can_edit_messages (
bool
, optional) – PassTrue
, if the administrator can edit messages of other users and can pin messages, channels only.can_delete_messages (
bool
, optional) – PassTrue
, if the administrator can delete messages of other users.can_invite_users (
bool
, optional) – PassTrue
, if the administrator can invite new users to the chat.can_restrict_members (
bool
, optional) – PassTrue
, if the administrator can restrict, ban or unban chat members.can_pin_messages (
bool
, optional) – PassTrue
, if the administrator can pin messages, supergroups only.can_promote_members (
bool
, optional) – PassTrue
, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him).can_manage_topics (
bool
, optional) –Pass
True
, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only.New in version 20.0.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async reopenForumTopic(chat_id, message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
reopen_forum_topic()
- async reopenGeneralForumTopic(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
reopen_general_forum_topic()
- async reopen_forum_topic(chat_id, message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have
can_manage_topics
administrator rights, unless it is the creator of the topic.New in version 20.0.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
).message_thread_id (
int
) – Unique identifier for the target message thread of the forum topic.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- async reopen_general_forum_topic(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to reopen a closed ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have
can_manage_topics
administrator rights. The topic will be automatically unhidden if it was hidden.New in version 20.0.
- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
).- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..write_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.write_timeout
. Defaults toDEFAULT_NONE
.connect_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.connect_timeout
. Defaults toDEFAULT_NONE
.pool_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.pool_timeout
. Defaults toDEFAULT_NONE
.api_kwargs (
dict
, optional) – Arbitrary keyword arguments to be passed to the Telegram API.
- Returns
On success,
True
is returned.- Return type
- Raises
- property request[source]¶
The
BaseRequest
object used by this bot.Warning
Requests to the Bot API are made by the various methods of this class. This attribute should not be used manually.
- async restrictChatMember(chat_id, user_id, permissions, until_date=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
restrict_chat_member()
- async restrict_chat_member(chat_id, user_id, permissions, until_date=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass
True
for all boolean parameters to lift restrictions from a user.- Parameters
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
).until_date (
int
|datetime.datetime
, optional) – Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever. For timezone naivedatetime.datetime
objects, the default timezone of the bot will be used, which is UTC unlesstelegram.ext.Defaults.tzinfo
is used.permissions (
telegram.ChatPermissions
) – An object for new user permissions.
- Keyword Arguments
read_timeout (
float
|None
, optional) – Value to pass totelegram.request.BaseRequest.post.read_timeout
. Defaults toDEFAULT_NONE
..