Crate telegram_typings

Structs

Animation

You can provide an animation for your game so that it looks stylish in chats (check out Lumberjack for an example). This object represents an animation file to be displayed in the message containing a game. See https://core.telegram.org/bots/api#game See https://t.me/gamebot See https://core.telegram.org/bots/api#games

Audio

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

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. See https://core.telegram.org/bots/api/bots#inline-keyboards-and-on-the-fly-updating See https://core.telegram.org/bots/api#inline-mode

Chat

This object represents a chat.

ChatMember

This object contains information about one member of 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. See https://core.telegram.org/bots/api#inlinequeryresult

Contact

This object represents a phone contact.

Document

This object represents a general file (as opposed to photos, voice messages and audio files). See https://core.telegram.org/bots/api#photosize See https://core.telegram.org/bots/api#voice See https://core.telegram.org/bots/api#audio

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. See https://core.telegram.org/bots/api#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. See https://core.telegram.org/bots/api/bots#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. See https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating

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. See https://core.telegram.org/bots/api#games

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. See https://core.telegram.org/bots/api#inputmessagecontent

InputLocationMessageContent

Represents the content of a location message to be sent as the result of an inline query. See https://core.telegram.org/bots/api#inputmessagecontent

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. See https://core.telegram.org/bots/api#inputmessagecontent

InputVenueMessageContent

Represents the content of a venue message to be sent as the result of an inline query. See https://core.telegram.org/bots/api#inputmessagecontent

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 are mutually exclusive.

LabeledPrice

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

Location

This object represents a point on the map.

MaskPosition

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

Message

This object represents a message.

MessageEntity

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

OrderInfo

This object represents information about an order.

PhotoSize

This object represents one size of a photo or a file / sticker thumbnail. See https://core.telegram.org/bots/api#document See https://core.telegram.org/bots/api#sticker

PreCheckoutQuery

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

ReplyKeyboardMarkup

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). See https://core.telegram.org/bots#keyboards

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). See https://core.telegram.org/bots/api#replykeyboardmarkup

ResponseParameters

Contains information about why a request was unsuccessful.

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.At most one of the optional parameters can be present in any given update. See https://core.telegram.org/bots/api#available-types

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.

VideoNote

This object represents a video message (available in Telegram apps as of v.4.0). See https://telegram.org/blog/video-messages-and-telescope

Voice

This object represents a voice note.

WebhookInfo

Contains information about the current status of a webhook.

Enums

InputMessageContent

This object represents the content of a message to be sent as a result of an inline query.