Built and signed on GitHub ActionsBuilt and signed on GitHub Actions
Contexts for GramIO framework
This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
Helper for construct mixins
Union type of attachments type
This object represents an audio file to be treated as music by the Telegram clients.
The background is a freeform gradient that rotates after every message in the chat.
This object describes the way a background is filled based on the selected colors. Currently, it can be one of
The background is automatically filled based on the selected colors.
This object describes the type of a background. Currently, it can be one of
The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.
The background is a wallpaper in the JPEG format.
This object represents a service message about a forum topic closed in the chat. Currently holds no information.
Describes the connection of the bot with a business account.
This object Describes the connection of the bot with a business account.
Contains information about the start page settings of a Telegram Business account.
Contains information about the location of a Telegram Business account.
Describes the connection of the bot with a business account.
Describes an interval of time during which a business is open.
A placeholder, currently holds no information.
This object represents an incoming callback query from a callback button in
an inline keyboard. If the button that originated the query was attached to
a message sent by the bot, the field message will be present.
If the button was attached to a message sent via the bot (in inline mode),
the field inline_message_id will be present.
Exactly one of the fields data
or game_short_name
will be present.
Represents the rights of an administrator in a chat.
This object represents a service message about chat background set.
The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.
The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.
This object contains full information about a chat.
- accentColorId
- activeUsernames
- availableReactions
- backgroundCustomEmojiId
- bio
- birthdate
- businessIntro
- businessLocation
- businessOpeningHours
- canSendPaidMedia
- canSetStickerSet
- customEmojiStickerSetName
- description
- emojiStatusCustomEmojiId
- emojiStatusExpirationDate
- firstName
- hasAggressiveAntiSpamEnabled
- hasHiddenMembers
- hasPrivateForwards
- hasProtectedContent
- hasRestrictedVoiceAndVideoMessages
- hasVisibleHistory
- id
- inviteLink
- isForum
- joinByRequest
- joinToSendMessages
- lastName
- linkedChatId
- location
- maxReactionCount
- messageAutoDeleteTime
- permissions
- personalChat
- photo
- pinnedMessage
- profileAccentColorId
- profileBackgroundCustomEmojiId
- slowModeDelay
- stickerSetName
- title
- type
- unrestrictBoostCount
- username
Represents an invite link for a chat.
This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:
- canAddWebPagePreviews
- canBeEdited
- canChangeInfo
- canDeleteMessages
- canDeleteStories
- canEditMessages
- canEditStories
- canInviteUsers
- canManageChat
- canManageTopics
- canManageVideoChats
- canPinMessages
- canPostMessages
- canPostStories
- canPromoteMembers
- canRestrictMembers
- canSendAudios
- canSendDocuments
- canSendMessages
- canSendOtherMessages
- canSendPhotos
- canSendPolls
- canSendVideoNotes
- canSendVideos
- canSendVoiceNotes
- customTitle
- isAnonymous
- isMember
- status
- untilDate
- user
This object represents changes in the status of a chat member.
This object represents changes in the status of a chat member.
Describes actions that a non-administrator user is allowed to take in a chat.
Enum of ChatType property
Represents a result of an inline query that was chosen by the user and sent to their chat partner.
The result of an inline query that was chosen by a user and sent to their chat partner
Type helper constructor
Mapping events to their contexts
- boost_added
- business_connection
- business_message
- callback_query
- channel_post
- chat_background_set
- chat_boost
- chat_join_request
- chat_member
- chat_shared
- chosen_inline_result
- delete_chat_photo
- deleted_business_messages
- edited_business_message
- edited_channel_post
- edited_message
- forum_topic_closed
- forum_topic_created
- forum_topic_edited
- forum_topic_reopened
- general_forum_topic_hidden
- general_forum_topic_unhidden
- giveaway_completed
- giveaway_created
- giveaway_winners
- group_chat_created
- inline_query
- invoice
- left_chat_member
- location
- message
- message_auto_delete_timer_changed
- message_reaction
- message_reaction_count
- migrate_from_chat_id
- migrate_to_chat_id
- my_chat_member
- new_chat_members
- new_chat_photo
- new_chat_title
- passport_data
- pinned_message
- poll
- poll_answer
- pre_checkout_query
- proximity_alert_triggered
- purchased_paid_media
- refunded_payment
- removed_chat_boost
- service_message
- shipping_query
- successful_payment
- users_shared
- video_chat_ended
- video_chat_participants_invited
- video_chat_scheduled
- video_chat_started
- web_app_data
- write_access_allowed
Mapping UpdateNames to their contexts
- boost_added
- business_connection
- business_message
- callback_query
- channel_post
- chat_background_set
- chat_boost
- chat_join_request
- chat_member
- chat_shared
- chosen_inline_result
- delete_chat_photo
- deleted_business_messages
- edited_business_message
- edited_channel_post
- edited_message
- forum_topic_closed
- forum_topic_created
- forum_topic_edited
- forum_topic_reopened
- general_forum_topic_hidden
- general_forum_topic_unhidden
- giveaway_completed
- giveaway_created
- giveaway_winners
- group_chat_created
- inline_query
- invoice
- left_chat_member
- location
- message
- message_auto_delete_timer_changed
- message_reaction
- message_reaction_count
- migrate_from_chat_id
- migrate_to_chat_id
- my_chat_member
- new_chat_members
- new_chat_photo
- new_chat_title
- passport_data
- pinned_message
- poll
- poll_answer
- pre_checkout_query
- proximity_alert_triggered
- purchased_paid_media
- refunded_payment
- removed_chat_boost
- service_message
- shipping_query
- successful_payment
- users_shared
- video_chat_ended
- video_chat_participants_invited
- video_chat_scheduled
- video_chat_started
- web_app_data
- write_access_allowed
Type util to get type of Context
Custom Event Name
This object represents a general file (as opposed to photos, voice messages and audio files).
Contains data required for decrypting and authenticatin
EncryptedPassportElement
. See the Telegram Passport Documentation for a
complete description of the data decryption and authentication processes.
Contains information about documents or other Telegram Passport elements shared with the bot by the user.
Enum of EntityType property
Array of EVENTS
This object contains information about a message that is being replied to, which may come from another chat or forum topic.
This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>
. 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 getFile
.
Attachment with fileId
and fileUniqueId
properties
Helper for filter objects
This object represents a service message about a forum topic closed in the chat. Currently holds no information.
This object represents a service message about a forum topic closed in the chat. Currently holds no information.
This object represents a service message about a new forum topic created in the chat.
This object represents a service message about a new forum topic created in the chat.
This object represents a service message about an edited forum topic.
This object represents a service message about an edited forum topic.
This object represents a service message about an edited forum topic.
This object represents a service message about a forum topic reopened in the chat. Currently holds no information.
This object represents a message about a scheduled giveaway.
This object represents a service message about the completion of a giveaway without public winners.
This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.
This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.
This object represents a service message about the creation of a scheduled giveaway.
This object represents a message about the completion of a giveaway with public winners.
This object represents a message about the completion of a giveaway with public winners.
This object describes a message that was deleted or is otherwise inaccessible to the bot.
This object represents an inline keyboard that appears right next to the message it belongs to.
This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.
Represents the content of a location message to be sent as the result of an inline query.
This object contains information about one answer option in a poll to send.
This object contains basic information about an invoice.
Message is an invoice for a payment, information about the invoice. More about payments »
Guard to check is string can be parsed via JSON.parse
Guard to check is it play object
Type helper to join union type
A member was removed from the group, information about them (this member may be the bot itself)
Describes the options used for link preview generation.
This object represents a point on the map.
This object represents a parameter of the inline keyboard button used to automatically authorize a user.
This object describes the position on faces where a mask should be placed by default.
Type helper to add array and non-array type
Helper for getters memoization
This object represents a message.
- animation
- audio
- authorSignature
- businessConnectionId
- caption
- captionEntities
- channelChatCreated
- chat
- chatBackgroundSet
- chatBoostAdded
- chatShared
- connectedWebsite
- contact
- createdAt
- deleteChatPhoto
- dice
- document
- effectId
- entities
- externalReply
- forumTopicClosed
- forumTopicCreated
- forumTopicEdited
- forumTopicReopened
- forwardOrigin
- from
- game
- generalForumTopicHidden
- generalForumTopicUnhidden
- giveaway
- giveawayCompleted
- giveawayCreated
- giveawayWinners
- groupChatCreated
- hasMediaSpoiler
- hasProtectedContent
- id
- invoice
- isAutomaticForward
- isFromOffline
- isShowCaptionAboveMedia
- isTopicMessage
- leftChatMember
- linkPreviewOptions
- location
- mediaGroupId
- messageAutoDeleteTimerChanged
- migrateFromChatId
- migrateToChatId
- newChatMembers
- newChatPhoto
- newChatTitle
- passportData
- photo
- pinnedMessage
- poll
- proximityAlertTriggered
- quote
- replyMarkup
- replyMessage
- replyStory
- senderBoostCount
- senderBusinessBot
- senderChat
- sticker
- story
- successfulPayment
- supergroupChatCreated
- text
- threadId
- updatedAt
- usersShared
- venue
- viaBot
- video
- videoChatEnded
- videoChatParticipantsInvited
- videoChatScheduled
- videoChatStarted
- videoNote
- voice
- webAppData
- writeAccessAllowed
This object represents a service message about a change in auto-delete timer settings
This object represents a service message about a change in auto-delete timer settings.
Called when message
event occurs
- attachment
- caption
- eventType
- hasAttachment
- hasAttachmentType
- hasAttachments
- hasAuthorSignature
- hasCaption
- hasCaptionEntities
- hasDice
- hasEntities
- hasForwardOrigin
- hasLinkPreviewOptions
- hasQuote
- hasReplyInfo
- hasReplyMessage
- hasStartPayload
- hasText
- hasViaBot
- isEvent
- isGiveaway
- isServiceMessage
- isTopicMessage
- paidMedia
- payload
- rawStartPayload
- startPayload
- text
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
Union type of MessageEvent names
The message was originally sent to a channel chat.
The message was originally sent on behalf of a chat to a group chat.
This object represents a change of a reaction on a message performed by a user.
This object represents reaction changes on a message with anonymous reactions.
This object represents reaction changes on a message with anonymous reactions.
This object represents a change of a reaction on a message performed by a user.
The group has been migrated to a supergroup with the specified identifier. 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 signed 64-bit integer or double-precision float type are safe for storing this identifier.
The group has been migrated to a supergroup with the specified identifier. 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 signed 64-bit integer or double-precision float type are safe for storing this identifier.
New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)
Make some keys optional
This object contains information about a paid media purchase.
Contains information about Telegram Passport data shared with the bot by the user.
Describes Telegram Passport data shared with the bot by the user.
This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.
This object represents a photo file with it's sizes
Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
This object contains information about a poll.
This object represents an answer of a user in a non-anonymous poll.
This object contains information about a poll.
This object contains information about one answer option in a poll.
Enum of PollType property
This object contains information about an incoming pre-checkout query.
This object contains information about an incoming pre-checkout query.
This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.
This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.
Represents a reaction added to a message along with the number of times it was added.
This object contains basic information about a successful payment.
Like Required<T>
but for specified keys of T
Like Require<O, K>
but it sets V
as the value for K
values
Contains information about an inline message sent by a Web App on behalf of a user.
Array of SERVICE_MESSAGE_EVENTS
This object represents a shipping address.
This object contains information about an incoming shipping query.
This object contains information about an incoming shipping query.
Permits string
but gives hints
This object contains basic information about a successful payment.
This object contains basic information about a successful payment.
This type represent SendAnimationParams and used by Contexts.MessageContext.sendMedia
This type represent SendAudioParams and used by Contexts.MessageContext.sendMedia
This type represent SendDocumentParams and used by Contexts.MessageContext.sendMedia
This Union type represent a media that can be sended and used by Contexts.MessageContext.sendMedia
This type represent SendPhotoParams and used by Contexts.MessageContext.sendMedia
This type represent SendStickerParams and used by Contexts.MessageContext.sendMedia
This type represent SendVideoParams and used by Contexts.MessageContext.sendMedia
This type represent SendVideoNoteParams and used by Contexts.MessageContext.sendMedia
This type represent SendVoiceParams and used by Contexts.MessageContext.sendMedia
Union type of Update names
This object represents a Telegram user or bot.
This object represents a venue.
This object represents a video file.
This object represents a service message about a video chat ended in the chat.
This object represents a service message about a video chat ended in the chat.
This object represents a service message about new members invited to a video chat.
This object represents a service message about new members invited to a video chat.
This object represents a service message about a video chat scheduled in the chat
This object represents a service message about a video chat scheduled in the chat.
This object represents a service message about a video chat started in the chat. Currently holds no information.
This object represents a service message about a video chat started in the chat.
This object represents a video message.
This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information.
This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess.