Module types

Available types

Structs

Animation

This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).

Audio

This object represents an audio file to be treated as music by the Telegram clients.

BotCommand

This object represents a bot command.

BotCommandScopeAllChatAdministrators

Represents the scope of bot commands, covering all group and supergroup chat administrators.

BotCommandScopeAllGroupChats

Represents the scope of bot commands, covering all group and supergroup chats.

BotCommandScopeAllPrivateChats

Represents the scope of bot commands, covering all private chats.

BotCommandScopeChat

Represents the scope of bot commands, covering a specific chat.

BotCommandScopeChatAdministrators

Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.

BotCommandScopeChatMember

Represents the scope of bot commands, covering a specific member of a group or supergroup chat.

BotCommandScopeDefault

Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.

CallbackGame

A placeholder, currently holds no information. Use BotFather to set up your game.

CallbackQuery

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.

Chat

This object represents a chat.

ChatAdministratorRights

Represents the rights of an administrator in a chat.

ChatInviteLink

Represents an invite link for a chat.

ChatJoinRequest

Represents a join request sent to a chat.

ChatLocation

Represents a location to which a chat is connected.

ChatMemberAdministrator

Represents a chat member that has some additional privileges.

ChatMemberBanned

Represents a chat member that was banned in the chat and can’t return to the chat or view chat messages.

ChatMemberLeft

Represents a chat member that isn’t currently a member of the chat, but may join it themselves.

ChatMemberMember

Represents a chat member that has no additional privileges or restrictions.

ChatMemberOwner

Represents a chat member that owns the chat and has all administrator privileges.

ChatMemberRestricted

Represents a chat member that is under certain restrictions in the chat. Supergroups only.

ChatMemberUpdated

This object represents changes in the status of a chat member.

ChatPermissions

Describes actions that a non-administrator user is allowed to take in a chat.

ChatPhoto

This object represents a chat photo.

ChosenInlineResult

Represents a result of an inline query that was chosen by the user and sent to their chat partner.

Contact

This object represents a phone contact.

Dice

This object represents an animated emoji that displays a random value.

Document

This object represents a general file (as opposed to photos, voice messages and audio files).

EncryptedCredentials

Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.

EncryptedPassportElement

Describes documents or other Telegram Passport elements shared with the bot by the user.

File

This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot/<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.

ForceReply

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.

Game

This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.

GameHighScore

This object represents one row of the high scores table for a game.

InlineKeyboardButton

This object represents one button of an inline keyboard. You must use exactly one of the optional fields.

InlineKeyboardMarkup

This object represents an inline keyboard that appears right next to the message it belongs to.

InlineQuery

This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.

InlineQueryResultArticle

Represents a link to an article or web page.

InlineQueryResultAudio

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.

InlineQueryResultCachedAudio

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.

InlineQueryResultCachedDocument

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.

InlineQueryResultCachedGif

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.

InlineQueryResultCachedMpeg4Gif

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.

InlineQueryResultCachedPhoto

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.

InlineQueryResultCachedSticker

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.

InlineQueryResultCachedVideo

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.

InlineQueryResultCachedVoice

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.

InlineQueryResultContact

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.

InlineQueryResultDocument

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.

InlineQueryResultGame

Represents a Game.

InlineQueryResultGif

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.

InlineQueryResultLocation

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.

InlineQueryResultMpeg4Gif

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.

InlineQueryResultPhoto

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.

InlineQueryResultVenue

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.

InlineQueryResultVideo

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.

InlineQueryResultVoice

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.

InputContactMessageContent

Represents the content of a contact message to be sent as the result of an inline query.

InputInvoiceMessageContent

Represents the content of an invoice message to be sent as the result of an inline query.

InputLocationMessageContent

Represents the content of a location message to be sent as the result of an inline query.

InputMediaAnimation

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

InputMediaAudio

Represents an audio file to be treated as music to be sent.

InputMediaDocument

Represents a general file to be sent.

InputMediaPhoto

Represents a photo to be sent.

InputMediaVideo

Represents a video to be sent.

InputTextMessageContent

Represents the content of a text message to be sent as the result of an inline query.

InputVenueMessageContent

Represents the content of a venue message to be sent as the result of an inline query.

Invoice

This object contains basic information about an invoice.

KeyboardButton

This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields web_app, request_contact, request_location, and request_poll are mutually exclusive.

KeyboardButtonPollType

This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

LabeledPrice

This object represents a portion of the price for goods or services.

Location

This object represents a point on the map.

LoginUrl

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:

MaskPosition

This object describes the position on faces where a mask should be placed by default.

MenuButtonCommands

Represents a menu button, which opens the bot’s list of commands.

MenuButtonDefault

Describes that no specific value for the menu button was set.

MenuButtonWebApp

Represents a menu button, which launches a Web App.

Message

This object represents a message.

MessageAutoDeleteTimerChanged

This object represents a service message about a change in auto-delete timer settings.

MessageEntity

This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

MessageId

This object represents a unique message identifier.

OrderInfo

This object represents information about an order.

PassportData

Describes Telegram Passport data shared with the bot by the user.

PassportElementErrorDataField

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.

PassportElementErrorFile

Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.

PassportElementErrorFiles

Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.

PassportElementErrorFrontSide

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.

PassportElementErrorReverseSide

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.

PassportElementErrorSelfie

Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.

PassportElementErrorTranslationFile

Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.

PassportElementErrorTranslationFiles

Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.

PassportElementErrorUnspecified

Represents an issue in an unspecified place. The error is considered resolved when new data is added.

PassportFile

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.

PhotoSize

This object represents one size of a photo or a file / sticker thumbnail.

Poll

This object contains information about a poll.

PollAnswer

This object represents an answer of a user in a non-anonymous poll.

PollOption

This object contains information about one answer option in a poll.

PreCheckoutQuery

This object contains information about an incoming pre-checkout query.

ProximityAlertTriggered

This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.

ReplyKeyboardMarkup

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).

ReplyKeyboardRemove

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).

ResponseParameters

Describes why a request was unsuccessful.

SentWebAppMessage

Describes an inline message sent by a Web App on behalf of a user.

ShippingAddress

This object represents a shipping address.

ShippingOption

This object represents one shipping option.

ShippingQuery

This object contains information about an incoming shipping query.

Sticker

This object represents a sticker.

StickerSet

This object represents a sticker set.

SuccessfulPayment

This object contains basic information about a successful payment.

Update

This object represents an incoming update.

User

This object represents a Telegram user or bot.

UserProfilePhotos

This object represent a user’s profile pictures.

Venue

This object represents a venue.

Video

This object represents a video file.

VideoChatEnded

This object represents a service message about a video chat ended in the chat.

VideoChatParticipantsInvited

This object represents a service message about new members invited to a video chat.

VideoChatScheduled

This object represents a service message about a video chat scheduled in the chat.

VideoChatStarted

This object represents a service message about a video chat started in the chat. Currently holds no information.

VideoNote

This object represents a video message (available in Telegram apps as of v.4.0).

Voice

This object represents a voice note.

WebAppData

Describes data sent from a Web App to the bot.

WebAppInfo

Describes a Web App.

WebhookInfo

Describes the current status of a webhook.

Enums

BotCommandScope

This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:

ChatId

Unique identifier for the target chat or username of the target channel

ChatMember

This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:

ChatType

Type of chat, can be either “private”, “group”, “supergroup” or “channel”

InlineQueryResult

This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:

InputFile

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.

InputFileResult

On success,returns a InputFileResult object data method

InputMedia

This object represents the content of a media message to be sent. It should be one of

InputMessageContent

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:

MayBeMessage

method will return Message or True

MenuButton

This object describes the bot’s menu button in a private chat. It should be one of

PassportElementError

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:

ReplyMarkup

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Type Aliases

Params

Params represents a set of parameters that gets passed to a request.