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
,contextlib.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 bot.shutdown()
Available In
See also
__aenter__()
and__aexit__()
.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. The limitations to this argument are the same as the ones described indo_api_request()
.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
Added 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.
Changed in version 20.5: Removed deprecated methods
set_sticker_set_thumb
andsetStickerSetThumb
. Useset_sticker_set_thumbnail()
andsetStickerSetThumbnail()
instead.- 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
.Added 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 paid media to channels
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 copying the contents of an multiple arbitrary messages
Used for forwarding messages
Used for forwarding multiple messages at once
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 deleting messages.
Used for deleting multiple messages as once.
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 setting reactions on messages
Chat Moderation and information
Used for approving a chat join request
Used for declining a chat join request
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 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 getting information about the business account.
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 getting the list of boosts added to a chat
Used for leaving a chat
Bot settings
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 setting the description of the bot
Used for obtaining the description of the bot
Used for setting the short description of the bot
Used for obtaining the short description of the bot
Used for setting the name of the bot
Used for obtaining the name of the bot
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 deleting a sticker set made by a bot
Used for setting a sticker set of a chat
Used for deleting the set sticker set of a chat
Used for replacing a sticker in a set
Used for moving a sticker’s position in the set
Used for setting the title of a sticker set
Used for setting the emoji list of a sticker
Used for setting the keywords of a sticker
Used for setting the mask position of a mask sticker
Used for setting the thumbnail of a sticker set
Used for setting the thumbnail of a custom emoji 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
Used to unpin all messages in the general 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
Used for obtaining the bot’s Telegram Stars transactions
Used for refunding a payment in Telegram Stars
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
- async __aenter__()[source]¶
Asynchronous context manager which
initializes
the Bot.- Returns:
The initialized Bot instance.
- Raises:
Exception – If an exception is raised during initialization,
shutdown()
is called in this case.
- async __aexit__(exc_type, exc_val, exc_tb)[source]¶
Asynchronous context manager which
shuts down
the Bot.
- __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.Added in version 20.0.
- Raises:
- __eq__(other)[source]¶
Defines equality condition for the
telegram.Bot
object. Two objects of this class are considered to be equal if their attributesbot
are equal.
- __reduce__()[source]¶
Customizes how
copy.deepcopy()
processes objects of this type. Bots can not be pickled and this method will always raise an exception.Added in version 20.0.
- Raises:
- __repr__()[source]¶
Give a string representation of the bot in the form
Bot[token=...]
.As this class doesn’t implement
object.__str__()
, the default implementation will be used, which is equivalent to__repr__()
.- Returns:
- async addStickerToSet(user_id, name, sticker, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
add_sticker_to_set()
- async add_sticker_to_set(user_id, name, sticker, *, read_timeout=None, write_timeout=None, 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. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to
200
stickers. Other sticker sets can have up to120
stickers.Changed in version 20.2: Since Bot API 6.6, the parameter
sticker
replace the parameterspng_sticker
,tgs_sticker
,webm_sticker
,emojis
, andmask_position
.Changed in version 20.5: Removed deprecated parameters
png_sticker
,tgs_sticker
,webm_sticker
,emojis
, andmask_position
.- 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 to
telegram.request.BaseRequest.post.write_timeout
. By default,20
seconds are used as write timeout.Deprecated since version 20.7: In future versions, the default value will be changed to
DEFAULT_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. Seedo_api_request()
for limitations.
- 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, button=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.
Shortcuts
- 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. Seedo_api_request()
for limitations.
- Returns:
- Raises:
- async answer_inline_query(inline_query_id, results, cache_time=None, is_personal=None, next_offset=None, button=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.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.Shortcuts
See also
Changed in version 20.5: Removed deprecated arguments
switch_pm_text
andswitch_pm_parameter
.- 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.button (
telegram.InlineQueryResultsButton
, optional) –A button to be shown above the inline query results.
Added in version 20.3.
- 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. Seedo_api_request()
for limitations.
- 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.
Shortcuts
- 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. Seedo_api_request()
for limitations.
- 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.Shortcuts
- 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. Seedo_api_request()
for limitations.
- 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.
Added 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. Seedo_api_request()
for limitations.
- 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.Added 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. Seedo_api_request()
for limitations.
- 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.
Added 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.Added 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. Seedo_api_request()
for limitations.
- 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.
Added 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. Seedo_api_request()
for limitations.
- 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
.Added in version 20.0.
- Type:
- property base_url[source]¶
Telegram Bot API service URL, built from
Bot.base_url
andBot.token
.Added 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. Seedo_api_request()
for limitations.
- Returns:
On success,
True
is returned.- 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.Shortcuts
Added 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. Seedo_api_request()
for limitations.
- 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.Added 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. Seedo_api_request()
for limitations.
- 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_markup=None, protect_content=None, message_thread_id=None, reply_parameters=None, show_caption_above_media=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_id=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
copy_message()
- async copyMessages(chat_id, from_chat_id, message_ids, disable_notification=None, protect_content=None, message_thread_id=None, remove_caption=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
copy_messages()
- async copy_message(chat_id, from_chat_id, message_id, caption=None, parse_mode=None, caption_entities=None, disable_notification=None, reply_markup=None, protect_content=None, message_thread_id=None, reply_parameters=None, show_caption_above_media=None, allow_paid_broadcast=None, *, allow_sending_without_reply=None, reply_to_message_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, paid media messages, giveaway messages, giveaway winners 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.Shortcuts
- 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.
Added in version 13.10.
message_thread_id (
int
, optional) –Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.
Added in version 20.0.
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.reply_parameters (
telegram.ReplyParameters
, optional) –Description of the message to reply to.
Added in version 20.8.
show_caption_above_media (
bool
, optional) –Pass
True
, if the caption must be shown above the message media.Added in version 21.3.
allow_paid_broadcast (
bool
, optional) –Pass True to allow up to
1000
messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.Added in version 21.7.
- Keyword Arguments:
allow_sending_without_reply (
bool
, optional) –Pass
True
, if the message should be sent even if the specified replied-to message is not found. Mutually exclusive withreply_parameters
, which this is a convenience parameter forChanged in version 20.8: Bot API 7.0 introduced
reply_parameters
replacing this argument. PTB will automatically convert this argument to that one, but you should update your code to use the new argument.Changed in version 21.0: This argument is now a keyword-only argument.
reply_to_message_id (
int
, optional) –If the message is a reply, ID of the original message. Mutually exclusive with
reply_parameters
, which this is a convenience parameter forChanged in version 20.8: Bot API 7.0 introduced
reply_parameters
replacing this argument. PTB will automatically convert this argument to that one, but you should update your code to use the new argument.Changed in version 21.0: This argument is now a keyword-only argument.
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. Seedo_api_request()
for limitations.
- Returns:
- On success, the
telegram.MessageId
of the sent message is returned.
- On success, the
- Return type:
- Raises:
- async copy_messages(chat_id, from_chat_id, message_ids, disable_notification=None, protect_content=None, message_thread_id=None, remove_caption=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. If some of the specified messages can’t be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can’t be copied. A quiz poll can be copied only if the value of the field
telegram.Poll.correct_option_id
is known to the bot. The method is analogous to the methodforward_messages()
, but the copied messages don’t have a link to the original message. Album grouping is kept for copied messages.Added in version 20.8.
- 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_ids (Sequence[
int
]) – A list of1
-100
identifiers of messages in the chatfrom_chat_id
to copy. The identifiers must be specified in a strictly increasing order.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.message_thread_id (
int
, optional) – Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.remove_caption (
bool
, optional) – PassTrue
to copy the messages without their captions.
- 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. Seedo_api_request()
for limitations.
- Returns:
On success, a tuple of
MessageId
of the sent messages is returned.- Return type:
tuple[
telegram.MessageId
]- 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 createChatSubscriptionInviteLink(chat_id, subscription_period, subscription_price, name=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
create_chat_subscription_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, stickers, sticker_type=None, needs_repainting=None, *, read_timeout=None, write_timeout=None, 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()
.Note
When joining public groups via an invite link, Telegram clients may display the usual “Join” button, effectively ignoring the invite link. In particular, the parameter
creates_join_request
has no effect in this case. However, this behavior is undocument and may be subject to change. See this GitHub thread for some discussion.Added 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.Added 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.Added 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. Seedo_api_request()
for limitations.
- Returns:
- Raises:
- async create_chat_subscription_invite_link(chat_id, subscription_period, subscription_price, name=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to create a subscription invite link for a channel chat. The bot must have the
can_invite_users
administrator right. The link can be edited using theedit_chat_subscription_invite_link()
or revoked using therevoke_chat_invite_link()
.Added in version 21.5.
- Parameters:
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).subscription_period (
int
) – The number of seconds the subscription will be active for before the next payment. Currently, it must always be2592000
(30 days).subscription_price (
int
) – The number of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat;1
-2500
.
- 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. Seedo_api_request()
for limitations.
- 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.Added 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. Seedo_api_request()
for limitations.
- 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.
Added 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 it for your internal processes.provider_token (
str
) –Payments provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
Deprecated since version 21.3: As of Bot API 7.4, this parameter is now optional and future versions of the library will make it optional as well.
currency (
str
) – Three-letter ISO 4217 currency code, see more on currencies. PassXTR
for payments in Telegram Stars.prices (Sequence[
telegram.LabeledPrice
) –Price breakdown, a sequence of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
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 ofUS$ 1.45
passmax_tip_amount = 145
. See theexp
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
. Not supported for payments in Telegram Stars.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. Ignored for payments in Telegram Stars.need_phone_number (
bool
, optional) – PassTrue
, if you require the user’s phone number to complete the order. Ignored for payments in Telegram Stars.need_email (
bool
, optional) – PassTrue
, if you require the user’s email address to complete the order. Ignored for payments in Telegram Stars.need_shipping_address (
bool
, optional) – PassTrue
, if you require the user’s shipping address to complete the order. Ignored for payments in Telegram Stars.send_phone_number_to_provider (
bool
, optional) – PassTrue
, if user’s phone number should be sent to provider. Ignored for payments in Telegram Stars.send_email_to_provider (
bool
, optional) – PassTrue
, if user’s email address should be sent to provider. Ignored for payments in Telegram Stars.is_flexible (
bool
, optional) – PassTrue
, if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
- 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. Seedo_api_request()
for limitations.
- Returns:
On success, the created invoice link is returned.
- Return type:
- async create_new_sticker_set(user_id, name, title, stickers, sticker_type=None, needs_repainting=None, *, read_timeout=None, write_timeout=None, 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 thus created.
Changed in version 20.0: The parameter
contains_masks
has been removed. Usesticker_type
instead.Changed in version 20.2: Since Bot API 6.6, the parameters
stickers
andsticker_format
replace the parameterspng_sticker
,tgs_sticker
,``webm_sticker``,emojis
, andmask_position
.Changed in version 20.5: Removed the deprecated parameters mentioned above and adjusted the order of the parameters.
Removed in version 21.2: Removed the deprecated parameter
sticker_format
.- 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.stickers (Sequence[
telegram.InputSticker
]) –A sequence of
1
-50
initial stickers to be added to the sticker set.Added in version 20.2.
sticker_type (
str
, optional) –Type of stickers in the set, pass
telegram.Sticker.REGULAR
ortelegram.Sticker.MASK
, ortelegram.Sticker.CUSTOM_EMOJI
. By default, a regular sticker set is createdAdded in version 20.0.
needs_repainting (
bool
, optional) –Pass
True
if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only.Added in version 20.2.
- 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 to
telegram.request.BaseRequest.post.write_timeout
. By default,20
seconds are used as write timeout.Deprecated since version 20.7: In future versions, the default value will be changed to
DEFAULT_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. Seedo_api_request()
for limitations.
- 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.Added 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. Seedo_api_request()
for limitations.
- 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 deleteMessages(chat_id, message_ids, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
delete_messages()
- 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 deleteStickerSet(name, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
delete_sticker_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.
- 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. Seedo_api_request()
for limitations.
- 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.ChatFullInfo.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. Seedo_api_request()
for limitations.
- 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.Shortcuts
Added 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. Seedo_api_request()
for limitations.
- 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.
See also
telegram.CallbackQuery.delete_message()
(callsdelete_message()
indirectly, viatelegram.Message.delete()
)- 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. Seedo_api_request()
for limitations.
- Returns:
On success,
True
is returned.- Return type:
- Raises:
- async delete_messages(chat_id, message_ids, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to delete multiple messages simultaneously. If some of the specified messages can’t be found, they are skipped.
Shortcuts
Added in version 20.8.
- Parameters:
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel (in the format@channelusername
).message_ids (Sequence[
int
]) – A list of1
-100
identifiers of messages to delete. Seedelete_message()
for limitations on which messages can be deleted.
- 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. Seedo_api_request()
for limitations.
- 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.
Added 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. Seedo_api_request()
for limitations.
- 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. Seedo_api_request()
for limitations.
- Returns:
On success,
True
is returned.- Return type:
- Raises:
- async delete_sticker_set(name, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to delete a sticker set that was created by the bot.
Added in version 20.2.
- 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. Seedo_api_request()
for limitations.
- 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. Seedo_api_request()
for limitations.
- Returns:
On success,
True
is returned.- Return type:
- Raises:
- async do_api_request(endpoint, api_kwargs=None, return_type=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None)[source]¶
Do a request to the Telegram API.
This method is here to make it easier to use new API methods that are not yet supported by this library.
Hint
Since PTB does not know which arguments are passed to this method, some caution is necessary in terms of PTBs utility functionalities. In particular
passing objects of any class defined in the
telegram
module is supportedwhen uploading files, a
telegram.InputFile
must be passed as the value for the corresponding argument. Passing a file path or file-like object will not work. File paths will work only in combination withlocal_mode
.when uploading files, PTB can still correctly determine that a special write timeout value should be used instead of the default
telegram.request.HTTPXRequest.write_timeout
.insertion of default values specified via
telegram.ext.Defaults
will not work (only relevant fortelegram.ext.ExtBot
).The only exception is
telegram.ext.Defaults.tzinfo
, which will be correctly applied todatetime.datetime
objects.
Added in version 20.8.
- Parameters:
endpoint (
str
) – The API endpoint to use, e.g.getMe
orget_me
.api_kwargs (
dict
, optional) – The keyword arguments to pass to the API call. If not specified, no arguments are passed.return_type (
telegram.TelegramObject
, optional) – If specified, the result of the API call will be deserialized into an instance of this class or tuple of instances of this class. If not specified, the raw result of the API call will be returned.
- Returns:
The result of the API call. If
return_type
is not specified, this is adict
orbool
, otherwise an instance ofreturn_type
or a tuple ofreturn_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 editChatSubscriptionInviteLink(chat_id, invite_link, name=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
edit_chat_subscription_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, show_caption_above_media=None, business_connection_id=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, live_period=None, business_connection_id=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, business_connection_id=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, business_connection_id=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, reply_markup=None, entities=None, link_preview_options=None, business_connection_id=None, *, disable_web_page_preview=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.
Added 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.Added 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.Added 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. Seedo_api_request()
for limitations.
- Returns:
- Raises:
- async edit_chat_subscription_invite_link(chat_id, invite_link, name=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to edit a subscription invite link created by the bot. The bot must have
telegram.ChatPermissions.can_invite_users
administrator right.Added in version 21.5.
- 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.Invite link name; 0-
32
characters.Tip
Omitting this argument removes the name of the invite link.
- 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. Seedo_api_request()
for limitations.
- 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 the
can_manage_topics
administrator rights, unless it is the creator of the topic.Shortcuts
Added 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. Seedo_api_request()
for limitations.
- 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 the
can_manage_topics
administrator rights.Added 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. Seedo_api_request()
for limitations.
- Returns:
On success,
True
is returned.- Return type:
- Raises:
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.Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
- 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.show_caption_above_media (
bool
, optional) –Pass
True
, if the caption must be shown above the message media.Added in version 21.3.
business_connection_id (
str
, optional) –Unique identifier of the business connection on behalf of which the message to be edited was sent
Added in version 21.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. Seedo_api_request()
for limitations.
- 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, live_period=None, business_connection_id=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.live_period (
int
, optional) –New period in seconds during which the location can be updated, starting from the message send date. If
2147483647
is specified, then the location can be updated forever. Otherwise, the new value must not exceed the currentlive_period
by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, thenlive_period
remains unchangedAdded in version 21.2..
business_connection_id (
str
, optional) –Unique identifier of the business connection on behalf of which the message to be edited was sent
Added in version 21.4.
- 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. Seedo_api_request()
for limitations.
- 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, business_connection_id=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, or to add media to text 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.Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
See also
- 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.business_connection_id (
str
, optional) –Unique identifier of the business connection on behalf of which the message to be edited was sent
Added in version 21.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. Seedo_api_request()
for limitations.
- 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, business_connection_id=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.Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
- 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.business_connection_id (
str
, optional) –Unique identifier of the business connection on behalf of which the message to be edited was sent
Added in version 21.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. Seedo_api_request()
for limitations.
- 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, reply_markup=None, entities=None, link_preview_options=None, business_connection_id=None, *, disable_web_page_preview=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.Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
See also
- 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.link_preview_options (
LinkPreviewOptions
, optional) –Link preview generation options for the message. Mutually exclusive with
disable_web_page_preview
.Added in version 20.8.
reply_markup (
telegram.InlineKeyboardMarkup
, optional) – An object for an inline keyboard.business_connection_id (
str
, optional) –Unique identifier of the business connection on behalf of which the message to be edited was sent
Added in version 21.4.
- Keyword Arguments:
disable_web_page_preview (
bool
, optional) –Disables link previews for links in this message. Convenience parameter for setting
link_preview_options
. Mutually exclusive withlink_preview_options
.Changed in version 20.8: Bot API 7.0 introduced
link_preview_options
replacing this argument. PTB will automatically convert this argument to that one, but for advanced options, please uselink_preview_options
directly.Changed in version 21.0: This argument is now a keyword-only argument.
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. Seedo_api_request()
for limitations.
- Returns:
On success, if edited message is not an inline message, the edited message is returned, otherwise
True
is returned.- Return type:
- Raises:
ValueError – If both
disable_web_page_preview
andlink_preview_options
are passed.telegram.error.TelegramError – For other errors.
- 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.- 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. Seedo_api_request()
for limitations.
- 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 forwardMessages(chat_id, from_chat_id, message_ids, 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_messages()
- 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.ChatFullInfo.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.
Added in version 13.10.
message_thread_id (
int
, optional) –Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.
Added 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. Seedo_api_request()
for limitations.
- Returns:
On success, the sent Message is returned.
- Return type:
- Raises:
- async forward_messages(chat_id, from_chat_id, message_ids, 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. If some of the specified messages can’t be found or forwarded, they are skipped. Service messages and messages with protected content can’t be forwarded. Album grouping is kept for forwarded messages.
Added in version 20.8.
- 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_ids (Sequence[
int
]) – A list of1
-100
identifiers of messages in the chatfrom_chat_id
to forward. The identifiers must be specified in a strictly increasing order.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.message_thread_id (
int
, optional) – Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.
- 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. Seedo_api_request()
for limitations.
- Returns:
On success, a tuple of
MessageId
of sent messages is returned.- Return type:
tuple[
telegram.Message
]- Raises:
- async getBusinessConnection(business_connection_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_business_connection()
- 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 getMyDescription(language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_my_description()
- async getMyName(language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_my_name()
- async getMyShortDescription(language_code=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_my_short_description()
- async getStarTransactions(offset=None, limit=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_star_transactions()
- 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=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_updates()
- async getUserChatBoosts(chat_id, user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Alias for
get_user_chat_boosts()
- 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_business_connection(business_connection_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Use this method to get information about the connection of the bot with a business account.
Added in version 21.1.
- Parameters:
business_connection_id (
str
) – Unique identifier of the business connection.- 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. Seedo_api_request()
for limitations.
- Returns:
- On success, the object containing the business
connection information is returned.
- Return type:
- Raises:
- 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.).
Changed in version 21.2: In accordance to Bot API 7.3, this method now returns a
telegram.ChatFullInfo
.- 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. Seedo_api_request()
for limitations.
- 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.
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. Seedo_api_request()
for limitations.
- 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 only guaranteed to work for other users if the bot is an administrator in the chat.
- 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. Seedo_api_request()
for limitations.
- 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.
Added 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. Seedo_api_request()
for limitations.
- 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.
Shortcuts
Added 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. Seedo_api_request()
for limitations.
- 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. Seedo_api_request()
for limitations.
- 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
- 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. Seedo_api_request()
for limitations.
- 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.
Added 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. Seedo_api_request()
for limitations.
- 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.
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.
Changed in version 20.0: Returns a tuple instead of a list.
- Parameters:
chat_id (
int
, 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. Seedo_api_request()
for limitations.
- 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. Seedo_api_request()
for limitations.
- 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
.Added in version 13.7.
language_code (
str
, optional) –A two-letter ISO 639-1 language code or an empty string.
Added 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. Seedo_api_request()
for limitations.
- 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.
Added 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
.