model library
Various models used by TeleDart
All types used in the Bot API responses are represented as JSON-objects. It is safe to use 32-bit signed integers for storing all Integer fields unless otherwise noted.
Optional fields may be not returned when irrelevant.
Classes
- 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 dice with random value from 1 to 6. (Yes, we're aware of the “proper” singular of die. But it's awkward, and we decided to help it change. One dice at a time!)
- BotCommandScope
- This object represents the scope to which bot commands are applied.
- 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 group and supergroup 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.
- BotDescription
- This object represents the bot's description.
- BotName
- This object represents the bot's name
- BotShortDescription
- This object represents the bot's description.
- CallbackGame
- A placeholder, currently holds no information.
- CallbackQuery
- This object represents an incoming callback query from a callback button in an inline keyboard.
- 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.
- ChatMember
- This object contains information about one member of a chat.
- ChatMemberAdministrator
- Represents a chat member that has some additional privileges.
- ChatMemberBanned
- Represents a chat member that isn't currently a member of the chat, but may join it themselves.
- 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.
- This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button.
- 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
- Contains data required for decrypting and authenticating EncryptedPassportElement.
- EncryptedPassportElement
- Contains information about documents or other Telegram Passport elements shared with the bot by the user.
- ErrorResponse
- File
- This object represents a file ready to be downloaded.
- ForceReply
- Forces the reply dialog for a user
- ForumTopic
- This object represents a forum topic.
- ForumTopicClosed
- This object represents a service message about a forum topic closed in the chat. Currently holds no information.
- ForumTopicCreated
- This object represents a service message about a new forum topic created in the chat.
- ForumTopicEdited
- This object represents a service message about an edited forum topic.
- ForumTopicReopened
- This object represents a service message about a forum topic reopened in the chat. Currently holds no information.
- Game
- This object represents a game.
- GameHighScore
- This object represents one row of the high scores table for a game.
- GeneralForumTopicHidden
- This object represents a service message about General forum topic hidden in the chat.
- This object represents a service message about General forum topic unhidden in the chat.
- InlineKeyboardButton
- This object represents one button of an inline keyboard.
- 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.
- InlineQueryResult
- This object represents one result of an inline query.
- InlineQueryResultArticle
- Represents a link to an article or web page.
- InlineQueryResultAudio
- Represents a link to an mp3 audio file.
- InlineQueryResultCachedAudio
- Represents a link to an mp3 audio file stored on the Telegram servers.
- InlineQueryResultCachedDocument
- Represents a link to a file stored on the Telegram servers.
- InlineQueryResultCachedGif
- Represents a link to an animated GIF file stored on the Telegram servers.
- InlineQueryResultCachedMpeg4Gif
- Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers.
- InlineQueryResultCachedPhoto
- Represents a link to a photo stored on the Telegram servers.
- InlineQueryResultCachedSticker
- Represents a link to a sticker stored on the Telegram servers.
- InlineQueryResultCachedVideo
- Represents a link to a video file stored on the Telegram servers.
- InlineQueryResultCachedVoice
- Represents a link to a voice message stored on the Telegram servers.
- InlineQueryResultContact
- Represents a contact with a phone number.
- InlineQueryResultDocument
- Represents a link to a file. By default, this file will be sent by the user with an optional caption.
- 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 inputMessageContent 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 inputMessageContent 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).
- InlineQueryResultPhoto
- Represents a link to a photo.
- InlineQueryResultsButton
- This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.
- InlineQueryResultVenue
- Represents a venue.
- InlineQueryResultVideo
- Represents a link to a page containing an embedded video player or a video file.
- InlineQueryResultVoice
- Represents a link to a voice recording in an .ogg container encoded with OPUS.
- 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.
- InputMedia
- This object represents the content of a media message to be sent.
- 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.
- InputMediaWithThumbnail
- This object represents the content of a media message to be sent which contains thumbnail.
- InputMessageContent
- This object represents the content of a message to be sent as a result of an inline query.
- InputSticker
- This object describes a sticker to be added to a sticker set.
- 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.
- KeyboardButtonPollType
- This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
- KeyboardButtonRequestChat
- This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.
- KeyboardButtonRequestUser
- This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot 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.
- MaskPosition
- This object describes the position on faces where a mask should be placed by default.
- MenuButton
- This object describes the bot's menu button in a private chat. It should be one of
- 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 an animated emoji that displays a random value.
- OrderInfo
- This object represents information about an order.
- PassportData
- Contains information about Telegram Passport data shared with the bot by the user.
- PassportElementError
- This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user.
- PassportElementErrorDataField
- Represents an issue in one of the data fields that was provided by the user.
- PassportElementErrorFile
- Represents an issue with a document scan.
- PassportElementErrorFiles
- Represents an issue with a list of scans.
- PassportElementErrorFrontSide
- Represents an issue with the front side of a document.
- PassportElementErrorReverseSide
- Represents an issue with the reverse side of a document.
- PassportElementErrorSelfie
- Represents an issue with the selfie with a document.
- PassportElementErrorTranslationFile
- Represents an issue with one of the files that constitute the translation of a document.
- PassportElementErrorTranslationFiles
- Represents an issue with the translated version of a document.
- PassportElementErrorUnspecified
- Represents an issue in an unspecified place.
- PassportFile
- This object represents a file uploaded to Telegram Passport.
- PhotoSize
- This object represents one size of a photo or a file / sticker thumbnail.
- Poll
- This object represents one size of a photo or a file / sticker thumbnail.
- PollAnswer
- This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
- PollOption
- This object represents one size of a photo or a file / sticker thumbnail.
- PreCheckoutQuery
- This object contains information about an incoming pre-checkout query.
- ProximityAlertTriggered
- This object represents the content of a service message,
- ReplyKeyboardMarkup
- This object represents a custom keyboard with reply options
- ReplyKeyboardRemove
- Removes the custom keyboard
- ReplyMarkup
- Object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
- Response
- This object is not explicitly described as an object in the Telegram Bot API.
- ResponseParameters
- Contains information about 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.
- Story
- This object represents a service message about General forum topic unhidden in the chat.
- SuccessfulPayment
- This object contains basic information about a successful payment.
- SuccessResponse
- SwitchInlineQueryChosenChat
- This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.
- TeleDartCallbackQuery
- A recieved callback query
- TeleDartInlineQuery
- A recieved inline query
- TeleDartMessage
- A recieved message
- TeleDartPreCheckoutQuery
- A recieved pre-checkout query
- TeleDartShippingQuery
- A recieved shipping query
- 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.
- This object contains information about the user whose identifier was shared with the bot using a KeyboardButtonRequestUser button.
- Venue
- This object represents a venue.
- Video
- This object represents a video file.
- VideoNote
- This object represents a video message (available in Telegram apps as of v.4.0).
- Voice
- This object represents a voice note.
- VoiceChatEnded
- This object represents a service message about a voice chat ended in the chat.
- VoiceChatParticipantsInvited
- This object represents a service message about new members invited to a voice chat.
- VoiceChatScheduled
- This object represents a service message about a voice chat scheduled in the chat.
- VoiceChatStarted
- This object represents a service message about a voice chat started in the chat.
- WebAppData
- Describes data sent from a Web App to the bot.
- WebAppInfo
- Describes a Web App.
- WebhookInfo
- Contains information about the current status of a webhook.
- WriteAccessAllowed
- This object represents a service message about General forum topic unhidden in the chat.