Interface IUpdate

This object represents an incoming update.At most one of the optional parameters can be present in any given update.

Hierarchy

  • IUpdate

Properties

callback_query?: ICallbackQuery

Optional. New incoming callback query

channel_post?: IMessage

Optional. New incoming channel post of any kind - text, photo, sticker, etc.

chat_join_request?: IChatJoinRequest

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

chat_member?: IChatMemberUpdated

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 allowed_updates to receive these updates.

chosen_inline_result?: IChosenInlineResult

Optional. The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.

edited_channel_post?: IMessage

Optional. New version of a channel post that is known to the bot and was edited

edited_message?: IMessage

Optional. New version of a message that is known to the bot and was edited

inline_query?: IInlineQuery

Optional. New incoming inline query

message?: IMessage

Optional. New incoming message of any kind - text, photo, sticker, etc.

my_chat_member?: IChatMemberUpdated

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.

poll?: IPoll

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

poll_answer?: IPollAnswer

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.

pre_checkout_query?: IPreCheckoutQuery

Optional. New incoming pre-checkout query. Contains full information about checkout

shipping_query?: IShippingQuery

Optional. New incoming shipping query. Only for invoices with flexible price

update_id: number

The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.

Generated using TypeDoc