Built and signed on GitHub ActionsBuilt and signed on GitHub Actions
Code-generated and Auto-published Telegram Bot API types
Params object for answerCallbackQuery method
Params object for answerInlineQuery method
Params object for answerPreCheckoutQuery method
Params object for answerShippingQuery method
This object is a map of API methods types (functions map with input/output)
- addStickerToSet
- answerCallbackQuery
- answerInlineQuery
- answerPreCheckoutQuery
- answerShippingQuery
- answerWebAppQuery
- approveChatJoinRequest
- banChatMember
- banChatSenderChat
- close
- closeForumTopic
- closeGeneralForumTopic
- copyMessage
- copyMessages
- createChatInviteLink
- createChatSubscriptionInviteLink
- createForumTopic
- createInvoiceLink
- createNewStickerSet
- declineChatJoinRequest
- deleteChatPhoto
- deleteChatStickerSet
- deleteForumTopic
- deleteMessage
- deleteMessages
- deleteMyCommands
- deleteStickerFromSet
- deleteStickerSet
- deleteWebhook
- editChatInviteLink
- editChatSubscriptionInviteLink
- editForumTopic
- editGeneralForumTopic
- editMessageCaption
- editMessageLiveLocation
- editMessageMedia
- editMessageReplyMarkup
- editMessageText
- editUserStarSubscription
- exportChatInviteLink
- forwardMessage
- forwardMessages
- getAvailableGifts
- getBusinessConnection
- getChat
- getChatAdministrators
- getChatMember
- getChatMemberCount
- getChatMenuButton
- getCustomEmojiStickers
- getFile
- getForumTopicIconStickers
- getGameHighScores
- getMe
- getMyCommands
- getMyDefaultAdministratorRights
- getMyDescription
- getMyName
- getMyShortDescription
- getStarTransactions
- getStickerSet
- getUpdates
- getUserChatBoosts
- getUserProfilePhotos
- getWebhookInfo
- hideGeneralForumTopic
- leaveChat
- logOut
- pinChatMessage
- promoteChatMember
- refundStarPayment
- removeChatVerification
- removeUserVerification
- reopenForumTopic
- reopenGeneralForumTopic
- replaceStickerInSet
- restrictChatMember
- revokeChatInviteLink
- savePreparedInlineMessage
- sendAnimation
- sendAudio
- sendChatAction
- sendContact
- sendDice
- sendDocument
- sendGame
- sendGift
- sendInvoice
- sendLocation
- sendMediaGroup
- sendMessage
- sendPaidMedia
- sendPhoto
- sendPoll
- sendSticker
- sendVenue
- sendVideo
- sendVideoNote
- sendVoice
- setChatAdministratorCustomTitle
- setChatDescription
- setChatMenuButton
- setChatPermissions
- setChatPhoto
- setChatStickerSet
- setChatTitle
- setCustomEmojiStickerSetThumbnail
- setGameScore
- setMessageReaction
- setMyCommands
- setMyDefaultAdministratorRights
- setMyDescription
- setMyName
- setMyShortDescription
- setPassportDataErrors
- setStickerEmojiList
- setStickerKeywords
- setStickerMaskPosition
- setStickerPositionInSet
- setStickerSetThumbnail
- setStickerSetTitle
- setUserEmojiStatus
- setWebhook
- stopMessageLiveLocation
- stopPoll
- unbanChatMember
- unbanChatSenderChat
- unhideGeneralForumTopic
- unpinAllChatMessages
- unpinAllForumTopicMessages
- unpinAllGeneralForumTopicMessages
- unpinChatMessage
- uploadStickerFile
- verifyChat
- verifyUser
Params object for copyMessages method
Params object for createChatInviteLink method
Params object for createChatSubscriptionInviteLink method
Params object for createForumTopic method
Params object for createInvoiceLink method
- business_connection_id
- currency
- description
- is_flexible
- max_tip_amount
- need_email
- need_name
- need_phone_number
- need_shipping_address
- payload
- photo_height
- photo_size
- photo_url
- photo_width
- prices
- provider_data
- provider_token
- send_email_to_provider
- send_phone_number_to_provider
- subscription_period
- suggested_tip_amounts
- title
Params object for createNewStickerSet method
Params object for editChatInviteLink method
Params object for editChatSubscriptionInviteLink method
Params object for editForumTopic method
Params object for editMessageCaption method
Params object for editMessageLiveLocation method
Params object for editMessageMedia method
Params object for editMessageReplyMarkup method
Params object for editMessageText method
Params object for editUserStarSubscription method
Params object for forwardMessage method
Params object for forwardMessages method
Params object for getGameHighScores method
Params object for getMyDefaultAdministratorRights method
Params object for pinChatMessage method
Params object for promoteChatMember method
Params object for refundStarPayment method
Params object for replaceStickerInSet method
Params object for restrictChatMember method
Params object for savePreparedInlineMessage method
Params object for sendAnimation method
Params object for sendChatAction method
Params object for sendGift method
Params object for sendInvoice method
- allow_paid_broadcast
- chat_id
- currency
- description
- disable_notification
- is_flexible
- max_tip_amount
- message_effect_id
- message_thread_id
- need_email
- need_name
- need_phone_number
- need_shipping_address
- payload
- photo_height
- photo_size
- photo_url
- photo_width
- prices
- protect_content
- provider_data
- provider_token
- reply_markup
- reply_parameters
- send_email_to_provider
- send_phone_number_to_provider
- start_parameter
- suggested_tip_amounts
- title
Params object for sendMediaGroup method
Params object for sendPoll method
- allow_paid_broadcast
- allows_multiple_answers
- business_connection_id
- chat_id
- close_date
- correct_option_id
- disable_notification
- explanation
- explanation_entities
- explanation_parse_mode
- is_anonymous
- is_closed
- message_effect_id
- message_thread_id
- open_period
- options
- protect_content
- question
- question_entities
- question_parse_mode
- reply_markup
- reply_parameters
- type
Params object for sendVideo method
Params object for setChatAdministratorCustomTitle method
Params object for setChatPermissions method
Params object for setCustomEmojiStickerSetThumbnail method
Params object for setGameScore method
Params object for setMessageReaction method
Params object for setMyDefaultAdministratorRights method
Params object for setMyShortDescription method
Params object for setStickerSetThumbnail method
Params object for setUserEmojiStatus method
Params object for setWebhook method
Params object for stopMessageLiveLocation method
Params object for stopPoll method
Contains information about the affiliate that received a commission via this transaction.
This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
Union type of Response
In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'. An Integer 'error_code' field is also returned, but its contents are subject to change in the future. Some errors may also have an optional field 'parameters' of the type ResponseParameters, which can help to automatically handle the error.
If 'ok' equals True, the request was successful and the result of the query can be found in the 'result' field.
This object represents an audio file to be treated as music by the Telegram clients.
This object describes the way a background is filled based on the selected colors. Currently, it can be one of
The background is a freeform gradient that rotates after every message in the chat.
The background is a gradient fill.
This object describes the type of a background. Currently, it can be one of
The background is taken directly from a built-in chat theme.
The background is automatically filled based on the selected colors.
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 the scope to which bot commands are applied. Currently, the following 7 scopes are supported:
Represents the scope of bot commands, covering all group and supergroup chat administrators.
Represents the scope of bot commands, covering all group and supergroup chats.
Represents the scope of bot commands, covering all private chats.
Represents the scope of bot commands, covering a specific chat.
Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.
Represents the scope of bot commands, covering a specific member of a group or supergroup chat.
Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.
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.
This object is received when messages are deleted from a connected business account.
Describes an interval of time during which a business is open.
A placeholder, currently holds no information. Use BotFather to set up your game.
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 contains information about a chat boost.
This object represents a service message about a user boosting a chat.
This object represents a boost removed from a chat.
This object describes the source of a chat boost. It can be one of
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 or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.
This object contains full information about a chat.
- accent_color_id
- active_usernames
- available_reactions
- background_custom_emoji_id
- bio
- birthdate
- business_intro
- business_location
- business_opening_hours
- can_send_paid_media
- can_set_sticker_set
- custom_emoji_sticker_set_name
- description
- emoji_status_custom_emoji_id
- emoji_status_expiration_date
- first_name
- has_aggressive_anti_spam_enabled
- has_hidden_members
- has_private_forwards
- has_protected_content
- has_restricted_voice_and_video_messages
- has_visible_history
- id
- invite_link
- is_forum
- join_by_request
- join_to_send_messages
- last_name
- linked_chat_id
- location
- max_reaction_count
- message_auto_delete_time
- permissions
- personal_chat
- photo
- pinned_message
- profile_accent_color_id
- profile_background_custom_emoji_id
- slow_mode_delay
- sticker_set_name
- title
- type
- unrestrict_boost_count
- username
Represents a join request sent to a chat.
This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:
Represents a chat member that has some additional privileges.
Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.
Represents a chat member that isn't currently a member of the chat, but may join it themselves.
Represents a chat member that has no additional privileges or restrictions.
Represents a chat member that owns the chat and has all administrator privileges.
Represents a chat member that is under certain restrictions in the chat. Supergroups only.
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.
This object represents a chat photo.
Represents a result of an inline query that was chosen by the user and sent to their chat partner.
Telegram payments currently support the currencies listed below.
This object represents a general file (as opposed to photos, voice messages and audio files).
Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.
Describes documents or other Telegram Passport elements shared with the bot by the user.
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.
Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account.
This object represents a forum topic.
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 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 game. Use BotFather to create and edit games, their short names will act as unique identifiers.
This object represents one row of the high scores table for a game.
This object represents a gift that can be sent by the bot.
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.
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 one result of an inline query. Telegram clients currently support results of the following 20 types:
Represents a link to an article or web page.
Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.
Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.
Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.
Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.
Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.
Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
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 a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.
Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.
Represents the content of a contact message to be sent as the result of an inline query.
This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.
Represents the content of an invoice message to be sent as the result of an inline query.
Represents the content of a location message to be sent as the result of an inline query.
This object represents the content of a media message to be sent. It should be one of
Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
Represents an audio file to be treated as music to be sent.
Represents a general file to be sent.
Represents a photo to be sent.
This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types:
This object describes the paid media to be sent. Currently, it can be one of
The paid media to send is a video.
This object contains information about one answer option in a poll to be sent.
This object describes a sticker to be added to a sticker set.
Represents the content of a text message to be sent as the result of an inline query.
Represents the content of a venue message to be sent as the result of an inline query.
This object contains basic information about an invoice.
This object represents a portion of the price for goods or services.
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. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:
This object describes the position on faces where a mask should be placed by default.
This object describes a message that can be inaccessible to the bot. It can be one of
This object represents a message.
- animation
- audio
- author_signature
- boost_added
- business_connection_id
- caption
- caption_entities
- channel_chat_created
- chat
- chat_background_set
- chat_shared
- connected_website
- contact
- date
- delete_chat_photo
- dice
- document
- edit_date
- effect_id
- entities
- external_reply
- forum_topic_closed
- forum_topic_created
- forum_topic_edited
- forum_topic_reopened
- forward_origin
- from
- game
- general_forum_topic_hidden
- general_forum_topic_unhidden
- giveaway
- giveaway_completed
- giveaway_created
- giveaway_winners
- group_chat_created
- has_media_spoiler
- has_protected_content
- invoice
- is_automatic_forward
- is_from_offline
- is_topic_message
- left_chat_member
- link_preview_options
- location
- media_group_id
- message_auto_delete_timer_changed
- message_id
- message_thread_id
- migrate_from_chat_id
- migrate_to_chat_id
- new_chat_members
- new_chat_photo
- new_chat_title
- paid_media
- passport_data
- photo
- pinned_message
- poll
- proximity_alert_triggered
- quote
- refunded_payment
- reply_markup
- reply_to_message
- reply_to_story
- sender_boost_count
- sender_business_bot
- sender_chat
- show_caption_above_media
- sticker
- story
- successful_payment
- supergroup_chat_created
- text
- users_shared
- venue
- via_bot
- video
- video_chat_ended
- video_chat_participants_invited
- video_chat_scheduled
- video_chat_started
- video_note
- voice
- web_app_data
- write_access_allowed
This object represents a service message about a change in auto-delete timer settings.
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
This object describes the origin of a message. It can be one of
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 reaction changes on a message with anonymous reactions.
This object represents a change of a reaction on a message performed by a user.
Contains information about the affiliate that received a commission via this transaction.
This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
Union type of Response
In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'. An Integer 'error_code' field is also returned, but its contents are subject to change in the future. Some errors may also have an optional field 'parameters' of the type ResponseParameters, which can help to automatically handle the error.
If 'ok' equals True, the request was successful and the result of the query can be found in the 'result' field.
This object represents an audio file to be treated as music by the Telegram clients.
This object describes the way a background is filled based on the selected colors. Currently, it can be one of
The background is a freeform gradient that rotates after every message in the chat.
The background is a gradient fill.
The background is filled using the selected color.
This object describes the type of a background. Currently, it can be one of
The background is taken directly from a built-in chat theme.
The background is automatically filled based on the selected colors.
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 the scope to which bot commands are applied. Currently, the following 7 scopes are supported:
Represents the scope of bot commands, covering all group and supergroup chat administrators.
Represents the scope of bot commands, covering all group and supergroup chats.
Represents the scope of bot commands, covering all private chats.
Represents the scope of bot commands, covering a specific chat.
Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.
Represents the scope of bot commands, covering a specific member of a group or supergroup chat.
Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.
This object represents the bot's short description.
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.
This object is received when messages are deleted from a connected business account.
Describes the opening hours of a business.
Describes an interval of time during which a business is open.
A placeholder, currently holds no information. Use BotFather to set up your game.
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.
This object represents a chat.
Represents the rights of an administrator in a chat.
This object contains information about a chat boost.
This object represents a service message about a user boosting a chat.
This object represents a boost removed from a chat.
This object describes the source of a chat boost. It can be one of
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 or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.
This object represents a boost added to a chat or changed.
This object contains full information about a chat.
- accent_color_id
- active_usernames
- available_reactions
- background_custom_emoji_id
- bio
- birthdate
- business_intro
- business_location
- business_opening_hours
- can_send_paid_media
- can_set_sticker_set
- custom_emoji_sticker_set_name
- description
- emoji_status_custom_emoji_id
- emoji_status_expiration_date
- first_name
- has_aggressive_anti_spam_enabled
- has_hidden_members
- has_private_forwards
- has_protected_content
- has_restricted_voice_and_video_messages
- has_visible_history
- id
- invite_link
- is_forum
- join_by_request
- join_to_send_messages
- last_name
- linked_chat_id
- location
- max_reaction_count
- message_auto_delete_time
- permissions
- personal_chat
- photo
- pinned_message
- profile_accent_color_id
- profile_background_custom_emoji_id
- slow_mode_delay
- sticker_set_name
- title
- type
- unrestrict_boost_count
- username
Represents a join request sent to a chat.
Represents a location to which a chat is connected.
This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:
Represents a chat member that has some additional privileges.
Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.
Represents a chat member that isn't currently a member of the chat, but may join it themselves.
Represents a chat member that has no additional privileges or restrictions.
Represents a chat member that owns the chat and has all administrator privileges.
Represents a chat member that is under certain restrictions in the chat. Supergroups only.
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.
This object represents a chat photo.
Represents a result of an inline query that was chosen by the user and sent to their chat partner.
This object represents a phone contact.
Telegram payments currently support the currencies listed below.
This object represents an animated emoji that displays a random value.
This object represents a general file (as opposed to photos, voice messages and audio files).
Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.
Describes documents or other Telegram Passport elements shared with the bot by the user.
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.
Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account.
This object represents a forum topic.
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 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 game. Use BotFather to create and edit games, their short names will act as unique identifiers.
This object represents one row of the high scores table for a game.
This object represents a gift that can be sent by the bot.
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.
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 one result of an inline query. Telegram clients currently support results of the following 20 types:
Represents a link to an article or web page.
Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.
Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.
Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.
Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.
Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.
Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
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 a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.
Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.
Represents the content of a contact message to be sent as the result of an inline query.
This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.
Represents the content of an invoice message to be sent as the result of an inline query.
Represents the content of a location message to be sent as the result of an inline query.
This object represents the content of a media message to be sent. It should be one of
Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
Represents an audio file to be treated as music to be sent.
Represents a general file to be sent.
Represents a photo to be sent.
This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types:
This object describes the paid media to be sent. Currently, it can be one of
The paid media to send is a video.
This object contains information about one answer option in a poll to be sent.
This object describes a sticker to be added to a sticker set.
Represents the content of a text message to be sent as the result of an inline query.
Represents the content of a venue message to be sent as the result of an inline query.
This object contains basic information about an invoice.
This object represents a portion of the price for goods or services.
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. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:
This object describes the position on faces where a mask should be placed by default.
This object describes a message that can be inaccessible to the bot. It can be one of
This object represents a message.
- animation
- audio
- author_signature
- boost_added
- business_connection_id
- caption
- caption_entities
- channel_chat_created
- chat
- chat_background_set
- chat_shared
- connected_website
- contact
- date
- delete_chat_photo
- dice
- document
- edit_date
- effect_id
- entities
- external_reply
- forum_topic_closed
- forum_topic_created
- forum_topic_edited
- forum_topic_reopened
- forward_origin
- from
- game
- general_forum_topic_hidden
- general_forum_topic_unhidden
- giveaway
- giveaway_completed
- giveaway_created
- giveaway_winners
- group_chat_created
- has_media_spoiler
- has_protected_content
- invoice
- is_automatic_forward
- is_from_offline
- is_topic_message
- left_chat_member
- link_preview_options
- location
- media_group_id
- message_auto_delete_timer_changed
- message_id
- message_thread_id
- migrate_from_chat_id
- migrate_to_chat_id
- new_chat_members
- new_chat_photo
- new_chat_title
- paid_media
- passport_data
- photo
- pinned_message
- poll
- proximity_alert_triggered
- quote
- refunded_payment
- reply_markup
- reply_to_message
- reply_to_story
- sender_boost_count
- sender_business_bot
- sender_chat
- show_caption_above_media
- sticker
- story
- successful_payment
- supergroup_chat_created
- text
- users_shared
- venue
- via_bot
- video
- video_chat_ended
- video_chat_participants_invited
- video_chat_scheduled
- video_chat_started
- video_note
- voice
- web_app_data
- write_access_allowed
This object represents a service message about a change in auto-delete timer settings.
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
This object describes the origin of a message. It can be one of
The message was originally sent to a channel chat.
The message was originally sent on behalf of a chat to a group chat.
The message was originally sent by a known user.
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.
This object represents information about an order.
This object describes paid media. Currently, it can be one of
Describes the paid media added to a message.
The paid media isn't available before the payment.
This object contains information about a paid media purchase.
Describes Telegram Passport data shared with the bot by the user.
This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:
Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.
Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.
Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.
Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.
Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
Represents an issue in an unspecified place. The error is considered resolved when new data is added.
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 an answer of a user in a non-anonymous poll.
This object contains information about one answer option in a poll.
This object contains information about an incoming pre-checkout query.
Describes an inline message to be sent by a user of a Mini App.
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 describes the type of a reaction. Currently, it can be one of
The reaction is based on a custom emoji.
This object contains basic information about a refunded payment.
This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.
Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.
Describes reply parameters for the message that is being sent.
Describes why a request was unsuccessful.
This object describes the state of a revenue withdrawal operation. Currently, it can be one of
The withdrawal failed and the transaction was refunded.
Describes an inline message sent by a Web App on behalf of a user.
This object represents a shipping address.
This object contains information about an incoming shipping query.
Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.
Contains a list of Telegram Star transactions.
This object represents a sticker set.
This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.
This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.
This object contains information about the quoted part of a message that is replied to by the given message.
This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of
Describes the affiliate program that issued the affiliate commission received via this transaction.
Describes a withdrawal transaction with Fragment.
Describes a transaction with an unknown source or recipient.
Describes a withdrawal transaction to the Telegram Ads platform.
Describes a transaction with payment for paid broadcasting.
Describes a transaction with a user.
This object represents an incoming update. At most one of the optional parameters can be present in any given update.
- business_connection
- business_message
- callback_query
- channel_post
- chat_boost
- chat_join_request
- chat_member
- chosen_inline_result
- deleted_business_messages
- edited_business_message
- edited_channel_post
- edited_message
- inline_query
- message
- message_reaction
- message_reaction_count
- my_chat_member
- poll
- poll_answer
- pre_checkout_query
- purchased_paid_media
- removed_chat_boost
- shipping_query
- update_id
This object represents a list of boosts added to a chat by a user.
This object represent a user's profile pictures.
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 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 started in the chat. Currently holds no information.
This object represents a video message (available in Telegram apps as of v.4.0).
This object represents a voice note.
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.
This object represents information about an order.
This object describes paid media. Currently, it can be one of
This object contains information about a paid media purchase.
Params object for answerCallbackQuery method
Params object for answerInlineQuery method
Params object for answerPreCheckoutQuery method
Params object for answerShippingQuery method
Params object for answerWebAppQuery method
Params object for approveChatJoinRequest method
Params object for banChatMember method
Params object for banChatSenderChat method
Params object for closeForumTopic method
Params object for copyMessages method
Params object for createChatInviteLink method
Params object for createChatSubscriptionInviteLink method
Params object for createForumTopic method
Params object for createInvoiceLink method
- business_connection_id
- currency
- description
- is_flexible
- max_tip_amount
- need_email
- need_name
- need_phone_number
- need_shipping_address
- payload
- photo_height
- photo_size
- photo_url
- photo_width
- prices
- provider_data
- provider_token
- send_email_to_provider
- send_phone_number_to_provider
- subscription_period
- suggested_tip_amounts
- title
Params object for createNewStickerSet method
Params object for declineChatJoinRequest method
Params object for deleteForumTopic method
Params object for editChatInviteLink method
Params object for editChatSubscriptionInviteLink method
Params object for editForumTopic method
Params object for editGeneralForumTopic method
Params object for editMessageCaption method
Params object for editMessageLiveLocation method
Params object for editMessageMedia method
Params object for editMessageReplyMarkup method
Params object for editMessageText method
Params object for editUserStarSubscription method
Params object for forwardMessage method
Params object for forwardMessages method
Params object for getBusinessConnection method
Params object for getCustomEmojiStickers method
Params object for getGameHighScores method
Params object for getMyDefaultAdministratorRights method
Params object for getMyShortDescription method
Params object for getUpdates method
Params object for getUserProfilePhotos method
Params object for pinChatMessage method
Params object for promoteChatMember method
Params object for refundStarPayment method
Params object for reopenForumTopic method
Params object for reopenGeneralForumTopic method
Params object for replaceStickerInSet method
Params object for restrictChatMember method
Params object for revokeChatInviteLink method
Params object for savePreparedInlineMessage method
Params object for sendAnimation method
Params object for sendChatAction method
Params object for sendGift method
Params object for sendInvoice method
- allow_paid_broadcast
- chat_id
- currency
- description
- disable_notification
- is_flexible
- max_tip_amount
- message_effect_id
- message_thread_id
- need_email
- need_name
- need_phone_number
- need_shipping_address
- payload
- photo_height
- photo_size
- photo_url
- photo_width
- prices
- protect_content
- provider_data
- provider_token
- reply_markup
- reply_parameters
- send_email_to_provider
- send_phone_number_to_provider
- start_parameter
- suggested_tip_amounts
- title
Params object for sendPoll method
- allow_paid_broadcast
- allows_multiple_answers
- business_connection_id
- chat_id
- close_date
- correct_option_id
- disable_notification
- explanation
- explanation_entities
- explanation_parse_mode
- is_anonymous
- is_closed
- message_effect_id
- message_thread_id
- open_period
- options
- protect_content
- question
- question_entities
- question_parse_mode
- reply_markup
- reply_parameters
- type
Params object for sendVenue method
Params object for sendVideo method
Params object for setChatAdministratorCustomTitle method
Params object for setChatDescription method
Params object for setChatPermissions method
Params object for setChatStickerSet method
Params object for setCustomEmojiStickerSetThumbnail method
Params object for setGameScore method
Params object for setMessageReaction method
Params object for setMyCommands method
Params object for setMyDefaultAdministratorRights method
Params object for setMyDescription method
Params object for setMyShortDescription method
Params object for setPassportDataErrors method
Params object for setStickerEmojiList method
Params object for setStickerMaskPosition method
Params object for setStickerPositionInSet method
Params object for setStickerSetThumbnail method
Params object for setUserEmojiStatus method
Params object for setWebhook method
Params object for stopMessageLiveLocation method
Params object for stopPoll method
Params object for unbanChatMember method
Params object for unbanChatSenderChat method
Params object for unhideGeneralForumTopic method
Params object for unpinAllForumTopicMessages method
Params object for unpinAllGeneralForumTopicMessages method
Params object for unpinChatMessage method
Params object for uploadStickerFile method
Describes Telegram Passport data shared with the bot by the user.
This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:
Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.
Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.
Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.
Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.
Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
Represents an issue in an unspecified place. The error is considered resolved when new data is added.
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 contains information about a poll.
This object represents an answer of a user in a non-anonymous poll.
This object contains information about one answer option in a poll.
This object contains information about an incoming pre-checkout query.
Describes an inline message to be sent by a user of a Mini App.
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 describes the type of a reaction. Currently, it can be one of
This object contains basic information about a refunded payment.
This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.
Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.
Describes reply parameters for the message that is being sent.
This object describes the state of a revenue withdrawal operation. Currently, it can be one of
Describes an inline message sent by a Web App on behalf of a user.
This object represents a shipping address.
This object contains information about an incoming shipping query.
Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.
This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.
This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.
This object contains information about the quoted part of a message that is replied to by the given message.
This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of
Describes the affiliate program that issued the affiliate commission received via this transaction.
Describes a withdrawal transaction with Fragment.
Describes a withdrawal transaction to the Telegram Ads platform.
Describes a transaction with payment for paid broadcasting.
Describes a transaction with a user.
This object represents an incoming update. At most one of the optional parameters can be present in any given update.
- business_connection
- business_message
- callback_query
- channel_post
- chat_boost
- chat_join_request
- chat_member
- chosen_inline_result
- deleted_business_messages
- edited_business_message
- edited_channel_post
- edited_message
- inline_query
- message
- message_reaction
- message_reaction_count
- my_chat_member
- poll
- poll_answer
- pre_checkout_query
- purchased_paid_media
- removed_chat_boost
- shipping_query
- update_id
This object represents a list of boosts added to a chat by a user.