ChatFullInfo

class telegram.ChatFullInfo(id, type, accent_color_id, max_reaction_count, title=None, username=None, first_name=None, last_name=None, is_forum=None, photo=None, active_usernames=None, birthdate=None, business_intro=None, business_location=None, business_opening_hours=None, personal_chat=None, available_reactions=None, background_custom_emoji_id=None, profile_accent_color_id=None, profile_background_custom_emoji_id=None, emoji_status_custom_emoji_id=None, emoji_status_expiration_date=None, bio=None, has_private_forwards=None, has_restricted_voice_and_video_messages=None, join_to_send_messages=None, join_by_request=None, description=None, invite_link=None, pinned_message=None, permissions=None, slow_mode_delay=None, unrestrict_boost_count=None, message_auto_delete_time=None, has_aggressive_anti_spam_enabled=None, has_hidden_members=None, has_protected_content=None, has_visible_history=None, sticker_set_name=None, can_set_sticker_set=None, custom_emoji_sticker_set_name=None, linked_chat_id=None, location=None, can_send_paid_media=None, *, api_kwargs=None)[source]

Bases: telegram.TelegramObject

This object contains full information about a chat.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their id is equal.

Returned In

telegram.Bot.get_chat()

Added in version 21.2.

Changed in version 21.3: Explicit support for all shortcut methods known from telegram.Chat on this object. Previously those were only available because this class inherited from telegram.Chat.

Parameters:
id[source]

Unique identifier for this chat.

Type:

int

type[source]

Type of chat, can be either PRIVATE, GROUP, SUPERGROUP or CHANNEL.

Type:

str

accent_color_id[source]

Optional. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details.

Added in version 20.8.

Type:

int

max_reaction_count[source]

The maximum number of reactions that can be set on a message in the chat.

Added in version 21.2.

Type:

int

title[source]

Title, for supergroups, channels and group chats.

Type:

str, optional

username[source]

Username, for private chats, supergroups and channels if available.

Type:

str, optional

first_name[source]

First name of the other party in a private chat.

Type:

str, optional

last_name[source]

Last name of the other party in a private chat.

Type:

str, optional

is_forum[source]

True, if the supergroup chat is a forum (has topics enabled).

Added in version 20.0.

Type:

bool, optional

photo[source]

Optional. Chat photo.

Type:

telegram.ChatPhoto

active_usernames[source]

Optional. If set, the list of all active chat usernames; for private chats, supergroups and channels.

This list is empty if the chat has no active usernames or this chat instance was not obtained via get_chat().

Added in version 20.0.

Type:

Tuple[str]

birthdate[source]

Optional. For private chats, the date of birth of the user.

Added in version 21.1.

Type:

telegram.Birthdate

business_intro[source]

Optional. For private chats with business accounts, the intro of the business.

Added in version 21.1.

Type:

telegram.BusinessIntro

business_location[source]

Optional. For private chats with business accounts, the location of the business.

Added in version 21.1.

Type:

telegram.BusinessLocation

business_opening_hours[source]

Optional. For private chats with business accounts, the opening hours of the business.

Added in version 21.1.

Type:

telegram.BusinessOpeningHours

personal_chat[source]

Optional. For private chats, the personal channel of the user.

Added in version 21.1.

Type:

telegram.Chat

available_reactions[source]

Optional. List of available reactions allowed in the chat. If omitted, then all of telegram.constants.ReactionEmoji are allowed.

Added in version 20.8.

Type:

Tuple[telegram.ReactionType]

background_custom_emoji_id[source]

Optional. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background.

Added in version 20.8.

Type:

str

profile_accent_color_id[source]

Optional. Identifier of the accent color for the chat’s profile background. See profile accent colors for more details.

Added in version 20.8.

Type:

int

profile_background_custom_emoji_id[source]

Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background.

Added in version 20.8.

Type:

str

emoji_status_custom_emoji_id[source]

Optional. Custom emoji identifier of emoji status of the chat or the other party in a private chat.

Added in version 20.0.

Type:

str

emoji_status_expiration_date[source]

Optional. Expiration date of emoji status of the chat or the other party in a private chat, as a datetime object, if any.

The default timezone of the bot is used for localization, which is UTC unless telegram.ext.Defaults.tzinfo is used.

Added in version 20.5.

Type:

datetime.datetime

bio[source]

Optional. Bio of the other party in a private chat.

Type:

str

has_private_forwards[source]

Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user.

Added in version 13.9.

Type:

bool

has_restricted_voice_and_video_messages[source]

Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat.

Added in version 20.0.

Type:

bool

join_to_send_messages[source]

Optional. True, if users need to join the supergroup before they can send messages.

Added in version 20.0.

Type:

bool

join_by_request[source]

Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators.

Added in version 20.0.

Type:

bool

description[source]

Optional. Description, for groups, supergroups and channel chats.

Type:

str

Optional. Primary invite link, for groups, supergroups and channel.

Type:

str

pinned_message[source]

Optional. The most recent pinned message (by sending date).

Type:

telegram.Message

permissions[source]

Optional. Default chat member permissions, for groups and supergroups.

Type:

telegram.ChatPermissions

slow_mode_delay[source]

Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user.

Type:

int

unrestrict_boost_count[source]

Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions.

Added in version 21.0.

Type:

int

message_auto_delete_time[source]

Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds.

Added in version 13.4.

Type:

int

has_aggressive_anti_spam_enabled[source]

Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.

Added in version 20.0.

Type:

bool

has_hidden_members[source]

Optional. True, if non-administrators can only get the list of bots and administrators in the chat.

Added in version 20.0.

Type:

bool

has_protected_content[source]

Optional. True, if messages from the chat can’t be forwarded to other chats.

Added in version 13.9.

Type:

bool

has_visible_history[source]

Optional. True, if new chat members will have access to old messages; available only to chat administrators.

Added in version 20.8.

Type:

bool

sticker_set_name[source]

Optional. For supergroups, name of Group sticker set.

Type:

str

can_set_sticker_set[source]

Optional. True, if the bot can change group the sticker set.

Type:

bool

custom_emoji_sticker_set_name[source]

Optional. For supergroups, the name of the group’s custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.

Added in version 21.0.

Type:

str

linked_chat_id[source]

Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats.

Type:

int

location[source]

Optional. For supergroups, the location to which the supergroup is connected.

Type:

telegram.ChatLocation

can_send_paid_media[source]

Optional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.

Added in version 21.4.

Type:

bool

CHANNEL = 'channel'[source]

telegram.constants.ChatType.CHANNEL

GROUP = 'group'[source]

telegram.constants.ChatType.GROUP

PRIVATE = 'private'[source]

telegram.constants.ChatType.PRIVATE

SENDER = 'sender'[source]

telegram.constants.ChatType.SENDER

Added in version 13.5.

SUPERGROUP = 'supergroup'[source]

telegram.constants.ChatType.SUPERGROUP

async approve_join_request(user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.approve_chat_join_request(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.approve_chat_join_request().

Added in version 13.8.

Returns:

On success, True is returned.

Return type:

bool

async ban_chat(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.ban_chat_sender_chat(
    sender_chat_id=update.effective_chat.id, *args, **kwargs
)

For the documentation of the arguments, please see telegram.Bot.ban_chat_sender_chat().

Added in version 13.9.

Returns:

On success, True is returned.

Return type:

bool

async ban_member(user_id, revoke_messages=None, until_date=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.ban_chat_member(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.ban_chat_member().

Returns:

On success, True is returned.

Return type:

bool

async ban_sender_chat(sender_chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.ban_chat_sender_chat(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.ban_chat_sender_chat().

Added in version 13.9.

Returns:

On success, True is returned.

Return type:

bool

async close_forum_topic(message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.close_forum_topic(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.close_forum_topic().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async close_general_forum_topic(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.close_general_forum_topic(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.close_general_forum_topic().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async copy_message(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, *, reply_to_message_id=None, allow_sending_without_reply=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.copy_message(from_chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.copy_message().

See also

send_copy(), send_copies(), copy_messages().

Returns:

On success, returns the MessageId of the sent message.

Return type:

telegram.MessageId

async copy_messages(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]

Shortcut for:

await bot.copy_messages(from_chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.copy_messages().

See also

copy_message(), send_copy(), send_copies().

Added in version 20.8.

Returns:

On success, a tuple of MessageId of the sent messages is returned.

Return type:

Tuple[telegram.MessageId]

async create_forum_topic(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]

Shortcut for:

await bot.create_forum_topic(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.create_forum_topic().

Added in version 20.0.

Returns:

telegram.ForumTopic

Shortcut for:

await bot.create_chat_invite_link(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.create_chat_invite_link().

Added in version 13.4.

Changed in version 13.8: Edited signature according to the changes of telegram.Bot.create_chat_invite_link().

Returns:

telegram.ChatInviteLink

Shortcut for:

await bot.create_chat_subscription_invite_link(
    chat_id=update.effective_chat.id, *args, **kwargs
)

For the documentation of the arguments, please see telegram.Bot.create_chat_subscription_invite_link().

Added in version 21.5.

Returns:

telegram.ChatInviteLink

classmethod de_json(data, bot=None)[source]

See telegram.TelegramObject.de_json().

async decline_join_request(user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.decline_chat_join_request(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.decline_chat_join_request().

Added in version 13.8.

Returns:

On success, True is returned.

Return type:

bool

async delete_forum_topic(message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.delete_forum_topic(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.delete_forum_topic().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async delete_message(message_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.delete_message(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.delete_message().

Added in version 20.8.

Returns:

On success, True is returned.

Return type:

bool

async delete_messages(message_ids, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.delete_messages(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.delete_messages().

Added in version 20.8.

Returns:

On success, True is returned.

Return type:

bool

async delete_photo(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.delete_chat_photo(
    chat_id=update.effective_chat.id, *args, **kwargs
)

For the documentation of the arguments, please see telegram.Bot.delete_chat_photo().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async edit_forum_topic(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]

Shortcut for:

await bot.edit_forum_topic(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.edit_forum_topic().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async edit_general_forum_topic(name, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.edit_general_forum_topic(
   chat_id=update.effective_chat.id, *args, **kwargs
)

For the documentation of the arguments, please see telegram.Bot.edit_general_forum_topic().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

Shortcut for:

await bot.edit_chat_invite_link(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.edit_chat_invite_link().

Added in version 13.4.

Changed in version 13.8: Edited signature according to the changes of telegram.Bot.edit_chat_invite_link().

Returns:

telegram.ChatInviteLink

Shortcut for:

await bot.edit_chat_subscription_invite_link(
    chat_id=update.effective_chat.id, *args, **kwargs
)

For the documentation of the arguments, please see telegram.Bot.edit_chat_subscription_invite_link().

Added in version 21.5.

Returns:

telegram.ChatInviteLink

property effective_name[source]

Convenience property. Gives title if not None, else full_name if not None.

Added in version 20.1.

Type:

str

Shortcut for:

await bot.export_chat_invite_link(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.export_chat_invite_link().

Added in version 13.4.

Returns:

New invite link on success.

Return type:

str

async forward_from(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]

Shortcut for:

await bot.forward_message(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.forward_message().

See also

forward_to(), forward_messages_from(), forward_messages_to()

Added in version 20.0.

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async forward_messages_from(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]

Shortcut for:

await bot.forward_messages(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.forward_messages().

See also

forward_to(), forward_from(), forward_messages_to().

Added in version 20.8.

Returns:

On success, a tuple of MessageId of sent messages is returned.

Return type:

Tuple[telegram.MessageId]

async forward_messages_to(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]

Shortcut for:

await bot.forward_messages(from_chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.forward_messages().

See also

forward_from(), forward_to(), forward_messages_from().

Added in version 20.8.

Returns:

On success, a tuple of MessageId of sent messages is returned.

Return type:

Tuple[telegram.MessageId]

async forward_to(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]

Shortcut for:

await bot.forward_message(from_chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.forward_message().

See also

forward_from(), forward_messages_from(), forward_messages_to()

Added in version 20.0.

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

property full_name[source]

Convenience property. If first_name is not None, gives first_name followed by (if available) last_name.

Note

full_name will always be None, if the chat is a (super)group or channel.

Added in version 13.2.

Type:

str

async get_administrators(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.get_chat_administrators(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.get_chat_administrators().

Returns:

A tuple of administrators in a chat. An Array of telegram.ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.

Return type:

Tuple[telegram.ChatMember]

async get_member(user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.get_chat_member(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.get_chat_member().

Returns:

telegram.ChatMember

async get_member_count(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.get_chat_member_count(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.get_chat_member_count().

Returns:

int

async get_menu_button(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.get_chat_menu_button(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.get_chat_menu_button().

Caution

Can only work, if the chat is a private chat.

See also

set_menu_button()

Added in version 20.0.

Returns:

On success, the current menu button is returned.

Return type:

telegram.MenuButton

async get_user_chat_boosts(user_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.get_user_chat_boosts(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.get_user_chat_boosts().

Added in version 20.8.

Returns:

On success, returns the boosts applied in the chat.

Return type:

telegram.UserChatBoosts

async hide_general_forum_topic(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.hide_general_forum_topic(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.hide_general_forum_topic().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async leave(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.leave_chat(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.leave_chat().

Returns:

On success, True is returned.

Return type:

bool

Convenience property. If the chat has a username, returns a t.me link of the chat.

Type:

str

mention_html(name=None)[source]

Added in version 20.0.

Parameters:

name (str) – The name used as a link for the chat. Defaults to full_name.

Returns:

The inline mention for the chat as HTML.

Return type:

str

Raises:

TypeError – If the chat is a private chat and neither the name nor the first_name is set, then throw an TypeError. If the chat is a public chat and neither the name nor the title is set, then throw an TypeError. If chat is a private group chat, then throw an TypeError.

mention_markdown(name=None)[source]

Note

'Markdown' is a legacy mode, retained by Telegram for backward compatibility. You should use mention_markdown_v2() instead.

Added in version 20.0.

Parameters:

name (str) – The name used as a link for the chat. Defaults to full_name.

Returns:

The inline mention for the chat as markdown (version 1).

Return type:

str

Raises:

TypeError – If the chat is a private chat and neither the name nor the first_name is set, then throw an TypeError. If the chat is a public chat and neither the name nor the title is set, then throw an TypeError. If chat is a private group chat, then throw an TypeError.

mention_markdown_v2(name=None)[source]

Added in version 20.0.

Parameters:

name (str) – The name used as a link for the chat. Defaults to full_name.

Returns:

The inline mention for the chat as markdown (version 2).

Return type:

str

Raises:

TypeError – If the chat is a private chat and neither the name nor the first_name is set, then throw an TypeError. If the chat is a public chat and neither the name nor the title is set, then throw an TypeError. If chat is a private group chat, then throw an TypeError.

async pin_message(message_id, disable_notification=None, business_connection_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.pin_chat_message(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.pin_chat_message().

Returns:

On success, True is returned.

Return type:

bool

async promote_member(user_id, can_change_info=None, can_post_messages=None, can_edit_messages=None, can_delete_messages=None, can_invite_users=None, can_restrict_members=None, can_pin_messages=None, can_promote_members=None, is_anonymous=None, can_manage_chat=None, can_manage_video_chats=None, can_manage_topics=None, can_post_stories=None, can_edit_stories=None, can_delete_stories=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.promote_chat_member(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.promote_chat_member().

Added in version 13.2.

Changed in version 20.0: The argument can_manage_voice_chats was renamed to can_manage_video_chats in accordance to Bot API 6.0.

Changed in version 20.6: The arguments can_post_stories, can_edit_stories and can_delete_stories were added.

Returns:

On success, True is returned.

Return type:

bool

async reopen_forum_topic(message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.reopen_forum_topic(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.reopen_forum_topic().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async reopen_general_forum_topic(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.reopen_general_forum_topic(
   chat_id=update.effective_chat.id, *args, **kwargs
)

For the documentation of the arguments, please see telegram.Bot.reopen_general_forum_topic().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async restrict_member(user_id, permissions, until_date=None, use_independent_chat_permissions=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.restrict_chat_member(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.restrict_chat_member().

Added in version 13.2.

Added in version 20.1: Added use_independent_chat_permissions.

Returns:

On success, True is returned.

Return type:

bool

Shortcut for:

await bot.revoke_chat_invite_link(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.revoke_chat_invite_link().

Added in version 13.4.

Returns:

telegram.ChatInviteLink

async send_action(action, message_thread_id=None, business_connection_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_chat_action(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_chat_action().

Returns:

On success, True is returned.

Return type:

bool

async send_animation(animation, duration=None, width=None, height=None, caption=None, parse_mode=None, disable_notification=None, reply_markup=None, caption_entities=None, protect_content=None, message_thread_id=None, has_spoiler=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, show_caption_above_media=None, *, reply_to_message_id=None, allow_sending_without_reply=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_animation(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_animation().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_audio(audio, duration=None, performer=None, title=None, caption=None, disable_notification=None, reply_markup=None, parse_mode=None, caption_entities=None, protect_content=None, message_thread_id=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_audio(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_audio().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_chat_action(action, message_thread_id=None, business_connection_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_chat_action(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_chat_action().

Returns:

On success, True is returned.

Return type:

bool

async send_contact(phone_number=None, first_name=None, last_name=None, disable_notification=None, reply_markup=None, vcard=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, contact=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_contact(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_contact().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_copies(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]

Shortcut for:

await bot.copy_messages(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.copy_messages().

See also

copy_message(), send_copy(), copy_messages().

Added in version 20.8.

Returns:

On success, a tuple of MessageId of the sent messages is returned.

Return type:

Tuple[telegram.MessageId]

async send_copy(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, *, reply_to_message_id=None, allow_sending_without_reply=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.copy_message(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.copy_message().

See also

copy_message(), send_copies(), copy_messages().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_dice(disable_notification=None, reply_markup=None, emoji=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_dice(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_dice().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_document(document, caption=None, disable_notification=None, reply_markup=None, parse_mode=None, disable_content_type_detection=None, caption_entities=None, protect_content=None, message_thread_id=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_document(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_document().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_game(game_short_name, disable_notification=None, reply_markup=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_game(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_game().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_invoice(title, description, payload, provider_token, currency, prices, start_parameter=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, is_flexible=None, disable_notification=None, reply_markup=None, provider_data=None, send_phone_number_to_provider=None, send_email_to_provider=None, max_tip_amount=None, suggested_tip_amounts=None, protect_content=None, message_thread_id=None, reply_parameters=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_invoice(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_invoice().

Warning

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

Changed in version 13.5: As of Bot API 5.2, the parameter start_parameter is optional.

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_location(latitude=None, longitude=None, disable_notification=None, reply_markup=None, live_period=None, horizontal_accuracy=None, heading=None, proximity_alert_radius=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, location=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_location(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_location().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_media_group(media, disable_notification=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None, caption=None, parse_mode=None, caption_entities=None)[source]

Shortcut for:

await bot.send_media_group(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_media_group().

Returns:

On success, a tuple of Message instances that were sent is returned.

Return type:

Tuple[telegram.Message]

async send_message(text, parse_mode=None, disable_notification=None, reply_markup=None, entities=None, protect_content=None, message_thread_id=None, link_preview_options=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, disable_web_page_preview=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_message(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_message().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_paid_media(star_count, media, caption=None, parse_mode=None, caption_entities=None, show_caption_above_media=None, disable_notification=None, protect_content=None, reply_parameters=None, reply_markup=None, business_connection_id=None, payload=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]

Shortcut for:

await bot.send_paid_media(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_paid_media().

Added in version 21.4.

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_photo(photo, caption=None, disable_notification=None, reply_markup=None, parse_mode=None, caption_entities=None, protect_content=None, message_thread_id=None, has_spoiler=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, show_caption_above_media=None, *, reply_to_message_id=None, allow_sending_without_reply=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_photo(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_photo().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_poll(question, options, is_anonymous=None, type=None, allows_multiple_answers=None, correct_option_id=None, is_closed=None, disable_notification=None, reply_markup=None, explanation=None, explanation_parse_mode=None, open_period=None, close_date=None, explanation_entities=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, question_parse_mode=None, question_entities=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_poll(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_poll().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_sticker(sticker, disable_notification=None, reply_markup=None, protect_content=None, message_thread_id=None, emoji=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_sticker(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_sticker().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_venue(latitude=None, longitude=None, title=None, address=None, foursquare_id=None, disable_notification=None, reply_markup=None, foursquare_type=None, google_place_id=None, google_place_type=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, venue=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_venue(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_venue().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_video(video, duration=None, caption=None, disable_notification=None, reply_markup=None, width=None, height=None, parse_mode=None, supports_streaming=None, caption_entities=None, protect_content=None, message_thread_id=None, has_spoiler=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, show_caption_above_media=None, *, reply_to_message_id=None, allow_sending_without_reply=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_video(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_video().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_video_note(video_note, duration=None, length=None, disable_notification=None, reply_markup=None, protect_content=None, message_thread_id=None, thumbnail=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_video_note(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_video_note().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async send_voice(voice, duration=None, caption=None, disable_notification=None, reply_markup=None, parse_mode=None, caption_entities=None, protect_content=None, message_thread_id=None, reply_parameters=None, business_connection_id=None, message_effect_id=None, *, reply_to_message_id=None, allow_sending_without_reply=None, filename=None, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.send_voice(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.send_voice().

Returns:

On success, instance representing the message posted.

Return type:

telegram.Message

async set_administrator_custom_title(user_id, custom_title, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.set_chat_administrator_custom_title(
    update.effective_chat.id, *args, **kwargs
)

For the documentation of the arguments, please see telegram.Bot.set_chat_administrator_custom_title().

Returns:

On success, True is returned.

Return type:

bool

async set_description(description=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.set_chat_description(
    chat_id=update.effective_chat.id, *args, **kwargs
)

For the documentation of the arguments, please see telegram.Bot.set_chat_description().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async set_menu_button(menu_button=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.set_chat_menu_button(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.set_chat_menu_button().

Caution

Can only work, if the chat is a private chat.

See also

get_menu_button()

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async set_message_reaction(message_id, reaction=None, is_big=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.set_message_reaction(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.set_message_reaction().

Added in version 20.8.

Returns:

bool On success, True is returned.

async set_permissions(permissions, use_independent_chat_permissions=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.set_chat_permissions(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.set_chat_permissions().

Added in version 20.1: Added use_independent_chat_permissions.

Returns:

On success, True is returned.

Return type:

bool

async set_photo(photo, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.set_chat_photo(
    chat_id=update.effective_chat.id, *args, **kwargs
)

For the documentation of the arguments, please see telegram.Bot.set_chat_photo().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async set_title(title, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.set_chat_title(
    chat_id=update.effective_chat.id, *args, **kwargs
)

For the documentation of the arguments, please see telegram.Bot.set_chat_title().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async unban_chat(chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.unban_chat_sender_chat(
    sender_chat_id=update.effective_chat.id, *args, **kwargs
)

For the documentation of the arguments, please see telegram.Bot.unban_chat_sender_chat().

Added in version 13.9.

Returns:

On success, True is returned.

Return type:

bool

async unban_member(user_id, only_if_banned=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.unban_chat_member(update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.unban_chat_member().

Returns:

On success, True is returned.

Return type:

bool

async unban_sender_chat(sender_chat_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.unban_chat_sender_chat(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.unban_chat_sender_chat().

Added in version 13.9.

Returns:

On success, True is returned.

Return type:

bool

async unhide_general_forum_topic(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.unhide_general_forum_topic (
   chat_id=update.effective_chat.id, *args, **kwargs
)

For the documentation of the arguments, please see telegram.Bot.unhide_general_forum_topic().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async unpin_all_forum_topic_messages(message_thread_id, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.unpin_all_forum_topic_messages(chat_id=update.effective_chat.id,
   *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.unpin_all_forum_topic_messages().

Added in version 20.0.

Returns:

On success, True is returned.

Return type:

bool

async unpin_all_general_forum_topic_messages(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.unpin_all_general_forum_topic_messages(chat_id=update.effective_chat.id,
   *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.unpin_all_general_forum_topic_messages().

Added in version 20.5.

Returns:

On success, True is returned.

Return type:

bool

async unpin_all_messages(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.unpin_all_chat_messages(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.unpin_all_chat_messages().

Returns:

On success, True is returned.

Return type:

bool

async unpin_message(message_id=None, business_connection_id=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Shortcut for:

await bot.unpin_chat_message(chat_id=update.effective_chat.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.unpin_chat_message().

Returns:

On success, True is returned.

Return type:

bool