Fields

• userId :: UserId

  Unique identifier for this user or bot.

• userIsBot :: Bool

  True, if this user is a bot.

• userFirstName :: Text

  User's or bot's first name.

• userLastName :: Maybe Text

  User‘s or bot’s last name

• userUsername :: Maybe Text

  User‘s or bot’s username

• userLanguageCode :: Maybe Text

  IETF language tag of the user's language

Fields

• chatId :: ChatId

  Unique identifier for this chat. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.

• chatType :: ChatType

  Type of chat.

• chatTitle :: Maybe Text

  Title, for supergroups, channels and group chats

• chatUsername :: Maybe Text

  Username, for private chats, supergroups and channels if available

• chatFirstName :: Maybe Text

  First name of the other party in a private chat

• chatLastName :: Maybe Text

  Last name of the other party in a private chat

• chatAllMembersAreAdministrators :: Maybe Bool

  True if a group has ‘All Members Are Admins’ enabled.

• chatPhoto :: Maybe ChatPhoto

  Chat photo. Returned only in getChat.

• chatDescription :: Maybe Text

  Description, for supergroups and channel chats. Returned only in getChat.

• chatInviteLink :: Maybe Text

  Chat invite link, for supergroups and channel chats. Returned only in getChat.

• chatPinnedMessage :: Maybe Message

  Pinned message, for supergroups. Returned only in getChat.

• chatStickerSetName :: Maybe Text

  For supergroups, name of group sticker set. Returned only in getChat.

• chatCanSetStickerSet :: Maybe Bool

  True, if the bot can change the group sticker set. Returned only in getChat.

Fields

• messageMessageId :: MessageId

  Unique message identifier inside this chat

• messageFrom :: Maybe User

  Sender, empty for messages sent to channels

• messageDate :: POSIXTime

  Date the message was sent in Unix time

• messageChat :: Chat

  Conversation the message belongs to

• messageForwardFrom :: Maybe User

  For forwarded messages, sender of the original message

• messageForwardFromChat :: Maybe Chat

  For messages forwarded from channels, information about the original channel

• messageForwardFromMessageId :: Maybe MessageId

  For messages forwarded from channels, identifier of the original message in the channel

• messageForwardSignature :: Maybe Text

  For messages forwarded from channels, signature of the post author if present

• messageForwardDate :: Maybe POSIXTime

  For forwarded messages, date the original message was sent in Unix time

• messageReplyToMessage :: Maybe Message

  For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.

• messageEditDate :: Maybe POSIXTime

  Date the message was last edited in Unix time

• messageMediaGroupId :: Maybe MediaGroupId

  The unique identifier of a media message group this message belongs to

• messageAuthorSignature :: Maybe Text

  Signature of the post author for messages in channels

• messageText :: Maybe Text

  For text messages, the actual UTF-8 text of the message, 0-4096 characters.

• messageEntities :: Maybe [MessageEntity]

  For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text

• messageCaptionEntities :: Maybe [MessageEntity]

  For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption

• messageAudio :: Maybe Audio

  Message is an audio file, information about the file

• messageDocument :: Maybe Document

  Message is a general file, information about the file

• messagePhoto :: Maybe [PhotoSize]

  Message is a photo, available sizes of the photo

• messageVideo :: Maybe Video

  Message is a video, information about the video

• messageVoice :: Maybe Voice

  Message is a voice message, information about the file

• messageVideoNote :: Maybe VideoNote

  Message is a video note, information about the video message

• messageCaption :: Maybe Text

  Caption for the audio, document, photo, video or voice, 0-200 characters

• messageContact :: Maybe Contact

  Message is a shared contact, information about the contact

• messageLocation :: Maybe Location

  Message is a shared location, information about the location

• messageVenue :: Maybe Venue

  Message is a venue, information about the venue

• messageNewChatMembers :: Maybe [User]

  New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)

• messageLeftChatMember :: Maybe User

  A member was removed from the group, information about them (this member may be the bot itself)

• messageNewChatTitle :: Maybe Text

  A chat title was changed to this value

• messageNewChatPhoto :: Maybe [PhotoSize]

  A chat photo was change to this value

• messageDeleteChatPhoto :: Maybe Bool

  Service message: the chat photo was deleted

• messageGroupChatCreated :: Maybe Bool

  Service message: the group has been created

• messageSupergroupChatCreated :: Maybe Bool

  Service message: the supergroup has been created. This field can‘t be received in a message coming through updates, because bot can’t be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.

• messageChannelChatCreated :: Maybe Bool

  Service message: the channel has been created. This field can‘t be received in a message coming through updates, because bot can’t be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.

• messageMigrateToChatId :: Maybe ChatId

  The group has been migrated to a supergroup with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.

• messageMigrateFromChatId :: Maybe ChatId

  The supergroup has been migrated from a group with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.

• messagePinnedMessage :: Maybe Message

  Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply.

Fields

• messageEntityType :: MessageEntityType

  Type of the entity. Can be mention (@username), hashtag, bot_command, url, email, bold (bold text), italic (italic text), code (monowidth string), pre (monowidth block), text_link (for clickable text URLs), text_mention (for users without usernames)

• messageEntityOffset :: Int32

  Offset in UTF-16 code units to the start of the entity

• messageEntityLength :: Int32

  Length of the entity in UTF-16 code units

• messageEntityUrl :: Maybe Text

  For “text_link” only, url that will be opened after user taps on the text

• messageEntityUser :: Maybe User

  For “text_mention” only, the mentioned user

Fields

• photoSizeFileId :: FileId

  Unique identifier for this file

• photoSizeWidth :: Int32

  Photo width

• photoSizeHeight :: Int32

  Photo height

• photoSizeFileSize :: Maybe Int32

  File size

Fields

• audioFileId :: FileId

  Unique identifier for this file

• audioDuration :: Seconds

  Duration of the audio in seconds as defined by sender

• audioPerformer :: Maybe Text

  Performer of the audio as defined by sender or by audio tags

• audioTitle :: Maybe Text

  Title of the audio as defined by sender or by audio tags

• audioMimeType :: Maybe Text

  MIME type of the file as defined by sender

• audioFileSize :: Maybe Int32

  File size

Fields

• documentFileId :: FileId

  Unique file identifier

• documentThumb :: Maybe PhotoSize

  Document thumbnail as defined by sender

• documentFileName :: Maybe Text

  Original filename as defined by sender

• documentMimeType :: Maybe Text

  MIME type of the file as defined by sender

• documentFileSize :: Maybe Int32

  File size

Fields

• videoFileId :: FileId

  Unique identifier for this file

• videoWidth :: Int32

  Video width as defined by sender

• videoHeight :: Int32

  Video height as defined by sender

• videoDuration :: Seconds

  Duration of the video in seconds as defined by sender

• videoThumb :: Maybe PhotoSize

  Video thumbnail

• videoMimeType :: Maybe Text

  Mime type of a file as defined by sender

• videoFileSize :: Maybe Int32

  File size

Fields

• voiceFileId :: FileId

  Unique identifier for this file

• voiceDuration :: Seconds

  Duration of the audio in seconds as defined by sender

• voiceMimeType :: Maybe Text

  MIME type of the file as defined by sender

• voiceFileSize :: Maybe Int32

  File size

Fields

• videoNoteFileId :: Text

  Unique identifier for this file

• videoNoteLength :: Int32

  Video width and height as defined by sender

• videoNoteDuration :: Seconds

  Duration of the video in seconds as defined by sender

• videoNoteThumb :: Maybe PhotoSize

  Video thumbnail

• videoNoteFileSize :: Maybe Int32

  File size

Fields

• contactPhoneNumber :: Text

  Contact's phone number

• contactFirstName :: Text

  Contact's first name

• contactLastName :: Maybe Text

  Contact's last name

• contactUserId :: Maybe UserId

  Contact's user identifier in Telegram

Fields

• locationLongitude :: Float

  Longitude as defined by sender

• locationLatitude :: Float

  Latitude as defined by sender

Fields

• venueLocation :: Location

  Venue location

• venueTitle :: Text

  Name of the venue

• venueAddress :: Text

  Address of the venue

• venueFoursquareId :: Maybe Text

  Foursquare identifier of the venue

Fields

• userProfilePhotosTotalCount :: Int32

  Total number of profile pictures the target user has

• userProfilePhotosPhotos :: [[PhotoSize]]

  Requested profile pictures (in up to 4 sizes each)

Fields

• fileFileId :: FileId

  Unique identifier for this file

• fileFileSize :: Maybe Int32

  File size, if known

• fileFilePath :: Maybe Text

  File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.

Fields

• replyKeyboardMarkupKeyboard :: [[KeyboardButton]]

  Array of button rows, each represented by an Array of KeyboardButton objects

• replyKeyboardMarkupResizeKeyboard :: Maybe Bool

  Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.

• replyKeyboardMarkupOneTimeKeyboard :: Maybe Bool

  Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Defaults to false.

• replyKeyboardMarkupSelective :: Maybe Bool

  Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.

Fields

• keyboardButtonText :: Text

  Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed

• keyboardButtonRequestContact :: Maybe Bool

  If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only

• keyboardButtonRequestLocation :: Maybe Bool

  If True, the user's current location will be sent when the button is pressed. Available in private chats only

Fields

• replyKeyboardRemoveRemoveKeyboard :: Bool

  Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)

• replyKeyboardRemoveSelective :: Maybe Bool

  Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.

Fields

• inlineKeyboardMarkupInlineKeyboard :: [[InlineKeyboardButton]]

  Array of button rows, each represented by an Array of InlineKeyboardButton objects

Fields

• inlineKeyboardButtonText :: Text

  Label text on the button

• inlineKeyboardButtonUrl :: Maybe Text

  HTTP url to be opened when button is pressed

• inlineKeyboardButtonCallbackData :: Maybe Text

  Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes

• inlineKeyboardButtonSwitchInlineQuery :: Maybe Text

  If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot‘s username and the specified inline query in the input field. Can be empty, in which case just the bot’s username will be inserted.

• inlineKeyboardButtonSwitchInlineQueryCurrentChat :: Maybe Text

  If set, pressing the button will insert the bot‘s username and the specified inline query in the current chat's input field. Can be empty, in which case only the bot’s username will be inserted.

• inlineKeyboardButtonPay :: Maybe Bool

  Specify True, to send a Pay button.