Serialized Form
-
Package org.telegram.telegrambots.meta.api.interfaces
-
Package org.telegram.telegrambots.meta.api.objects
-
Class org.telegram.telegrambots.meta.api.objects.ApiResponse
class ApiResponse extends Object implements Serializable-
Serialized Fields
-
errorCode
Integer errorCode
-
errorDescription
String errorDescription
-
ok
Boolean ok
-
parameters
ResponseParameters parameters
-
result
T result
-
-
-
Class org.telegram.telegrambots.meta.api.objects.Audio
class Audio extends Object implements Serializable-
Serialized Fields
-
duration
Integer duration
Integer Duration of the audio in seconds as defined by sender -
fileId
String fileId
Identifier for this file, which can be used to download or reuse the file -
fileName
String fileName
Optional. Original filename as defined by sender -
fileSize
Long fileSize
Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. -
fileUniqueId
String fileUniqueId
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. -
mimeType
String mimeType
Optional. MIME type of the file as defined by sender -
performer
String performer
Optional. Performer of the audio as defined by sender or by audio tags -
thumbnail
PhotoSize thumbnail
Optional. Thumbnail of the album cover to which the music file belongs -
title
String title
Optional. Title of the audio as defined by sender or by audio tags
-
-
-
Class org.telegram.telegrambots.meta.api.objects.CallbackQuery
class CallbackQuery extends Object implements Serializable-
Serialized Fields
-
chatInstance
String chatInstance
Identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games. -
data
String data
Optional. Data associated with the callback button. -
from
User from
Sender -
gameShortName
String gameShortName
Optional. Short name of a Game to be returned, serves as the unique identifier for the game -
id
String id
Unique identifier for this query -
inlineMessageId
String inlineMessageId
Optional. Identifier of the message sent via the bot in inline mode, that originated the query -
message
MaybeInaccessibleMessage message
Optional. Message sent by the bot with the callback button that originated the query
-
-
-
Class org.telegram.telegrambots.meta.api.objects.Chat
class Chat extends Object implements Serializable-
Serialized Fields
-
accentColorId
Integer accentColorId
Optional. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details. Returned only in getChat. Always returned in getChat. -
activeUsernames
List<String> activeUsernames
Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat. -
availableReactions
List<ReactionType> availableReactions
Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. Returned only in getChat. -
backgroundCustomEmojiId
String backgroundCustomEmojiId
Optional. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background. Returned only in getChat. -
bio
String bio
Optional. Bio of the other party in a private chat. Returned only in getChat. -
canSetStickerSet
Boolean canSetStickerSet
Optional. True, if the bot can change group the sticker set. Returned only in getChat. -
customEmojiStickerSetName
Boolean customEmojiStickerSetName
Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. Returned only in getChat. -
description
String description
Optional. Description, for groups, supergroups and channel chats. Returned only in getChat. -
emojiStatusCustomEmojiId
String emojiStatusCustomEmojiId
Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat. Returned only in getChat. -
emojiStatusExpirationDate
Boolean emojiStatusExpirationDate
Optional. Expiration date of the emoji status of the other party in a private chat, if any. Returned only in getChat. -
firstName
String firstName
Optional Username of the chat, only for private chats and channels if available -
hasAggressiveAntiSpamEnabled
Boolean hasAggressiveAntiSpamEnabled
Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat. -
hasHiddenMembers
Boolean hasHiddenMembers
Optional. True, if non-administrators can only get the list of bots and administrators in the chat. Returned only in getChat. -
hasPrivateForwards
Boolean hasPrivateForwards
Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=links only in chats with the user. Returned only in getChat. -
HasProtectedContent
Boolean HasProtectedContent
Optional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat. -
hasRestrictedVoiceAndVideoMessages
Boolean hasRestrictedVoiceAndVideoMessages
Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat. -
hasVisibleHistory
Boolean hasVisibleHistory
Optional. True, if new chat members will have access to old messages; available only to chat administrators. Returned only in getChat. -
id
@NonNull Long id
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 smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. -
inviteLink
String inviteLink
Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in getChat. -
isForum
Boolean isForum
Optional. True, if the supergroup chat is a forum (has topics enabled) -
joinByRequest
Boolean joinByRequest
Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat. -
joinToSendMessages
Boolean joinToSendMessages
Optional. True, if users need to join the supergroup before they can send messages. Returned only in getChat. -
lastName
String lastName
Optional. Interlocutor's first name for private chats -
linkedChatId
Long linkedChatId
Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier 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. Returned only in getChat. -
location
ChatLocation location
Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat. -
messageAutoDeleteTime
Integer messageAutoDeleteTime
Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat. -
permissions
ChatPermissions permissions
Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat. -
photo
ChatPhoto photo
Optional. Chat photo. Returned only in getChat. -
pinnedMessage
Message pinnedMessage
Optional. The most recent pinned message (by sending date). Returned only in getChat. -
profileAccentColorId
Boolean profileAccentColorId
Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details. Returned only in getChat. -
profileBackgroundCustomEmojiId
String profileBackgroundCustomEmojiId
Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in getChat. -
slowModeDelay
Integer slowModeDelay
Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user. Returned only in getChat. -
stickerSetName
String stickerSetName
Optional. For supergroups, name of Group sticker set. Returned only in getChat. -
title
String title
Optional. Title of the chat, only for channels and group chat -
type
@NonNull String type
Type of the chat, one of “private”, “group” or “channel” or "supergroup" -
unrestrictBoostCount
Integer unrestrictBoostCount
Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in getChat. -
userName
String userName
Optional. Interlocutor's last name for private chats
-
-
-
Class org.telegram.telegrambots.meta.api.objects.ChatInviteLink
class ChatInviteLink extends Object implements Serializable-
Serialized Fields
-
createsJoinRequest
Boolean createsJoinRequest
True, if users joining the chat via the link need to be approved by chat administrators -
creator
User creator
Creator of the link -
expireDate
Integer expireDate
Optional. Point in time (Unix timestamp) when the link will expire or has been expired -
inviteLink
String inviteLink
The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”. -
isPrimary
Boolean isPrimary
True, if the link is primary -
isRevoked
Boolean isRevoked
True, if the link is revoked -
memberLimit
Integer memberLimit
Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 -
name
String name
Optional. Invite link name -
pendingJoinRequestCount
Integer pendingJoinRequestCount
Optional. Number of pending join requests created using this link
-
-
-
Class org.telegram.telegrambots.meta.api.objects.ChatJoinRequest
class ChatJoinRequest extends Object implements Serializable-
Serialized Fields
-
bio
String bio
Optional. Bio of the user. -
chat
Chat chat
Chat to which the request was sent -
date
Integer date
Date the request was sent in Unix time -
inviteLink
ChatInviteLink inviteLink
Optional. Chat invite link that was used by the user to send the join request -
user
User user
User that sent the join request -
userChatId
Long userChatId
Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.ChatLocation
class ChatLocation extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.ChatMemberUpdated
class ChatMemberUpdated extends Object implements Serializable-
Serialized Fields
-
chat
Chat chat
Chat the user belongs to -
date
Integer date
Date the change was done in Unix time -
from
User from
Performer of the action, which resulted in the change -
inviteLink
ChatInviteLink inviteLink
Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only. -
newChatMember
ChatMember newChatMember
New information about the chat member -
oldChatMember
ChatMember oldChatMember
Previous information about the chat member -
viaChatFolderInviteLink
Boolean viaChatFolderInviteLink
Optional. True, if the user joined the chat via a chat folder invite link
-
-
-
Class org.telegram.telegrambots.meta.api.objects.ChatPermissions
class ChatPermissions extends Object implements Serializable-
Serialized Fields
-
canAddWebPagePreviews
Boolean canAddWebPagePreviews
Optional. True, if the user is allowed to add web page previews to their messages, implies can_send_media_messages -
canChangeInfo
Boolean canChangeInfo
Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups -
canInviteUsers
Boolean canInviteUsers
Optional. True, if the user is allowed to invite new users to the chat -
canManageTopics
Boolean canManageTopics
Optional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages -
canPinMessages
Boolean canPinMessages
Optional. True, if the user is allowed to pin messages. Ignored in public supergroups -
canSendAudios
Boolean canSendAudios
True, if the user is allowed to send audios -
canSendDocuments
Boolean canSendDocuments
True, if the user is allowed to send documents -
canSendMediaMessages
Boolean canSendMediaMessages
Deprecated.Use individual permissionsOptional. True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages -
canSendMessages
Boolean canSendMessages
Optional. True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues -
canSendOtherMessages
Boolean canSendOtherMessages
Optional. True, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages -
canSendPhotos
Boolean canSendPhotos
True, if the user is allowed to send photos -
canSendPolls
Boolean canSendPolls
Optional. True, if the user is allowed to send polls, implies can_send_messages -
canSendVideoNotes
Boolean canSendVideoNotes
True, if the user is allowed to send video notes -
canSendVideos
Boolean canSendVideos
True, if the user is allowed to send videos -
canSendVoiceNotes
Boolean canSendVoiceNotes
Optional. True, if the user is allowed to send voice notes
-
-
-
Class org.telegram.telegrambots.meta.api.objects.ChatPhoto
class ChatPhoto extends Object implements Serializable-
Serialized Fields
-
bigFileId
String bigFileId
File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed. -
bigFileUniqueId
String bigFileUniqueId
Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. -
smallFileId
String smallFileId
File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed. -
smallFileUniqueId
String smallFileUniqueId
Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.Contact
class Contact extends Object implements Serializable-
Serialized Fields
-
firstName
String firstName
Contact's first name -
lastName
String lastName
Optional. Contact's last name -
phoneNumber
String phoneNumber
Contact's phone number -
userId
Long userId
Optional. Contact's user identifier in Telegram -
vCard
String vCard
Optional. Additional data about the contact in the form of a vCard
-
-
-
Class org.telegram.telegrambots.meta.api.objects.Dice
class Dice extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.Document
class Document extends Object implements Serializable-
Serialized Fields
-
fileId
String fileId
Identifier for this file, which can be used to download or reuse the file -
fileName
String fileName
Optional. Original filename as defined by sender -
fileSize
Long fileSize
Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. -
fileUniqueId
String fileUniqueId
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. -
mimeType
String mimeType
Optional. Mime type of a file as defined by sender -
thumbnail
PhotoSize thumbnail
Document thumbnail as defined by sender
-
-
-
Class org.telegram.telegrambots.meta.api.objects.ExternalReplyInfo
class ExternalReplyInfo extends Object implements Serializable-
Serialized Fields
-
animation
Animation animation
Optional. Message is an animation, information about the animation -
audio
Audio audio
Optional. Message is an audio file, information about the file -
chat
Chat chat
Optional. Chat the original message belongs to. Available only if the chat is a supergroup or a channel. -
contact
Contact contact
Optional. Message is a shared contact, information about the contact -
dice
Dice dice
Optional. Message is a dice with random value -
document
Document document
Optional. Message is a general file, information about the file -
game
Game game
Optional. Message is a game, information about the game. -
giveaway
Giveaway giveaway
Optional. Message is a scheduled giveaway, information about the giveaway -
giveawayWinners
GiveawayWinners giveawayWinners
Optional. A giveaway with public winners was completed -
hasMediaSpoiler
Boolean hasMediaSpoiler
Optional. True, if the message media is covered by a spoiler animation -
invoice
Invoice invoice
Optional. Message is an invoice for a payment, information about the invoice. -
linkPreviewOptions
LinkPreviewOptions linkPreviewOptions
Optional. Options used for link preview generation for the original message, if it is a text message -
location
Location location
Optional. Message is a shared location, information about the location -
messageId
Integer messageId
Optional. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel. -
origin
MessageOrigin origin
Origin of the message replied to by the given message -
photo
List<PhotoSize> photo
Optional. Message is a photo, available sizes of the photo -
poll
Poll poll
Optional. Message is a native poll, information about the poll -
sticker
Sticker sticker
Optional. Message is a sticker, information about the sticker -
story
Story story
Optional. Message is a forwarded story -
venue
Venue venue
Optional. Message is a venue, information about the venue -
video
Video video
Optional. Message is a video, information about the video -
videoNote
VideoNote videoNote
Optional. Message is a video note, information about the video message -
voice
Voice voice
Optional. Message is a voice message, information about the file
-
-
-
Class org.telegram.telegrambots.meta.api.objects.File
class File extends Object implements Serializable-
Serialized Fields
-
fileId
String fileId
Identifier for this file, which can be used to download or reuse the file -
filePath
String filePath
Optional. File path. Use https://api.telegram.org/file/bot/ to get the file. -
fileSize
Long fileSize
Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. -
fileUniqueId
String fileUniqueId
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.InaccessibleMessage
class InaccessibleMessage extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.InputFile
class InputFile extends Object implements Serializable-
Serialized Fields
-
attachName
String attachName
-
isNew
boolean isNew
True if the file is new, false if it is a file_id -
mediaName
String mediaName
Name of the media to upload -
newMediaFile
File newMediaFile
New media file -
newMediaStream
InputStream newMediaStream
New media stream
-
-
-
Class org.telegram.telegrambots.meta.api.objects.LinkPreviewOptions
class LinkPreviewOptions extends Object implements Serializable-
Serialized Fields
-
isDisabled
Boolean isDisabled
Optional. True, if the link preview is disabled -
preferLargeMedia
Boolean preferLargeMedia
Optional. True, if the media in the link preview is suppposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview -
preferSmallMedia
Boolean preferSmallMedia
Optional. True, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview -
showAboveText
Boolean showAboveText
Optional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text -
urlField
String urlField
Optional. URL to use for the link preview. If empty, then the first URL found in the message text will be used
-
-
-
Class org.telegram.telegrambots.meta.api.objects.Location
class Location extends Object implements Serializable-
Serialized Fields
-
heading
Integer heading
Optional. The direction in which user is moving, in degrees; 1-360. For active live locations only. -
horizontalAccuracy
Double horizontalAccuracy
Optional. The radius of uncertainty for the location, measured in meters; 0-1500 -
latitude
@NonNull Double latitude
Latitude as defined by sender -
livePeriod
Integer livePeriod
Optional. Time relative to the message sending date, during which the location will be updated, in seconds. For active live locations only. -
longitude
@NonNull Double longitude
Longitude as defined by sender -
proximityAlertRadius
Integer proximityAlertRadius
Optional. Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.LoginUrl
class LoginUrl extends Object implements Serializable-
Serialized Fields
-
botUsername
String botUsername
Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. -
forwardText
String forwardText
-
requestWriteAccess
Boolean requestWriteAccess
-
url
@NonNull String url
An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.Message
class Message extends Object implements Serializable-
Serialized Fields
-
animation
Animation animation
Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will be also set -
audio
Audio audio
Optional. Message is an audio file, information about the file -
authorSignature
String authorSignature
Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator -
boostAdded
ChatBoostAdded boostAdded
Optional. The message is a service message about a user boosting the chat -
caption
String caption
Optional. Caption for the document, photo or video, 0-200 characters -
captionEntities
List<MessageEntity> captionEntities
Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption -
channelChatCreated
Boolean channelChatCreated
Optional. 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. -
chat
Chat chat
Conversation the message belongs to -
chatShared
ChatShared chatShared
Optional. Service message: a chat was shared with the bot -
connectedWebsite
String connectedWebsite
Optional. The domain name of the website on which the user has logged in -
contact
Contact contact
Optional. Message is a shared contact, information about the contact -
date
Integer date
Date the message was sent in Unix time. It is always a positive number, representing a valid date. -
deleteChatPhoto
Boolean deleteChatPhoto
Optional. Informs that the chat photo was deleted -
dice
Dice dice
Optional. Message is a dice with random value from 1 to 6 -
document
Document document
Optional. Message is a general file, information about the file -
editDate
Integer editDate
Optional. Date the message was last edited in Unix time -
entities
List<MessageEntity> entities
Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text -
externalReplyInfo
ExternalReplyInfo externalReplyInfo
Optional. Information about the message that is being replied to, which may come from another chat or forum topic -
forumTopicClosed
ForumTopicClosed forumTopicClosed
Optional. Service message: forum topic closed -
forumTopicCreated
ForumTopicCreated forumTopicCreated
Optional. Service message: forum topic created -
forumTopicEdited
ForumTopicEdited forumTopicEdited
Optional. Service message: forum topic edited -
forumTopicReopened
ForumTopicReopened forumTopicReopened
Optional. Service message: forum topic reopened -
forwardDate
Integer forwardDate
Optional. For forwarded messages, date the original message was sent -
forwardFrom
User forwardFrom
Optional. For forwarded messages, sender of the original message -
forwardFromChat
Chat forwardFromChat
Optional. For messages forwarded from channels or from anonymous administrators, information about the original sender chat -
forwardFromMessageId
Integer forwardFromMessageId
Optional. For forwarded channel posts, identifier of the original message in the channel -
forwardOrigin
MessageOrigin forwardOrigin
Optional. Information about the original message for forwarded messages -
forwardSenderName
String forwardSenderName
Optional. Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages. -
forwardSignature
String forwardSignature
Optional. Post author signature for messages forwarded from channel chats -
from
User from
Optional. Sender, can be empty for messages sent to channels -
game
Game game
Optional. Message is a game, information about the game -
generalForumTopicHidden
GeneralForumTopicHidden generalForumTopicHidden
Optional. Service message: General forum topic hidden -
generalForumTopicUnhidden
GeneralForumTopicUnhidden generalForumTopicUnhidden
Optional. Service message: General forum topic unhidden -
giveaway
Giveaway giveaway
Optional. The message is a scheduled giveaway message -
giveawayCompleted
GiveawayCompleted giveawayCompleted
Optional. Service message: a giveaway without public winners was completed -
giveawayCreated
GiveawayCreated giveawayCreated
Optional. Service message: a scheduled giveaway was created -
giveawayWinners
GiveawayWinners giveawayWinners
Optional. A giveaway with public winners was completed -
groupchatCreated
Boolean groupchatCreated
Optional. Informs that the group has been created -
hasMediaSpoiler
Boolean hasMediaSpoiler
Optional. True, if the message media is covered by a spoiler animation -
hasProtectedContent
Boolean hasProtectedContent
Optional. True, if the message can't be forwarded -
invoice
Invoice invoice
Optional. Message is an invoice for a payment, information about the invoice. -
isAutomaticForward
Boolean isAutomaticForward
Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group -
isTopicMessage
Boolean isTopicMessage
Optional. True, if the message is sent to a forum topic -
leftChatMember
User leftChatMember
Optional. A member was removed from the group, information about them (this member may be bot itself) -
linkPreviewOptions
LinkPreviewOptions linkPreviewOptions
Optional. Options used for link preview generation for the message, if it is a text message and link preview options were changed -
location
Location location
Optional. Message is a shared location, information about the location -
mediaGroupId
String mediaGroupId
Optional. The unique identifier of a media message group this message belongs to -
messageAutoDeleteTimerChanged
MessageAutoDeleteTimerChanged messageAutoDeleteTimerChanged
Optional. Service message: auto-delete timer settings changed in the chat -
messageId
Integer messageId
Integer Unique message identifier -
messageThreadId
Integer messageThreadId
Optional. Unique identifier of a message thread or a forum topic to which the message belongs; for supergroups only -
migrateFromChatId
Long migrateFromChatId
Optional. 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 smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. -
migrateToChatId
Long migrateToChatId
Optional. 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 smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. -
newChatMembers
List<User> newChatMembers
Optional. New members were added to the group or supergroup, information about them (the bot itself may be one of these members) -
newChatPhoto
List<PhotoSize> newChatPhoto
Optional. A chat photo was change to this value -
newChatTitle
String newChatTitle
Optional. A chat title was changed to this value -
passportData
PassportData passportData
Optional. Telegram Passport data -
photo
List<PhotoSize> photo
Optional. Message is a photo, available sizes of the photo -
pinnedMessage
MaybeInaccessibleMessage pinnedMessage
Optional. 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. -
poll
Poll poll
Optional. Message is a native poll, information about the poll -
proximityAlertTriggered
ProximityAlertTriggered proximityAlertTriggered
Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location. -
quote
TextQuote quote
Optional. For replies that quote part of the original message, the quoted part of the message -
replyMarkup
InlineKeyboardMarkup replyMarkup
Inline keyboard attached to the message. -
replyToMessage
Message replyToMessage
Optional. For replies in the same chat and message thread, 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. -
replyToStory
Story replyToStory
Optional. For replies to a story, the original message -
senderBoostCount
Integer senderBoostCount
Optional. If the sender of the message boosted the chat, the number of boosts added by the user -
senderChat
Chat senderChat
Optional. Sender of the message, sent on behalf of a chat. The channel itself for channel messages. The supergroup itself for messages from anonymous group administrators. The linked channel for messages automatically forwarded to the discussion group -
sticker
Sticker sticker
Optional. Message is a sticker, information about the sticker -
story
Story story
Optional. Message is a forwarded story -
successfulPayment
SuccessfulPayment successfulPayment
Optional. Message is a service message about a successful payment, information about the payment. -
superGroupCreated
Boolean superGroupCreated
Optional. 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. -
text
String text
Optional. For text messages, the actual UTF-8 text of the message -
userShared
UserShared userShared
Optional. Service message: a user was shared with the bot -
usersShared
UsersShared usersShared
Optional. Service message: users were shared with the bot -
venue
Venue venue
Optional. Message is a venue, information about the venue -
viaBot
User viaBot
Optional. Bot through which the message was sent -
video
Video video
Optional. Message is a video, information about the video -
videoChatEnded
VideoChatEnded videoChatEnded
Optional. Service message: video chat ended -
videoChatParticipantsInvited
VideoChatParticipantsInvited videoChatParticipantsInvited
Optional. Service message: new participants invited to a video chat -
videoChatScheduled
VideoChatScheduled videoChatScheduled
Optional. Service message: video chat scheduled -
videoChatStarted
VideoChatStarted videoChatStarted
Optional. Service message: video chat started -
videoNote
VideoNote videoNote
Optional. Message is a video note, information about the video message -
voice
Voice voice
Optional. Message is a voice message, information about the file -
webAppData
WebAppData webAppData
Optional. Service message: data sent by a web app -
writeAccessAllowed
WriteAccessAllowed writeAccessAllowed
Optional. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess
-
-
-
Class org.telegram.telegrambots.meta.api.objects.MessageAutoDeleteTimerChanged
class MessageAutoDeleteTimerChanged extends Object implements Serializable-
Serialized Fields
-
messageAutoDeleteTime
Integer messageAutoDeleteTime
New auto-delete time for messages in the chat
-
-
-
Class org.telegram.telegrambots.meta.api.objects.MessageEntity
class MessageEntity extends Object implements Serializable-
Serialized Fields
-
customEmojiId
String customEmojiId
Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker -
language
String language
Optional. For “pre” only, the programming language of the entity text -
length
@NonNull Integer length
Length of the entity in UTF-16 code units -
offset
@NonNull Integer offset
Offset in UTF-16 code units to the start of the entity -
text
String text
Text present in the entity. Computed from offset and length -
type
@NonNull String type
Type of the entity. Currently, can be: - “mention” (@username) - “hashtag” (#hashtag) - “cashtag” ($USD) - “bot_command” (/start@jobs_bot) - “url” (https://telegram.org) - “email” ([email protected]) - “phone_number” (+1-212-555-0123), - “bold” (bold text) - “italic” (italic text) - “underline” (underlined text) - “strikethrough” (strikethrough text) - “spoiler” (spoiler message) - “blockquote” (block quotation) - “code” (monowidth string) - “pre” (monowidth block) - “text_link” (for clickable text URLs) - “text_mention” (for users without usernames) - "custom_emoji" (for inline custom emoji stickers) -
url
String url
Optional. For “text_link” only, url that will be opened after user taps on the text -
user
User user
Optional. For “text_mention” only, the mentioned user
-
-
-
Class org.telegram.telegrambots.meta.api.objects.MessageId
class MessageId extends Object implements Serializable-
Serialized Fields
-
messageId
Long messageId
Unique message identifier
-
-
-
Class org.telegram.telegrambots.meta.api.objects.PhotoSize
class PhotoSize extends Object implements Serializable-
Serialized Fields
-
fileId
String fileId
Identifier for this file, which can be used to download or reuse the file -
filePath
String filePath
Undocumented field. Optional. Can contain the path to download the file directly without calling to getFile -
fileSize
Integer fileSize
Optional. File size -
fileUniqueId
String fileUniqueId
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. -
height
Integer height
Photo height -
width
Integer width
Photo width
-
-
-
Class org.telegram.telegrambots.meta.api.objects.ProximityAlertTriggered
class ProximityAlertTriggered extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.ReplyParameters
class ReplyParameters extends Object implements Serializable-
Serialized Fields
-
allowSendingWithoutReply
Boolean allowSendingWithoutReply
Optional. Pass True if the message should be sent even if the specified message to be replied to is not found; can be used only for replies in the same chat and forum topic. -
chatId
String chatId
Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername) -
messageId
@NonNull Integer messageId
Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified -
quote
String quote
Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message. -
quoteEntities
List<MessageEntity> quoteEntities
Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode. -
quoteParseMode
String quoteParseMode
Optional. Mode for parsing entities in the quote. See formatting options for more details. -
quotePosition
Integer quotePosition
Optional. Position of the quote in the original message in UTF-16 code units
-
-
-
Class org.telegram.telegrambots.meta.api.objects.ResponseParameters
class ResponseParameters extends Object implements Serializable-
Serialized Fields
-
migrateToChatId
Long migrateToChatId
Optional. 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. -
retryAfter
Integer retryAfter
Optional. In case of exceeding flood control a number of seconds to wait before the request can be repeated
-
-
-
Class org.telegram.telegrambots.meta.api.objects.TextQuote
class TextQuote extends Object implements Serializable-
Serialized Fields
-
entities
List<MessageEntity> entities
Optional. Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are kept in quotes. -
isManual
Boolean isManual
Optional. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server. -
position
Integer position
Approximate quote position in the original message in UTF-16 code units as specified by the sender -
text
String text
Text of the quoted part of a message that is replied to by the given message
-
-
-
Class org.telegram.telegrambots.meta.api.objects.Update
class Update extends Object implements Serializable-
Serialized Fields
-
callbackQuery
CallbackQuery callbackQuery
Optional. New incoming callback query -
channelPost
Message channelPost
Optional. New incoming channel post of any kind — text, photo, sticker, etc. -
chatBoost
ChatBoostUpdated chatBoost
Optional. A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates. -
chatJoinRequest
ChatJoinRequest chatJoinRequest
-
chatMember
ChatMemberUpdated chatMember
Optional. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates. -
chosenInlineQuery
ChosenInlineQuery chosenInlineQuery
Optional. The result of an inline query that was chosen by a user and sent to their chat partner -
editedChannelPost
Message editedChannelPost
Optional. New version of a channel post that is known to the bot and was edited -
editedMessage
Message editedMessage
Optional. New version of a message that is known to the bot and was edited -
inlineQuery
InlineQuery inlineQuery
Optional. New incoming inline query -
message
Message message
Optional. New incoming message of any kind — text, photo, sticker, etc. -
messageReaction
MessageReactionUpdated messageReaction
Optional. A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify "message_reaction" in the list of allowed_updates to receive these updates. The update isn't received for reactions set by bots. -
messageReactionCount
MessageReactionCountUpdated messageReactionCount
Optional. Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify "message_reaction_count" in the list of allowed_updates to receive these updates. -
myChatMember
ChatMemberUpdated myChatMember
Optional. The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user. -
poll
Poll poll
Optional. New poll state. Bots receive only updates about polls, which are sent by the bot. -
pollAnswer
PollAnswer pollAnswer
Optional. A user changed their answer in a non-anonymous poll. -
preCheckoutQuery
PreCheckoutQuery preCheckoutQuery
Optional. New incoming pre-checkout query. Contains full information about checkout -
removedChatBoost
ChatBoostRemoved removedChatBoost
Optional. A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates. -
shippingQuery
ShippingQuery shippingQuery
Optional. New incoming shipping query. Only for invoices with flexible price -
updateId
Integer updateId
-
-
-
Class org.telegram.telegrambots.meta.api.objects.User
class User extends Object implements Serializable-
Serialized Fields
-
addedToAttachmentMenu
Boolean addedToAttachmentMenu
Optional. True, if this user added the bot to the attachment menu -
canJoinGroups
Boolean canJoinGroups
Optional. True, if the bot can be invited to groups. Returned only in getMe. -
canReadAllGroupMessages
Boolean canReadAllGroupMessages
Optional. True, if privacy mode is disabled for the bot. Returned only in getMe. -
firstName
@NonNull String firstName
User‘s or bot’s first name -
id
@NonNull Long id
Unique identifier for this user or bot. -
isBot
@NonNull Boolean isBot
True, if this user is a bot -
isPremium
Boolean isPremium
Optional. True, if this user is a Telegram Premium user -
languageCode
String languageCode
Optional. IETF language tag of the user's language -
lastName
String lastName
Optional. User‘s or bot’s last name -
supportInlineQueries
Boolean supportInlineQueries
Optional. True, if the bot supports inline queries. Returned only in getMe. -
userName
String userName
Optional. User‘s or bot’s username
-
-
-
Class org.telegram.telegrambots.meta.api.objects.UserProfilePhotos
class UserProfilePhotos extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.Venue
class Venue extends Object implements Serializable-
Serialized Fields
-
address
String address
Address of the venue -
foursquareId
String foursquareId
Optional. Foursquare identifier of the venue -
foursquareType
String foursquareType
Optional. Foursquare type of the venue. -
googlePlaceId
String googlePlaceId
Optional. Google Places identifier of the venue -
googlePlaceType
String googlePlaceType
Optional. Google Places type of the venue. (See supported types.) -
location
Location location
Venue location -
title
String title
Name of the venue
-
-
-
Class org.telegram.telegrambots.meta.api.objects.Video
class Video extends Object implements Serializable-
Serialized Fields
-
duration
Integer duration
Duration of the video in seconds as defined by sender -
fileId
String fileId
Identifier for this file, which can be used to download or reuse the file -
fileName
String fileName
Optional. Original filename as defined by sender -
fileSize
Long fileSize
Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. -
fileUniqueId
String fileUniqueId
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. -
height
Integer height
Video height as defined by sender -
mimeType
String mimeType
Optional. Mime type of file as defined by sender -
thumbnail
PhotoSize thumbnail
Video thumbnail -
width
Integer width
Video width as defined by sender
-
-
-
Class org.telegram.telegrambots.meta.api.objects.VideoNote
class VideoNote extends Object implements Serializable-
Serialized Fields
-
duration
Integer duration
Duration of the video in seconds as defined by sender -
fileId
String fileId
Identifier for this file, which can be used to download or reuse the file -
fileSize
Integer fileSize
Optional. File size -
fileUniqueId
String fileUniqueId
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. -
length
Integer length
Video width and height as defined by sender -
thumbnail
PhotoSize thumbnail
Optional. Video thumbnail
-
-
-
Class org.telegram.telegrambots.meta.api.objects.Voice
class Voice extends Object implements Serializable-
Serialized Fields
-
duration
Integer duration
Integer Duration of the audio in seconds as defined by sender -
fileId
String fileId
Identifier for this file, which can be used to download or reuse the file -
fileSize
Long fileSize
Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. -
fileUniqueId
String fileUniqueId
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. -
mimeType
String mimeType
Optional. MIME type of the file as defined by sender
-
-
-
Class org.telegram.telegrambots.meta.api.objects.WebhookInfo
class WebhookInfo extends Object implements Serializable-
Serialized Fields
-
allowedUpdates
List<String> allowedUpdates
Optional. A list of update types the bot is subscribed to. Defaults to all update types -
hasCustomCertificate
Boolean hasCustomCertificate
True, if a custom certificate was provided for webhook certificate checks -
ipAddress
String ipAddress
Optional. Currently used webhook IP address -
lastErrorDate
Integer lastErrorDate
Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook -
lastErrorMessage
String lastErrorMessage
Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook -
lastSynchronizationErrorDate
Integer lastSynchronizationErrorDate
Optional. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters -
maxConnections
Integer maxConnections
Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery -
pendingUpdatesCount
Integer pendingUpdatesCount
Number updates awaiting delivery -
url
String url
Webhook URL, may be empty if webhook is not set up
-
-
-
Class org.telegram.telegrambots.meta.api.objects.WriteAccessAllowed
class WriteAccessAllowed extends Object implements Serializable-
Serialized Fields
-
fromAttachmentMenu
Boolean fromAttachmentMenu
Optional. True, if the access was granted when the bot was added to the attachment or side menu -
fromRequest
Boolean fromRequest
Optional. True, if the access was granted after the user accepted an explicit request from a Web App sent by the method requestWriteAccess -
webAppName
String webAppName
Optional. Name of the Web App, if the access was granted when the Web App was launched from a link
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.adminrights
-
Class org.telegram.telegrambots.meta.api.objects.adminrights.ChatAdministratorRights
class ChatAdministratorRights extends Object implements Serializable-
Serialized Fields
-
canChangeInfo
@NonNull Boolean canChangeInfo
True, if the user is allowed to change the chat title, photo and other settings -
canDeleteMessages
@NonNull Boolean canDeleteMessages
True, if the administrator can delete messages of other users -
canDeleteStories
Boolean canDeleteStories
Optional. True, if the administrator can delete stories posted by other users -
canEditMessages
Boolean canEditMessages
Optional. True, if the administrator can edit messages of other users and can pin messages; channels only -
canEditStories
Boolean canEditStories
Optional. True, if the administrator can edit stories posted by other users -
canInviteUsers
@NonNull Boolean canInviteUsers
True, if the user is allowed to invite new users to the chat -
canManageChat
@NonNull Boolean canManageChat
True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege. -
canManageTopics
Boolean canManageTopics
Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only -
canManageVideoChats
@NonNull Boolean canManageVideoChats
True, if the administrator can manage video chats -
canPinMessages
Boolean canPinMessages
Optional. True, if the user is allowed to pin messages; groups and supergroups only -
canPostMessages
Boolean canPostMessages
Optional. True, if the administrator can post messages in the channel; channels only -
canPostStories
Boolean canPostStories
Optional. True, if the administrator can post stories to the chat -
canPromoteMembers
@NonNull Boolean canPromoteMembers
True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user) -
canRestrictMembers
@NonNull Boolean canRestrictMembers
True, if the administrator can restrict, ban or unban chat members -
isAnonymous
@NonNull Boolean isAnonymous
True, if the user's presence in the chat is hidden
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.boost
-
Class org.telegram.telegrambots.meta.api.objects.boost.ChatBoost
class ChatBoost extends Object implements Serializable-
Serialized Fields
-
addDate
Integer addDate
Point in time (Unix timestamp) when the chat was boosted -
boostId
String boostId
Unique identifier of the boost -
expirationDate
Integer expirationDate
Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged -
source
ChatBoostSource source
Source of the added boost
-
-
-
Class org.telegram.telegrambots.meta.api.objects.boost.ChatBoostAdded
class ChatBoostAdded extends Object implements Serializable-
Serialized Fields
-
boostCount
Integer boostCount
Number of boosts added by the user
-
-
-
Class org.telegram.telegrambots.meta.api.objects.boost.ChatBoostRemoved
class ChatBoostRemoved extends Object implements Serializable-
Serialized Fields
-
boostId
String boostId
Unique identifier of the boost -
chat
Chat chat
Chat which was boosted -
removeDate
Integer removeDate
Point in time (Unix timestamp) when the boost was removed -
source
ChatBoostSource source
Source of the removed boost
-
-
-
Class org.telegram.telegrambots.meta.api.objects.boost.ChatBoostSourceGiftCode
class ChatBoostSourceGiftCode extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.boost.ChatBoostSourceGiveaway
class ChatBoostSourceGiveaway extends Object implements Serializable-
Serialized Fields
-
giveawayMessageId
Integer giveawayMessageId
Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet. -
isUnclaimed
Boolean isUnclaimed
Optional. True, if the giveaway was completed, but there was no user to win the prize -
source
String source
Source of the boost, always “giveaway” -
user
User user
Optional. User that won the prize in the giveaway if any
-
-
-
Class org.telegram.telegrambots.meta.api.objects.boost.ChatBoostSourcePremium
class ChatBoostSourcePremium extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.boost.ChatBoostUpdated
class ChatBoostUpdated extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.boost.UserChatBoosts
class UserChatBoosts extends Object implements Serializable
-
-
Package org.telegram.telegrambots.meta.api.objects.boost.serialization
-
Class org.telegram.telegrambots.meta.api.objects.boost.serialization.ChatBoostSourceDeserializer
class ChatBoostSourceDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<ChatBoostSource> implements Serializable-
Serialized Fields
-
objectMapper
com.fasterxml.jackson.databind.ObjectMapper objectMapper
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.chatmember
-
Class org.telegram.telegrambots.meta.api.objects.chatmember.ChatMemberAdministrator
class ChatMemberAdministrator extends Object implements Serializable-
Serialized Fields
-
canBeEdited
Boolean canBeEdited
True, if the bot is allowed to edit administrator privileges of that user -
canChangeInfo
Boolean canChangeInfo
True, if the user is allowed to change the chat title, photo and other settings -
canDeleteMessages
Boolean canDeleteMessages
True, if the administrator can delete messages of other users -
canDeleteStories
Boolean canDeleteStories
Optional. True, if the administrator can delete stories posted by other users -
canEditMessages
Boolean canEditMessages
True, if the administrator can edit messages of other users and can pin messages; channels only -
canEditStories
Boolean canEditStories
Optional. True, if the administrator can edit stories posted by other users -
canInviteUsers
Boolean canInviteUsers
True, if the user is allowed to invite new users to the chat -
canManageChat
Boolean canManageChat
True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege. -
canManageTopics
Boolean canManageTopics
Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only -
canManageVideoChats
Boolean canManageVideoChats
True, if the administrator can manage video chats -
canPinMessages
Boolean canPinMessages
True, if the user is allowed to pin messages; groups and supergroups only -
canPostMessages
Boolean canPostMessages
True, if the administrator can post messages in the channel; channels only -
canPostStories
Boolean canPostStories
Optional. True, if the administrator can post stories to the chat -
canPromoteMembers
Boolean canPromoteMembers
True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user) -
canRestrictMembers
Boolean canRestrictMembers
True, if the administrator can restrict, ban or unban chat members -
customTitle
String customTitle
Custom title for this user -
isAnonymous
Boolean isAnonymous
True, if the user's presence in the chat is hidden -
status
String status
The member's status in the chat, always “administrator” -
user
User user
Information about the user
-
-
-
Class org.telegram.telegrambots.meta.api.objects.chatmember.ChatMemberBanned
class ChatMemberBanned extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.chatmember.ChatMemberLeft
class ChatMemberLeft extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.chatmember.ChatMemberMember
class ChatMemberMember extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.chatmember.ChatMemberOwner
class ChatMemberOwner extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.chatmember.ChatMemberRestricted
class ChatMemberRestricted extends Object implements Serializable-
Serialized Fields
-
canAddWebpagePreviews
Boolean canAddWebpagePreviews
True, if the user is allowed to add web page previews to their messages -
canChangeInfo
Boolean canChangeInfo
True, if the user is allowed to change the chat title, photo and other settings -
canInviteUsers
Boolean canInviteUsers
True, if the user is allowed to invite new users to the chat -
canManageTopics
Boolean canManageTopics
True, if the user is allowed to create forum topics -
canPinMessages
Boolean canPinMessages
True, if the user is allowed to pin messages; groups and supergroups only -
canSendAudios
Boolean canSendAudios
True, if the user is allowed to send audios -
canSendDocuments
Boolean canSendDocuments
True, if the user is allowed to send documents -
canSendMediaMessages
Boolean canSendMediaMessages
Deprecated.Use individual permissions insteadTrue, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes -
canSendMessages
Boolean canSendMessages
True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues -
canSendOtherMessages
Boolean canSendOtherMessages
True, if the user is allowed to send animations, games, stickers and use inline bots -
canSendPhotos
Boolean canSendPhotos
True, if the user is allowed to send photos -
canSendPolls
Boolean canSendPolls
True, if the user is allowed to send polls -
canSendVideoNotes
Boolean canSendVideoNotes
True, if the user is allowed to send video notes -
canSendVideos
Boolean canSendVideos
True, if the user is allowed to send videos -
canSendVoiceNotes
Boolean canSendVoiceNotes
Optional. True, if the user is allowed to send voice notes -
isMember
Boolean isMember
True, if the user is a member of the chat at the moment of the request -
status
String status
The member's status in the chat, always “restricted” -
untilDate
Integer untilDate
Date when restrictions will be lifted for this user; unix time -
user
User user
Information about the user
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.chatmember.serialization
-
Class org.telegram.telegrambots.meta.api.objects.chatmember.serialization.ChatMemberDeserializer
class ChatMemberDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<ChatMember> implements Serializable-
Serialized Fields
-
objectMapper
com.fasterxml.jackson.databind.ObjectMapper objectMapper
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.commands
-
Class org.telegram.telegrambots.meta.api.objects.commands.BotCommand
class BotCommand extends Object implements Serializable
-
-
Package org.telegram.telegrambots.meta.api.objects.commands.scope
-
Class org.telegram.telegrambots.meta.api.objects.commands.scope.BotCommandScopeAllChatAdministrators
class BotCommandScopeAllChatAdministrators extends Object implements Serializable-
Serialized Fields
-
type
String type
Scope type, must be chat
-
-
-
Class org.telegram.telegrambots.meta.api.objects.commands.scope.BotCommandScopeAllGroupChats
class BotCommandScopeAllGroupChats extends Object implements Serializable-
Serialized Fields
-
type
String type
Scope type, must be chat
-
-
-
Class org.telegram.telegrambots.meta.api.objects.commands.scope.BotCommandScopeAllPrivateChats
class BotCommandScopeAllPrivateChats extends Object implements Serializable-
Serialized Fields
-
type
String type
Scope type, must be chat
-
-
-
Class org.telegram.telegrambots.meta.api.objects.commands.scope.BotCommandScopeChat
class BotCommandScopeChat extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.commands.scope.BotCommandScopeChatAdministrators
class BotCommandScopeChatAdministrators extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.commands.scope.BotCommandScopeChatMember
class BotCommandScopeChatMember extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.commands.scope.BotCommandScopeDefault
class BotCommandScopeDefault extends Object implements Serializable-
Serialized Fields
-
type
String type
Scope type, must be chat
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.commands.scope.serialization
-
Class org.telegram.telegrambots.meta.api.objects.commands.scope.serialization.BotCommandScopeDeserializer
class BotCommandScopeDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<BotCommandScope> implements Serializable-
Serialized Fields
-
objectMapper
com.fasterxml.jackson.databind.ObjectMapper objectMapper
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.description
-
Class org.telegram.telegrambots.meta.api.objects.description.BotDescription
class BotDescription extends Object implements Serializable-
Serialized Fields
-
description
String description
The bot's description
-
-
-
Class org.telegram.telegrambots.meta.api.objects.description.BotShortDescription
class BotShortDescription extends Object implements Serializable-
Serialized Fields
-
shortDescription
String shortDescription
The bot's short description
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.forum
-
Class org.telegram.telegrambots.meta.api.objects.forum.ForumTopic
class ForumTopic extends Object implements Serializable-
Serialized Fields
-
-
Class org.telegram.telegrambots.meta.api.objects.forum.ForumTopicClosed
class ForumTopicClosed extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.forum.ForumTopicCreated
class ForumTopicCreated extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.forum.ForumTopicEdited
class ForumTopicEdited extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.forum.ForumTopicReopened
class ForumTopicReopened extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.forum.GeneralForumTopicHidden
class GeneralForumTopicHidden extends Object implements Serializable
-
-
Package org.telegram.telegrambots.meta.api.objects.games
-
Class org.telegram.telegrambots.meta.api.objects.games.Animation
class Animation extends Object implements Serializable-
Serialized Fields
-
duration
@NonNull Integer duration
Duration of the video in seconds as defined by sender -
fileId
@NonNull String fileId
Identifier for this file, which can be used to download or reuse the file -
fileName
String fileName
Optional. Original animation filename as defined by sender -
fileSize
Long fileSize
Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. -
fileUniqueId
@NonNull String fileUniqueId
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. -
height
@NonNull Integer height
Video height as defined by sender -
mimetype
String mimetype
Optional. MIME type of the file as defined by sender -
thumbnail
PhotoSize thumbnail
Optional. Animation thumbnail as defined by sender -
width
@NonNull Integer width
Video width as defined by sender
-
-
-
Class org.telegram.telegrambots.meta.api.objects.games.CallbackGame
class CallbackGame extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.games.Game
class Game extends Object implements Serializable-
Serialized Fields
-
animation
Animation animation
Optional. Animation -
description
@NonNull String description
Description of the game -
entities
List<MessageEntity> entities
Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc. -
photo
@NonNull List<PhotoSize> photo
Photo -
text
String text
Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters. -
title
@NonNull String title
Title of the game
-
-
-
Class org.telegram.telegrambots.meta.api.objects.games.GameHighScore
class GameHighScore extends Object implements Serializable
-
-
Package org.telegram.telegrambots.meta.api.objects.giveaway
-
Class org.telegram.telegrambots.meta.api.objects.giveaway.Giveaway
class Giveaway extends Object implements Serializable-
Serialized Fields
-
chats
List<Chat> chats
The list of chats which the user must join to participate in the giveaway -
countryCodes
List<String> countryCodes
Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways. -
hasPublicWinners
Boolean hasPublicWinners
Optional. True, if the list of giveaway winners will be visible to everyone -
onlyNewMembers
Boolean onlyNewMembers
Optional. True, if only users who join the chats after the giveaway started should be eligible to win -
premiumSubscriptionMonthCount
Integer premiumSubscriptionMonthCount
Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for -
prizeDescription
String prizeDescription
Optional. Description of additional giveaway prize -
winnerCount
Integer winnerCount
The number of users which are supposed to be selected as winners of the giveaway -
winnersSelectionDate
Integer winnersSelectionDate
Point in time (Unix timestamp) when winners of the giveaway will be selected
-
-
-
Class org.telegram.telegrambots.meta.api.objects.giveaway.GiveawayCompleted
class GiveawayCompleted extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.giveaway.GiveawayCreated
class GiveawayCreated extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.giveaway.GiveawayWinners
class GiveawayWinners extends Object implements Serializable-
Serialized Fields
-
additionalChatCount
Integer additionalChatCount
Optional. The number of other chats the user had to join in order to be eligible for the giveaway -
chat
Chat chat
The chat that created the giveaway -
giveawayMessageId
Integer giveawayMessageId
The chat that created the giveaway -
onlyNewMembers
Boolean onlyNewMembers
Optional. True, if only users who had joined the chats after the giveaway started were eligible to win -
premiumSubscriptionMonthCount
Integer premiumSubscriptionMonthCount
Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for -
prizeDescription
String prizeDescription
Optional. Description of additional giveaway prize -
unclaimedPrizeCount
Integer unclaimedPrizeCount
Optional. Number of undistributed prizes -
wasRefunded
Boolean wasRefunded
Optional. True, if the giveaway was canceled because the payment for it was refunded -
winnerCount
Integer winnerCount
Total number of winners in the giveaway -
winners
List<User> winners
List of up to 100 winners of the giveaway -
winnersSelectionDate
Integer winnersSelectionDate
Point in time (Unix timestamp) when winners of the giveaway were selected
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.inlinequery
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.ChosenInlineQuery
class ChosenInlineQuery extends Object implements Serializable-
Serialized Fields
-
from
@NonNull User from
-
inlineMessageId
String inlineMessageId
Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message. -
location
Location location
-
query
@NonNull String query
-
resultId
@NonNull String resultId
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.InlineQuery
class InlineQuery extends Object implements Serializable-
Serialized Fields
-
chatType
String chatType
Optional. Type of the chat, from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat -
from
@NonNull User from
-
id
@NonNull String id
-
location
Location location
-
offset
@NonNull String offset
-
query
@NonNull String query
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.inlinequery.inputmessagecontent
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.inputmessagecontent.InputContactMessageContent
class InputContactMessageContent extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.inlinequery.inputmessagecontent.InputInvoiceMessageContent
class InputInvoiceMessageContent extends Object implements Serializable-
Serialized Fields
-
currency
@NonNull String currency
Three-letter ISO 4217 currency code, see more on currencies -
description
@NonNull String description
Product description, 1-255 characters -
isFlexible
Boolean isFlexible
Optional. Pass True, if the final price depends on the shipping method -
maxTipAmount
Integer maxTipAmount
Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. Defaults to 0 -
needEmail
Boolean needEmail
Optional. Pass True, if you require the user's email address to complete the order -
needName
Boolean needName
Optional. Pass True, if you require the user's full name to complete the order -
needPhoneNumber
Boolean needPhoneNumber
Optional. Pass True, if you require the user's phone number to complete the order -
needShippingAddress
Boolean needShippingAddress
Optional. Pass True, if you require the user's shipping address to complete the order -
payload
@NonNull String payload
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. -
photoHeight
Integer photoHeight
Optional. Photo height -
photoSize
Integer photoSize
Optional. Photo size -
photoUrl
String photoUrl
Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. -
photoWidth
Integer photoWidth
Optional. Photo width -
prices
@NonNull List<LabeledPrice> prices
Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) -
providerData
String providerData
Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider. -
providerToken
@NonNull String providerToken
Payment provider token, obtained via Botfather -
sendEmailToProvider
Boolean sendEmailToProvider
Optional. Pass True, if user's email address should be sent to provider -
sendPhoneNumberToProvider
Boolean sendPhoneNumberToProvider
Optional. Pass True, if user's phone number should be sent to provider -
suggestedTipAmounts
List<Integer> suggestedTipAmounts
Optional. A JSON-serialized array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. -
title
@NonNull String title
Product name, 1-32 characters
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.inputmessagecontent.InputLocationMessageContent
class InputLocationMessageContent extends Object implements Serializable-
Serialized Fields
-
heading
Integer heading
Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. -
horizontalAccuracy
Double horizontalAccuracy
Optional. The radius of uncertainty for the location, measured in meters; 0-1500 -
latitude
@NonNull Double latitude
Latitude of the location in degrees -
livePeriod
Integer livePeriod
Optional. Period in seconds for which the location can be updated, should be between 60 and 86400. -
longitude
@NonNull Double longitude
Longitude of the location in degrees -
proximityAlertRadius
Integer proximityAlertRadius
Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.inputmessagecontent.InputTextMessageContent
class InputTextMessageContent extends Object implements Serializable-
Serialized Fields
-
disableWebPagePreview
Boolean disableWebPagePreview
Optional. Disables link previews for links in the sent message -
entities
List<MessageEntity> entities
Optional. List of special entities that appear in message text, which can be specified instead of parse_mode -
linkPreviewOptions
LinkPreviewOptions linkPreviewOptions
Optional Link preview generation options for the message -
messageText
@NonNull String messageText
Text of a message to be sent, 1-4096 characters -
parseMode
String parseMode
Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.inputmessagecontent.InputVenueMessageContent
class InputVenueMessageContent extends Object implements Serializable-
Serialized Fields
-
address
@NonNull String address
Address of the venue -
foursquareId
String foursquareId
Optional. Foursquare identifier of the venue, if known -
foursquareType
String foursquareType
Optional. Foursquare type of the venue, if known. -
googlePlaceId
String googlePlaceId
Optional. Google Places identifier of the venue -
googlePlaceType
String googlePlaceType
Optional. Google Places type of the venue. (See supported types.) -
latitude
@NonNull Float latitude
Latitude of the venue in degrees -
longitude
@NonNull Float longitude
Longitude of the venue in degrees -
title
@NonNull String title
Name of the venue
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.inlinequery.inputmessagecontent.serialization
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.inputmessagecontent.serialization.InputMessageContentDeserializer
class InputMessageContentDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<InputMessageContent> implements Serializable-
Serialized Fields
-
objectMapper
com.fasterxml.jackson.databind.ObjectMapper objectMapper
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.inlinequery.result
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.InlineQueryResultArticle
class InlineQueryResultArticle extends Object implements Serializable-
Serialized Fields
-
description
String description
-
hideUrl
Boolean hideUrl
-
id
@NonNull String id
-
inputMessageContent
@NonNull InputMessageContent inputMessageContent
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
thumbnailHeight
Integer thumbnailHeight
-
thumbnailUrl
String thumbnailUrl
-
thumbnailWidth
Integer thumbnailWidth
-
title
@NonNull String title
-
type
String type
-
url
String url
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.InlineQueryResultAudio
class InlineQueryResultAudio extends Object implements Serializable-
Serialized Fields
-
audioDuration
Integer audioDuration
-
audioUrl
@NonNull String audioUrl
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
parseMode
String parseMode
-
performer
String performer
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
title
String title
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.InlineQueryResultContact
class InlineQueryResultContact extends Object implements Serializable-
Serialized Fields
-
firstName
@NonNull String firstName
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
lastName
String lastName
-
phoneNumber
@NonNull String phoneNumber
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
thumbnailHeight
Integer thumbnailHeight
-
thumbnailUrl
String thumbnailUrl
-
thumbnailWidth
Integer thumbnailWidth
-
type
String type
-
vCard
String vCard
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.InlineQueryResultDocument
class InlineQueryResultDocument extends Object implements Serializable-
Serialized Fields
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
description
String description
-
documentUrl
@NonNull String documentUrl
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
mimeType
@NonNull String mimeType
-
parseMode
String parseMode
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
thumbnailHeight
Integer thumbnailHeight
-
thumbnailUrl
String thumbnailUrl
-
thumbnailWidth
Integer thumbnailWidth
-
title
@NonNull String title
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.InlineQueryResultGame
class InlineQueryResultGame extends Object implements Serializable-
Serialized Fields
-
gameShortName
@NonNull String gameShortName
-
id
@NonNull String id
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.InlineQueryResultGif
class InlineQueryResultGif extends Object implements Serializable-
Serialized Fields
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
gifDuration
Integer gifDuration
-
gifHeight
Integer gifHeight
-
gifUrl
@NonNull String gifUrl
-
gifWidth
Integer gifWidth
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
parseMode
String parseMode
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
thumbnailMimeType
String thumbnailMimeType
-
thumbnailUrl
String thumbnailUrl
-
title
String title
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.InlineQueryResultLocation
class InlineQueryResultLocation extends Object implements Serializable-
Serialized Fields
-
heading
Integer heading
Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. -
horizontalAccuracy
Double horizontalAccuracy
Optional. The radius of uncertainty for the location, measured in meters; 0-1500 -
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
latitude
@NonNull Float latitude
-
livePeriod
Integer livePeriod
-
longitude
@NonNull Float longitude
-
proximityAlertRadius
Integer proximityAlertRadius
Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. -
replyMarkup
InlineKeyboardMarkup replyMarkup
-
thumbnailHeight
Integer thumbnailHeight
-
thumbnailUrl
String thumbnailUrl
-
thumbnailWidth
Integer thumbnailWidth
-
title
@NonNull String title
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.InlineQueryResultMpeg4Gif
class InlineQueryResultMpeg4Gif extends Object implements Serializable-
Serialized Fields
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
mpeg4Duration
Integer mpeg4Duration
-
mpeg4Height
Integer mpeg4Height
-
mpeg4Url
@NonNull String mpeg4Url
-
mpeg4Width
Integer mpeg4Width
-
parseMode
String parseMode
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
thumbnailMimeType
String thumbnailMimeType
-
thumbnailUrl
String thumbnailUrl
-
title
String title
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.InlineQueryResultPhoto
class InlineQueryResultPhoto extends Object implements Serializable-
Serialized Fields
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
description
String description
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
mimeType
String mimeType
-
parseMode
String parseMode
-
photoHeight
Integer photoHeight
-
photoUrl
@NonNull String photoUrl
-
photoWidth
Integer photoWidth
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
thumbnailUrl
String thumbnailUrl
-
title
String title
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.InlineQueryResultsButton
class InlineQueryResultsButton extends Object implements Serializable-
Serialized Fields
-
startParameter
String startParameter
Optional. Deep-linking parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed. -
text
@NonNull String text
Label text on the button -
webApp
WebAppInfo webApp
Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method web_app_switch_inline_query inside the Web App.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.InlineQueryResultVenue
class InlineQueryResultVenue extends Object implements Serializable-
Serialized Fields
-
address
@NonNull String address
-
foursquareId
String foursquareId
-
foursquareType
String foursquareType
-
googlePlaceId
String googlePlaceId
-
googlePlaceType
String googlePlaceType
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
latitude
@NonNull Float latitude
-
longitude
@NonNull Float longitude
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
thumbnailHeight
Integer thumbnailHeight
-
thumbnailUrl
String thumbnailUrl
-
thumbnailWidth
Integer thumbnailWidth
-
title
@NonNull String title
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.InlineQueryResultVideo
class InlineQueryResultVideo extends Object implements Serializable-
Serialized Fields
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
description
String description
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
mimeType
@NonNull String mimeType
-
parseMode
String parseMode
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
thumbnailUrl
String thumbnailUrl
-
title
String title
-
type
String type
-
videoDuration
Integer videoDuration
-
videoHeight
Integer videoHeight
-
videoUrl
@NonNull String videoUrl
-
videoWidth
Integer videoWidth
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.InlineQueryResultVoice
class InlineQueryResultVoice extends Object implements Serializable-
Serialized Fields
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
parseMode
String parseMode
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
title
@NonNull String title
-
type
String type
-
voiceDuration
Integer voiceDuration
-
voiceUrl
@NonNull String voiceUrl
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.inlinequery.result.cached
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.cached.InlineQueryResultCachedAudio
class InlineQueryResultCachedAudio extends Object implements Serializable-
Serialized Fields
-
audioFileId
@NonNull String audioFileId
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
parseMode
String parseMode
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.cached.InlineQueryResultCachedDocument
class InlineQueryResultCachedDocument extends Object implements Serializable-
Serialized Fields
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
description
String description
-
documentFileId
@NonNull String documentFileId
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
parseMode
String parseMode
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
title
String title
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.cached.InlineQueryResultCachedGif
class InlineQueryResultCachedGif extends Object implements Serializable-
Serialized Fields
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
gifFileId
@NonNull String gifFileId
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
parseMode
String parseMode
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
thumbUrl
String thumbUrl
-
thumbUrlType
String thumbUrlType
-
title
String title
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.cached.InlineQueryResultCachedMpeg4Gif
class InlineQueryResultCachedMpeg4Gif extends Object implements Serializable-
Serialized Fields
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
mpeg4FileId
@NonNull String mpeg4FileId
-
parseMode
String parseMode
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
title
String title
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.cached.InlineQueryResultCachedPhoto
class InlineQueryResultCachedPhoto extends Object implements Serializable-
Serialized Fields
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
description
String description
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
parseMode
String parseMode
-
photoFileId
@NonNull String photoFileId
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
title
String title
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.cached.InlineQueryResultCachedSticker
class InlineQueryResultCachedSticker extends Object implements Serializable-
Serialized Fields
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
stickerFileId
@NonNull String stickerFileId
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.cached.InlineQueryResultCachedVideo
class InlineQueryResultCachedVideo extends Object implements Serializable-
Serialized Fields
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
description
String description
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
parseMode
String parseMode
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
title
String title
-
type
String type
-
videoFileId
@NonNull String videoFileId
-
-
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.cached.InlineQueryResultCachedVoice
class InlineQueryResultCachedVoice extends Object implements Serializable-
Serialized Fields
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
id
@NonNull String id
-
inputMessageContent
InputMessageContent inputMessageContent
-
parseMode
String parseMode
-
replyMarkup
InlineKeyboardMarkup replyMarkup
-
title
@NonNull String title
-
type
String type
-
voiceFileId
@NonNull String voiceFileId
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.inlinequery.result.serialization
-
Class org.telegram.telegrambots.meta.api.objects.inlinequery.result.serialization.InlineQueryResultDeserializer
class InlineQueryResultDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<InlineQueryResult> implements Serializable-
Serialized Fields
-
objectMapper
com.fasterxml.jackson.databind.ObjectMapper objectMapper
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.media
-
Class org.telegram.telegrambots.meta.api.objects.media.InputMedia
class InputMedia extends Object implements Serializable-
Serialized Fields
-
caption
String caption
-
captionEntities
List<MessageEntity> captionEntities
-
isNewMedia
boolean isNewMedia
-
media
@NonNull String media
File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://" to upload a new one using multipart/form-data under name. -
mediaName
String mediaName
-
newMediaFile
File newMediaFile
-
newMediaStream
InputStream newMediaStream
-
parseMode
String parseMode
-
-
-
Class org.telegram.telegrambots.meta.api.objects.media.InputMediaAnimation
class InputMediaAnimation extends InputMedia implements Serializable-
Serialized Fields
-
duration
Integer duration
-
hasSpoiler
Boolean hasSpoiler
Optional. Pass True if the animation must be covered with a spoiler animation -
height
Integer height
-
thumbnail
InputFile thumbnail
Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . -
width
Integer width
-
-
-
Class org.telegram.telegrambots.meta.api.objects.media.InputMediaAudio
class InputMediaAudio extends InputMedia implements Serializable-
Serialized Fields
-
duration
Integer duration
-
performer
String performer
-
thumbnail
InputFile thumbnail
Optional. Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . -
title
String title
-
-
-
Class org.telegram.telegrambots.meta.api.objects.media.InputMediaDocument
class InputMediaDocument extends InputMedia implements Serializable-
Serialized Fields
-
disableContentTypeDetection
Boolean disableContentTypeDetection
Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always true, if the document is sent as part of an album. -
thumbnail
InputFile thumbnail
Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under .
-
-
-
Class org.telegram.telegrambots.meta.api.objects.media.InputMediaPhoto
class InputMediaPhoto extends InputMedia implements Serializable-
Serialized Fields
-
hasSpoiler
Boolean hasSpoiler
Optional. Pass True if the photo must be covered with a spoiler animation
-
-
-
Class org.telegram.telegrambots.meta.api.objects.media.InputMediaVideo
class InputMediaVideo extends InputMedia implements Serializable-
Serialized Fields
-
duration
Integer duration
-
hasSpoiler
Boolean hasSpoiler
Optional. Pass True if the video must be covered with a spoiler animation -
height
Integer height
-
supportsStreaming
Boolean supportsStreaming
-
thumbnail
InputFile thumbnail
Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . -
width
Integer width
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.media.serialization
-
Class org.telegram.telegrambots.meta.api.objects.media.serialization.InputMediaDeserializer
class InputMediaDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<InputMedia> implements Serializable-
Serialized Fields
-
objectMapper
com.fasterxml.jackson.databind.ObjectMapper objectMapper
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.menubutton
-
Package org.telegram.telegrambots.meta.api.objects.menubutton.serialization
-
Package org.telegram.telegrambots.meta.api.objects.messageorigin
-
Class org.telegram.telegrambots.meta.api.objects.messageorigin.MessageOriginChannel
class MessageOriginChannel extends Object implements Serializable-
Serialized Fields
-
authorSignature
String authorSignature
Optional. Signature of the original post author -
chat
Chat chat
Channel chat to which the message was originally sent -
date
Integer date
Date the message was sent originally in Unix time -
messageId
Integer messageId
Unique message identifier inside the chat -
type
String type
Type of the message origin, always “channel”
-
-
-
Class org.telegram.telegrambots.meta.api.objects.messageorigin.MessageOriginChat
class MessageOriginChat extends Object implements Serializable-
Serialized Fields
-
authorSignature
String authorSignature
Optional. For messages originally sent by an anonymous chat administrator, original message author signature -
date
Integer date
Date the message was sent originally in Unix time -
senderChat
Chat senderChat
Chat that sent the message originally -
type
String type
Type of the message origin, always “chat”
-
-
-
Class org.telegram.telegrambots.meta.api.objects.messageorigin.MessageOriginHiddenUser
class MessageOriginHiddenUser extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.messageorigin.MessageOriginUser
class MessageOriginUser extends Object implements Serializable
-
-
Package org.telegram.telegrambots.meta.api.objects.messageorigin.serialization
-
Class org.telegram.telegrambots.meta.api.objects.messageorigin.serialization.MessageOriginDeserializer
class MessageOriginDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<MessageOrigin> implements Serializable-
Serialized Fields
-
objectMapper
com.fasterxml.jackson.databind.ObjectMapper objectMapper
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.name
-
Class org.telegram.telegrambots.meta.api.objects.name.BotName
class BotName extends Object implements Serializable-
Serialized Fields
-
name
String name
The bot's name
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.passport
-
Class org.telegram.telegrambots.meta.api.objects.passport.EncryptedCredentials
class EncryptedCredentials extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.passport.EncryptedPassportElement
class EncryptedPassportElement extends Object implements Serializable-
Serialized Fields
-
data
String data
Optional. Base64-encoded encrypted Telegram Passport data provided by the user, available for “personal_details”, “passport”, “driver_license”, “identity_card”, “identity_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials. -
email
String email
-
files
List<PassportFile> files
Optional. Array of files with encrypted documents, provided by the user, available for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials. -
frontSide
PassportFile frontSide
Optional. File with encrypted document's front side, provided by the user. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials. -
hash
String hash
Base64-encoded element hash for using in PassportElementErrorUnspecified -
phoneNumber
String phoneNumber
-
reverseSide
PassportFile reverseSide
Optional. File with encrypted document's reverse side, provided by the user. Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials. -
selfie
PassportFile selfie
Optional. File with encrypted selfie of the user with a document, provided by the user, can be available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials. -
translations
ArrayList<PassportFile> translations
Optional. Array of encrypted files with translated versions of documents provided by the user. Available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials. -
type
String type
Data type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.passport.PassportData
class PassportData extends Object implements Serializable-
Serialized Fields
-
credentials
EncryptedCredentials credentials
-
data
List<EncryptedPassportElement> data
-
-
-
Class org.telegram.telegrambots.meta.api.objects.passport.PassportFile
class PassportFile extends Object implements Serializable
-
-
Package org.telegram.telegrambots.meta.api.objects.passport.dataerror
-
Class org.telegram.telegrambots.meta.api.objects.passport.dataerror.PassportElementErrorDataField
class PassportElementErrorDataField extends Object implements Serializable-
Serialized Fields
-
dataHash
@NonNull String dataHash
-
fieldName
@NonNull String fieldName
-
message
@NonNull String message
-
source
@NonNull String source
-
type
@NonNull String type
Type of the Telegram Passport data with the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”
-
-
-
Class org.telegram.telegrambots.meta.api.objects.passport.dataerror.PassportElementErrorFile
class PassportElementErrorFile extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.passport.dataerror.PassportElementErrorFiles
class PassportElementErrorFiles extends Object implements Serializable-
Serialized Fields
-
-
Class org.telegram.telegrambots.meta.api.objects.passport.dataerror.PassportElementErrorFrontSide
class PassportElementErrorFrontSide extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.passport.dataerror.PassportElementErrorReverseSide
class PassportElementErrorReverseSide extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.passport.dataerror.PassportElementErrorSelfie
class PassportElementErrorSelfie extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.passport.dataerror.PassportElementErrorTranslationFile
class PassportElementErrorTranslationFile extends Object implements Serializable-
Serialized Fields
-
fileHash
@NonNull String fileHash
-
message
@NonNull String message
-
source
String source
-
type
@NonNull String type
Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
-
-
-
Class org.telegram.telegrambots.meta.api.objects.passport.dataerror.PassportElementErrorTranslationFiles
class PassportElementErrorTranslationFiles extends Object implements Serializable-
Serialized Fields
-
fileHashes
@NonNull List<String> fileHashes
-
message
@NonNull String message
-
source
String source
-
type
@NonNull String type
Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
-
-
-
Class org.telegram.telegrambots.meta.api.objects.passport.dataerror.PassportElementErrorUnspecified
class PassportElementErrorUnspecified extends Object implements Serializable
-
-
Package org.telegram.telegrambots.meta.api.objects.passport.dataerror.serialization
-
Class org.telegram.telegrambots.meta.api.objects.passport.dataerror.serialization.PassportElementErrorDeserializer
class PassportElementErrorDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<PassportElementError> implements Serializable-
Serialized Fields
-
objectMapper
com.fasterxml.jackson.databind.ObjectMapper objectMapper
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.payments
-
Class org.telegram.telegrambots.meta.api.objects.payments.Invoice
class Invoice extends Object implements Serializable-
Serialized Fields
-
currency
String currency
-
description
String description
-
photo
PhotoSize photo
-
startParameter
String startParameter
Unique bot deep-linking parameter that can be used to generate this invoice; may be empty -
title
String title
-
totalAmount
Integer totalAmount
Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.payments.LabeledPrice
class LabeledPrice extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.payments.OrderInfo
class OrderInfo extends Object implements Serializable-
Serialized Fields
-
email
String email
-
name
String name
-
phoneNumber
String phoneNumber
-
shippingAddress
ShippingAddress shippingAddress
-
-
-
Class org.telegram.telegrambots.meta.api.objects.payments.PreCheckoutQuery
class PreCheckoutQuery extends Object implements Serializable-
Serialized Fields
-
currency
String currency
-
from
User from
-
id
String id
-
invoicePayload
String invoicePayload
-
orderInfo
OrderInfo orderInfo
-
shippingOptionId
String shippingOptionId
-
totalAmount
Integer totalAmount
Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.payments.ShippingAddress
class ShippingAddress extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.payments.ShippingOption
class ShippingOption extends Object implements Serializable-
Serialized Fields
-
id
@NonNull String id
-
prices
@NonNull List<LabeledPrice> prices
-
title
@NonNull String title
-
-
-
Class org.telegram.telegrambots.meta.api.objects.payments.ShippingQuery
class ShippingQuery extends Object implements Serializable-
Serialized Fields
-
from
User from
-
id
String id
-
invoicePayload
String invoicePayload
-
shippingAddress
ShippingAddress shippingAddress
-
-
-
Class org.telegram.telegrambots.meta.api.objects.payments.SuccessfulPayment
class SuccessfulPayment extends Object implements Serializable-
Serialized Fields
-
currency
String currency
-
invoicePayload
String invoicePayload
-
orderInfo
OrderInfo orderInfo
-
providerPaymentChargeId
String providerPaymentChargeId
-
shippingOptionId
String shippingOptionId
-
telegramPaymentChargeId
String telegramPaymentChargeId
-
totalAmount
Integer totalAmount
Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145.
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.polls
-
Class org.telegram.telegrambots.meta.api.objects.polls.Poll
class Poll extends Object implements Serializable-
Serialized Fields
-
allowMultipleAnswers
Boolean allowMultipleAnswers
-
closeDate
Integer closeDate
-
correctOptionId
Integer correctOptionId
Optional. 0-based identifier of the correct answer option. -
explanation
String explanation
-
explanationEntities
List<MessageEntity> explanationEntities
-
id
String id
-
isAnonymous
Boolean isAnonymous
-
isClosed
Boolean isClosed
-
openPeriod
Integer openPeriod
-
options
List<PollOption> options
-
question
String question
-
totalVoterCount
Integer totalVoterCount
-
type
String type
-
-
-
Class org.telegram.telegrambots.meta.api.objects.polls.PollAnswer
class PollAnswer extends Object implements Serializable-
Serialized Fields
-
optionIds
List<Integer> optionIds
Optional. The chat that changed the answer to the poll, if the voter is anonymous -
pollId
String pollId
Unique poll identifier -
user
User user
The user, who changed the answer to the poll -
voterChat
Chat voterChat
Optional. The chat that changed the answer to the poll, if the voter is anonymous
-
-
-
Class org.telegram.telegrambots.meta.api.objects.polls.PollOption
class PollOption extends Object implements Serializable
-
-
Package org.telegram.telegrambots.meta.api.objects.reactions
-
Class org.telegram.telegrambots.meta.api.objects.reactions.MessageReactionCountUpdated
class MessageReactionCountUpdated extends Object implements Serializable-
Serialized Fields
-
chat
Chat chat
The chat containing the message -
date
Integer date
Date of the change in Unix time -
messageId
Integer messageId
Unique message identifier inside the chat -
reactions
List<ReactionCount> reactions
List of reactions that are present on the message
-
-
-
Class org.telegram.telegrambots.meta.api.objects.reactions.MessageReactionUpdated
class MessageReactionUpdated extends Object implements Serializable-
Serialized Fields
-
actorChat
Chat actorChat
Optional. The chat on behalf of which the reaction was changed, if the user is anonymous -
chat
Chat chat
The chat containing the message the user reacted to -
date
Integer date
Date of the change in Unix time -
messageId
Integer messageId
Unique identifier of the message inside the chat -
newReaction
List<ReactionType> newReaction
New list of reaction types that have been set by the user -
oldReaction
List<ReactionType> oldReaction
Previous list of reaction types that were set by the user -
user
User user
Optional. The user that changed the reaction, if the user isn't anonymous
-
-
-
Class org.telegram.telegrambots.meta.api.objects.reactions.ReactionCount
class ReactionCount extends Object implements Serializable-
Serialized Fields
-
totalCount
Integer totalCount
Number of times the reaction was added -
type
ReactionType type
Type of the reaction
-
-
-
Class org.telegram.telegrambots.meta.api.objects.reactions.ReactionTypeCustomEmoji
class ReactionTypeCustomEmoji extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.reactions.ReactionTypeEmoji
class ReactionTypeEmoji extends Object implements Serializable-
Serialized Fields
-
emoji
@NonNull String emoji
Reaction emoji. Currently, it can be one of "👍", "👎", "❤", "🔥", "🥰", "👏", "😁", "🤔", "🤯", "😱", "🤬", "😢", "🎉", "🤩", "🤮", "💩", "🙏", "👌", "🕊", "🤡", "🥱", "🥴", "😍", "🐳", "❤🔥", "🌚", "🌭", "💯", "🤣", "⚡", "🍌", "🏆", "💔", "🤨", "😐", "🍓", "🍾", "💋", "🖕", "😈", "😴", "😭", "🤓", "👻", "👨💻", "👀", "🎃", "🙈", "😇", "😨", "🤝", "✍", "🤗", "🫡", "🎅", "🎄", "☃", "💅", "🤪", "🗿", "🆒", "💘", "🙉", "🦄", "😘", "💊", "🙊", "😎", "👾", "🤷♂", "🤷", "🤷♀", "😡" -
type
@NonNull String type
Type of the reaction, always “emoji”
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.reactions.serialization
-
Class org.telegram.telegrambots.meta.api.objects.reactions.serialization.ReactionDeserializer
class ReactionDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<ReactionType> implements Serializable-
Serialized Fields
-
objectMapper
com.fasterxml.jackson.databind.ObjectMapper objectMapper
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.replykeyboard
-
Class org.telegram.telegrambots.meta.api.objects.replykeyboard.ForceReplyKeyboard
class ForceReplyKeyboard extends Object implements Serializable-
Serialized Fields
-
forceReply
@NonNull Boolean forceReply
Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply' -
inputFieldPlaceholder
String inputFieldPlaceholder
Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters -
selective
Boolean selective
Optional. Use this parameter if you want to force reply from 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.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.replykeyboard.InlineKeyboardMarkup
class InlineKeyboardMarkup extends Object implements Serializable-
Serialized Fields
-
keyboard
@NonNull List<List<InlineKeyboardButton>> keyboard
-
-
-
Class org.telegram.telegrambots.meta.api.objects.replykeyboard.ReplyKeyboardMarkup
class ReplyKeyboardMarkup extends Object implements Serializable-
Serialized Fields
-
inputFieldPlaceholder
String inputFieldPlaceholder
Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters -
isPersistent
Boolean isPersistent
Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. -
keyboard
@NonNull List<KeyboardRow> keyboard
-
oneTimeKeyboard
Boolean oneTimeKeyboard
-
resizeKeyboard
Boolean resizeKeyboard
-
selective
Boolean selective
Optional. 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.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.replykeyboard.ReplyKeyboardRemove
class ReplyKeyboardRemove extends Object implements Serializable-
Serialized Fields
-
removeKeyboard
@NonNull Boolean removeKeyboard
-
selective
Boolean selective
Optional. 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.
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons
-
Class org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.InlineKeyboardButton
class InlineKeyboardButton extends Object implements Serializable-
Serialized Fields
-
callbackData
String callbackData
-
callbackGame
CallbackGame callbackGame
Optional. Description of the game that will be launched when the user presses the button. -
loginUrl
LoginUrl loginUrl
Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget. -
pay
Boolean pay
Optional. Specify True, to send a Buy button. -
switchInlineQuery
String switchInlineQuery
Optional. 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. -
switchInlineQueryCurrentChat
String switchInlineQueryCurrentChat
Optional. 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. -
text
@NonNull String text
-
url
String url
Optional. HTTP or tg:// url to be opened when the button is pressed. Links tg://user?id=can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings. -
webApp
WebAppInfo webApp
Optional. Description of the web app that will be launched when the user presses the button. The web app will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between users and the bot.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.KeyboardButton
class KeyboardButton extends Object implements Serializable-
Serialized Fields
-
requestChat
KeyboardButtonRequestChat requestChat
Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats only. -
requestContact
Boolean requestContact
Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only -
requestLocation
Boolean requestLocation
Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only -
requestPoll
KeyboardButtonPollType requestPoll
Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only -
requestUser
KeyboardButtonRequestUser requestUser
Optional. If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a “user_shared” service message. Available in private chats only. -
requestUsers
KeyboardButtonRequestUsers requestUsers
Optional. If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a “users_shared” service message. Available in private chats only. -
text
@NonNull String text
Text of the button. If none of the optional fields are used, it will be sent to the bot as a message when the button is pressed -
webApp
WebAppInfo webApp
Optional. Description of the web app that will be launched when the user presses the button. The web app will be able to send a “web_app_data” service message. Available in private chats only.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.KeyboardButtonPollType
class KeyboardButtonPollType extends Object implements Serializable-
Serialized Fields
-
type
String type
Optional. If quiz is passed, the user will be allowed to create only polls in the quiz mode. If regular is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.KeyboardButtonRequestChat
class KeyboardButtonRequestChat extends Object implements Serializable-
Serialized Fields
-
botAdministratorRights
ChatAdministratorRights botAdministratorRights
Optional. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied. -
botIsMember
Boolean botIsMember
Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied. -
chatHasUsername
Boolean chatHasUsername
Optional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied. -
chatIsChannel
@NonNull Boolean chatIsChannel
Pass True to request a channel chat, pass False to request a group or a supergroup chat. -
chatIsCreated
Boolean chatIsCreated
Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied. -
chatIsForum
Boolean chatIsForum
Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied. -
requestId
@NonNull String requestId
Signed 32-bit identifier of the request -
switchInlineQueryChosenChat
SwitchInlineQueryChosenChat switchInlineQueryChosenChat
Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field -
userAdministratorRights
ChatAdministratorRights userAdministratorRights
Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.KeyboardButtonRequestUser
class KeyboardButtonRequestUser extends Object implements Serializable-
Serialized Fields
-
requestId
@NonNull String requestId
Signed 32-bit identifier of the request -
userIsBot
Boolean userIsBot
Optional. Pass True to request a bot, pass False to request a regular user. If not specified, no additional restrictions are applied. -
userIsPremium
Boolean userIsPremium
Optional. Pass True to request a premium user, pass False to request a non-premium user. If not specified, no additional restrictions are applied.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.KeyboardButtonRequestUsers
class KeyboardButtonRequestUsers extends Object implements Serializable-
Serialized Fields
-
maxQuantity
Integer maxQuantity
Optional. The maximum number of users to be selected; 1-10. Defaults to 1. -
requestId
@NonNull String requestId
Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message -
userIsBot
Boolean userIsBot
Optional. Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied. -
userIsPremium
Boolean userIsPremium
Optional. Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.KeyboardRow
-
Class org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.SwitchInlineQueryChosenChat
class SwitchInlineQueryChosenChat extends Object implements Serializable-
Serialized Fields
-
allowBotChats
Boolean allowBotChats
Optional. True, if private chats with bots can be chosen -
allowChannelChats
Boolean allowChannelChats
Optional. True, if channel chats can be chosen -
allowGroupChats
Boolean allowGroupChats
Optional. True, if group and supergroup chats can be chosen -
allowUserChats
@NonNull Boolean allowUserChats
Optional. True, if private chats with users can be chosen -
requestId
String requestId
Optional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.replykeyboard.serialization
-
Class org.telegram.telegrambots.meta.api.objects.replykeyboard.serialization.KeyboardDeserializer
class KeyboardDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<ReplyKeyboard> implements Serializable-
Serialized Fields
-
objectMapper
com.fasterxml.jackson.databind.ObjectMapper objectMapper
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.serialization
-
Class org.telegram.telegrambots.meta.api.objects.serialization.MaybeInaccessibleMessageDeserializer
class MaybeInaccessibleMessageDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<MaybeInaccessibleMessage> implements Serializable-
Serialized Fields
-
objectMapper
com.fasterxml.jackson.databind.ObjectMapper objectMapper
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.stickers
-
Class org.telegram.telegrambots.meta.api.objects.stickers.InputSticker
class InputSticker extends Object implements Serializable-
Serialized Fields
-
emojiList
@NonNull List<String> emojiList
List of 1-20 emoji associated with the sticker -
keywords
List<String> keywords
Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only. -
maskPosition
MaskPosition maskPosition
Optional. Position where the mask should be placed on faces. For “mask” stickers only. -
sticker
@NonNull InputFile sticker
The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. Animated and video stickers can't be uploaded via HTTP URL.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.stickers.MaskPosition
class MaskPosition extends Object implements Serializable-
Serialized Fields
-
point
@NonNull String point
The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”. -
scale
@NonNull Float scale
Mask scaling coefficient. For example, 2.0 means double size. -
xShift
@NonNull Float xShift
Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position. -
yShift
@NonNull Float yShift
Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.
-
-
-
Class org.telegram.telegrambots.meta.api.objects.stickers.Sticker
class Sticker extends Object implements Serializable-
Serialized Fields
-
customEmojiId
String customEmojiId
Optional. For custom emoji stickers, unique identifier of the custom emoji -
emoji
String emoji
Optional. Emoji associated with the sticker -
fileId
String fileId
Identifier for this file, which can be used to download or reuse the file -
fileSize
Integer fileSize
Optional. File size -
fileUniqueId
String fileUniqueId
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. -
height
Integer height
Sticker height -
isAnimated
Boolean isAnimated
True, if the sticker is animated -
isVideo
Boolean isVideo
True, if the sticker is a video sticker -
maskPosition
MaskPosition maskPosition
Optional. For mask stickers, the position where the mask should be placed -
needsRepainting
Boolean needsRepainting
. Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places -
premiumAnimation
File premiumAnimation
Optional. Premium animation for the sticker, if the sticker is premium -
setName
String setName
Optional. Name of the sticker set to which the sticker belongs -
thumbnail
PhotoSize thumbnail
Optional. Sticker thumbnail in .webp or .jpg format -
type
String type
Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent of its format, which is determined by the fields is_animated and is_video. -
width
Integer width
Sticker width
-
-
-
Class org.telegram.telegrambots.meta.api.objects.stickers.StickerSet
class StickerSet extends Object implements Serializable-
Serialized Fields
-
containsMasks
Boolean containsMasks
Deprecated.Use#getStickerType()
orStickerSet.isMask()
True, if the sticker set contains animated stickers -
isAnimated
Boolean isAnimated
List of all set stickers -
isVideo
Boolean isVideo
True, if the sticker set contains video stickers -
name
String name
Sticker set name -
stickers
List<Sticker> stickers
True, if the sticker set contains masks -
stickerType
String stickerType
Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji” -
thumbnail
PhotoSize thumbnail
Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format -
title
String title
Sticker set title
-
-
-
-
Package org.telegram.telegrambots.meta.api.objects.stories
-
Class org.telegram.telegrambots.meta.api.objects.stories.Story
class Story extends Object implements Serializable
-
-
Package org.telegram.telegrambots.meta.api.objects.videochat
-
Class org.telegram.telegrambots.meta.api.objects.videochat.VideoChatEnded
class VideoChatEnded extends Object implements Serializable-
Serialized Fields
-
duration
Integer duration
Voice chat duration; in seconds
-
-
-
Class org.telegram.telegrambots.meta.api.objects.videochat.VideoChatParticipantsInvited
class VideoChatParticipantsInvited extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.videochat.VideoChatScheduled
class VideoChatScheduled extends Object implements Serializable-
Serialized Fields
-
startDate
@NonNull Integer startDate
Point in time (Unix timestamp) when the voice chat is supposed to be started by a chat administrator
-
-
-
Class org.telegram.telegrambots.meta.api.objects.videochat.VideoChatStarted
class VideoChatStarted extends Object implements Serializable
-
-
Package org.telegram.telegrambots.meta.api.objects.webapp
-
Class org.telegram.telegrambots.meta.api.objects.webapp.SentWebAppMessage
class SentWebAppMessage extends Object implements Serializable-
Serialized Fields
-
inlineMessageId
@NonNull String inlineMessageId
-
-
-
Class org.telegram.telegrambots.meta.api.objects.webapp.WebAppData
class WebAppData extends Object implements Serializable -
Class org.telegram.telegrambots.meta.api.objects.webapp.WebAppInfo
class WebAppInfo extends Object implements Serializable-
Serialized Fields
-
url
@NonNull String url
-
-
-
-
Package org.telegram.telegrambots.meta.exceptions
-
Exception org.telegram.telegrambots.meta.exceptions.TelegramApiException
class TelegramApiException extends Exception implements Serializable -
Exception org.telegram.telegrambots.meta.exceptions.TelegramApiRequestException
class TelegramApiRequestException extends TelegramApiException implements Serializable-
Serialized Fields
-
apiResponse
String apiResponse
-
errorCode
Integer errorCode
-
parameters
ResponseParameters parameters
-
-
-
Exception org.telegram.telegrambots.meta.exceptions.TelegramApiValidationException
class TelegramApiValidationException extends TelegramApiException implements Serializable-
Serialized Fields
-
method
PartialBotApiMethod method
-
object
BotApiObject object
-
-
-