telegram.Update

class telegram.Update(*args, **kwargs)[source]

Bases: telegram.TelegramObject

This object represents an incoming update.

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

Note

At most one of the optional parameters can be present in any given update.

Parameters
update_id[source]

The update’s unique identifier.

Type

int

message[source]

Optional. New incoming message.

Type

telegram.Message

edited_message[source]

Optional. New version of a message.

Type

telegram.Message

channel_post[source]

Optional. New incoming channel post.

Type

telegram.Message

edited_channel_post[source]

Optional. New version of a channel post.

Type

telegram.Message

inline_query[source]

Optional. New incoming inline query.

Type

telegram.InlineQuery

chosen_inline_result[source]

Optional. The result of an inline query that was chosen by a user.

Type

telegram.ChosenInlineResult

callback_query[source]

Optional. New incoming callback query.

Type

telegram.CallbackQuery

shipping_query[source]

Optional. New incoming shipping query.

Type

telegram.ShippingQuery

pre_checkout_query[source]

Optional. New incoming pre-checkout query.

Type

telegram.PreCheckoutQuery

poll[source]

Optional. New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot.

Type

telegram.Poll

poll_answer[source]

Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.

Type

telegram.PollAnswer

my_chat_member[source]

Optional. The bot’s chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.

New in version 13.4.

Type

telegram.ChatMemberUpdated

chat_member[source]

Optional. A chat member’s status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify CHAT_MEMBER in the list of telegram.ext.Application.run_polling.allowed_updates to receive these updates (see telegram.Bot.get_updates(), telegram.Bot.set_webhook(), telegram.ext.Application.run_polling() and telegram.ext.Application.run_webhook()).

New in version 13.4.

Type

telegram.ChatMemberUpdated

chat_join_request[source]

Optional. A request to join the chat has been sent. The bot must have the telegram.ChatPermissions.can_invite_users administrator right in the chat to receive these updates.

New in version 13.8.

Type

telegram.ChatJoinRequest

ALL_TYPES = [<UpdateType.MESSAGE>, <UpdateType.EDITED_MESSAGE>, <UpdateType.CHANNEL_POST>, <UpdateType.EDITED_CHANNEL_POST>, <UpdateType.INLINE_QUERY>, <UpdateType.CHOSEN_INLINE_RESULT>, <UpdateType.CALLBACK_QUERY>, <UpdateType.SHIPPING_QUERY>, <UpdateType.PRE_CHECKOUT_QUERY>, <UpdateType.POLL>, <UpdateType.POLL_ANSWER>, <UpdateType.MY_CHAT_MEMBER>, <UpdateType.CHAT_MEMBER>, <UpdateType.CHAT_JOIN_REQUEST>][source]

A list of all available update types.

New in version 13.5.

Type

List[str]

CALLBACK_QUERY = 'callback_query'[source]

telegram.constants.UpdateType.CALLBACK_QUERY

New in version 13.5.

CHANNEL_POST = 'channel_post'[source]

telegram.constants.UpdateType.CHANNEL_POST

New in version 13.5.

CHAT_JOIN_REQUEST = 'chat_join_request'[source]

telegram.constants.UpdateType.CHAT_JOIN_REQUEST

New in version 13.8.

CHAT_MEMBER = 'chat_member'[source]

telegram.constants.UpdateType.CHAT_MEMBER

New in version 13.5.

CHOSEN_INLINE_RESULT = 'chosen_inline_result'[source]

telegram.constants.UpdateType.CHOSEN_INLINE_RESULT

New in version 13.5.

EDITED_CHANNEL_POST = 'edited_channel_post'[source]

telegram.constants.UpdateType.EDITED_CHANNEL_POST

New in version 13.5.

EDITED_MESSAGE = 'edited_message'[source]

telegram.constants.UpdateType.EDITED_MESSAGE

New in version 13.5.

INLINE_QUERY = 'inline_query'[source]

telegram.constants.UpdateType.INLINE_QUERY

New in version 13.5.

MESSAGE = 'message'[source]

telegram.constants.UpdateType.MESSAGE

New in version 13.5.

MY_CHAT_MEMBER = 'my_chat_member'[source]

telegram.constants.UpdateType.MY_CHAT_MEMBER

New in version 13.5.

POLL = 'poll'[source]

telegram.constants.UpdateType.POLL

New in version 13.5.

POLL_ANSWER = 'poll_answer'[source]

telegram.constants.UpdateType.POLL_ANSWER

New in version 13.5.

PRE_CHECKOUT_QUERY = 'pre_checkout_query'[source]

telegram.constants.UpdateType.PRE_CHECKOUT_QUERY

New in version 13.5.

SHIPPING_QUERY = 'shipping_query'[source]

telegram.constants.UpdateType.SHIPPING_QUERY

New in version 13.5.

classmethod de_json(data, bot)[source]

See telegram.TelegramObject.de_json().

property effective_chat[source]

The chat that this update was sent in, no matter what kind of update this is. If no chat is associated with this update, this gives None. This is the case, if inline_query, chosen_inline_result, callback_query from inline messages, shipping_query, pre_checkout_query, poll or poll_answer is present.

Example

If message is present, this will give telegram.Message.chat.

Type

telegram.Chat

property effective_message[source]

The message included in this update, no matter what kind of update this is. More precisely, this will be the message contained in message, edited_message, channel_post, edited_channel_post or callback_query (i.e. telegram.CallbackQuery.message) or None, if none of those are present.

Type

telegram.Message

property effective_user[source]

The user that sent this update, no matter what kind of update this is. If no user is associated with this update, this gives None. This is the case if channel_post, edited_channel_post or poll is present.

Example

Type

telegram.User