ChatJoinRequest¶
- class telegram.ChatJoinRequest(chat, from_user, date, user_chat_id, bio=None, invite_link=None, *, api_kwargs=None)[source]¶
Bases:
telegram.TelegramObject
This object represents a join request sent to a chat.
Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their
chat
,from_user
anddate
are equal.Note
Since Bot API 5.5, bots are allowed to contact users who sent a join request to a chat where the bot is an administrator with the
can_invite_users
administrator right – even if the user never interacted with the bot before.Telegram does not guarantee that
from_user.id
coincides with thechat_id
of the user. Please useuser_chat_id
to contact the user in response to their join request.
Available In
New in version 13.8.
Changed in version 20.1: In Bot API 6.5 the argument
user_chat_id
was added, which changes the position of the optional argumentsbio
andinvite_link
.- Parameters:
chat (
telegram.Chat
) – Chat to which the request was sent.from_user (
telegram.User
) – User that sent the join request.date (
datetime.datetime
) – Date the request was sent.user_chat_id (
int
) –Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.
New in version 20.1.
invite_link (
telegram.ChatInviteLink
, optional) – Chat invite link that was used by the user to send the join request.
- user_chat_id[source]¶
Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.
New in version 20.1.
- Type:
- invite_link[source]¶
Optional. Chat invite link that was used by the user to send the join request.
- Type:
- async approve(*, 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, user_id=update.effective_user.id, *args, **kwargs )
For the documentation of the arguments, please see
telegram.Bot.approve_chat_join_request()
.
- async decline(*, 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, user_id=update.effective_user.id, *args, **kwargs )
For the documentation of the arguments, please see
telegram.Bot.decline_chat_join_request()
.