Documentation
¶
Overview ¶
This package provides a set of types defined in Telegram Bot API documentation. Each type is ready to be used in API requests.
Licensed under the MIT License. See LICENSE file for details.
Index ¶
- type AcceptedGiftTypes
- type AffiliateInfo
- type Animation
- type Audio
- type BackgroundFill
- type BackgroundFillFreeformGradient
- type BackgroundFillGradient
- type BackgroundFillSolid
- type BackgroundType
- type BackgroundTypeChatTheme
- type BackgroundTypeFill
- type BackgroundTypePattern
- type BackgroundTypeWallpaper
- type BirthDate
- type BotCommand
- type BotCommandScope
- type BotCommandScopeAllChatAdministrators
- type BotCommandScopeAllGroupChats
- type BotCommandScopeAllPrivateChats
- type BotCommandScopeChat
- type BotCommandScopeChatAdministrators
- type BotCommandScopeChatMember
- type BotCommandScopeDefault
- type BotDescription
- type BotName
- type BotShortDescription
- type BusinessBotRights
- type BusinessConnection
- type BusinessIntro
- type BusinessLocation
- type BusinessMessagesDeleted
- type BusinessOpeningHours
- type BusinessOpeningHoursInterval
- type CallbackGame
- type CallbackQuery
- type Chat
- type ChatAdministratorRights
- type ChatBackground
- type ChatBoost
- type ChatBoostAdded
- type ChatBoostRemoved
- type ChatBoostSource
- type ChatBoostSourceGiftCode
- type ChatBoostSourceGiveaway
- type ChatBoostSourcePremium
- type ChatBoostUpdated
- type ChatFullInfo
- type ChatInviteLink
- type ChatJoinRequest
- type ChatLocation
- type ChatMember
- type ChatMemberAdministrator
- type ChatMemberBanned
- type ChatMemberLeft
- type ChatMemberMember
- type ChatMemberOwner
- type ChatMemberRestricted
- type ChatMemberUpdated
- type ChatPermissions
- type ChatPhoto
- type ChatShared
- type ChosenInlineResult
- type Contact
- type CopyTextButton
- type Dice
- type Document
- type EncryptedCredentials
- type EncryptedPassportElement
- type ExternalReplyInfo
- type File
- type ForceReply
- type ForumTopic
- type ForumTopicClosed
- type ForumTopicCreated
- type ForumTopicEdited
- type ForumTopicReopened
- type Game
- type GameHighScore
- type GeneralForumTopicHidden
- type GeneralForumTopicUnhidden
- type Gift
- type GiftInfo
- type Gifts
- type Giveaway
- type GiveawayCompleted
- type GiveawayCreated
- type GiveawayWinners
- type InaccessibleMessage
- type InlineKeyboardButton
- type InlineKeyboardMarkup
- type InlineQuery
- type InlineQueryResult
- type InlineQueryResultArticle
- type InlineQueryResultAudio
- type InlineQueryResultCachedAudio
- type InlineQueryResultCachedDocument
- type InlineQueryResultCachedGif
- type InlineQueryResultCachedMpeg4Gif
- type InlineQueryResultCachedPhoto
- type InlineQueryResultCachedSticker
- type InlineQueryResultCachedVideo
- type InlineQueryResultCachedVoice
- type InlineQueryResultContact
- type InlineQueryResultDocument
- type InlineQueryResultGame
- type InlineQueryResultGif
- type InlineQueryResultLocation
- type InlineQueryResultMpeg4Gif
- type InlineQueryResultPhoto
- type InlineQueryResultVenue
- type InlineQueryResultVideo
- type InlineQueryResultVoice
- type InlineQueryResultsButton
- type InputContactMessageContent
- type InputFile
- type InputFileFromReader
- type InputFileFromRemote
- type InputInvoiceMessageContent
- type InputLocationMessageContent
- type InputMedia
- type InputMediaAnimation
- type InputMediaAudio
- type InputMediaDocument
- type InputMediaPhoto
- type InputMediaVideo
- type InputMessageContent
- type InputPaidMedia
- type InputPaidMediaPhoto
- type InputPaidMediaVideo
- func (i *InputPaidMediaVideo) SetCover(cover string, r io.Reader)
- func (i *InputPaidMediaVideo) SetPaidMedia(media string, r io.Reader)
- func (i *InputPaidMediaVideo) SetThumbnail(thumb string, r io.Reader)
- func (i InputPaidMediaVideo) Validate() error
- func (i InputPaidMediaVideo) WriteTo(mw *multipart.Writer) error
- type InputPollOption
- type InputProfilePhoto
- type InputProfilePhotoAnimated
- type InputProfilePhotoStatic
- type InputSticker
- type InputStoryContent
- type InputStoryContentPhoto
- type InputStoryContentVideo
- type InputTextMessageContent
- type InputVenueMessageContent
- type Invoice
- type KeyboardButton
- type KeyboardButtonPollType
- type KeyboardButtonRequestChat
- type KeyboardButtonRequestUsers
- type LabeledPrice
- type LinkPreviewOptions
- type Location
- type LocationAddress
- type LoginUrl
- type MaskPosition
- type MaybeInaccessibleMessage
- type MenuButton
- type MenuButtonCommands
- type MenuButtonDefault
- type MenuButtonResponse
- type MenuButtonWebApp
- type Message
- type MessageAutoDeleteTimerChanged
- type MessageEntity
- type MessageId
- type MessageOrigin
- type MessageOriginChannel
- type MessageOriginChat
- type MessageOriginHiddenUser
- type MessageOriginUser
- type MessageReactionCountUpdated
- type MessageReactionUpdated
- type OrderInfo
- type OwnedGift
- type OwnedGiftRegular
- type OwnedGiftUnique
- type OwnedGifts
- type PaidMedia
- type PaidMediaInfo
- type PaidMediaPhoto
- type PaidMediaPreview
- type PaidMediaPurchased
- type PaidMediaVideo
- type PaidMessagePriceChanged
- type PassportData
- type PassportElementError
- type PassportElementErrorDataField
- type PassportElementErrorFile
- type PassportElementErrorFiles
- type PassportElementErrorFrontSide
- type PassportElementErrorReverseSide
- type PassportElementErrorSelfie
- type PassportElementErrorTranslationFile
- type PassportElementErrorTranslationFiles
- type PassportElementErrorUnspecified
- type PassportFile
- type PhotoSize
- type Poll
- type PollAnswer
- type PollOption
- type PreCheckoutQuery
- type PreparedInlineMessage
- type ProximityAlertTriggered
- type ReactionCount
- type ReactionType
- type ReactionTypeCustomEmoji
- type ReactionTypeEmoji
- type ReactionTypePaid
- type RefundedPayment
- type ReplyKeyboardMarkup
- type ReplyKeyboardRemove
- type ReplyMarkup
- type ReplyMarkupInterface
- type ReplyParameters
- type ResponseParameters
- type RevenueWithdrawalState
- type RevenueWithdrawalStateFailed
- type RevenueWithdrawalStatePending
- type RevenueWithdrawalStateSucceeded
- type SentWebAppMessage
- type SharedUser
- type ShippingAddress
- type ShippingOption
- type ShippingQuery
- type StarAmount
- type StarTransaction
- type StarTransactions
- type Sticker
- type StickerSet
- type Story
- type StoryArea
- type StoryAreaPosition
- type StoryAreaType
- type StoryAreaTypeLink
- type StoryAreaTypeLocation
- type StoryAreaTypeSuggestedReaction
- type StoryAreaTypeUniqueGift
- type StoryAreaTypeWeather
- type SuccessfulPayment
- type SwitchInlineQueryChosenChat
- type TextQuote
- type TransactionPartner
- type TransactionPartnerAffiliateProgram
- type TransactionPartnerChat
- type TransactionPartnerFragment
- type TransactionPartnerOther
- type TransactionPartnerTelegramAds
- type TransactionPartnerTelegramApi
- type TransactionPartnerUser
- type UniqueGift
- type UniqueGiftBackdrop
- type UniqueGiftBackdropColors
- type UniqueGiftInfo
- type UniqueGiftModel
- type UniqueGiftSymbol
- type Update
- type User
- type UserChatBoosts
- type UserProfilePhotos
- type UsersShared
- type Venue
- type Video
- type VideoChatEnded
- type VideoChatParticipantsInvited
- type VideoChatScheduled
- type VideoChatStarted
- type VideoNote
- type Voice
- type WebAppData
- type WebAppInfo
- type WriteAccessAllowed
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AcceptedGiftTypes ¶ added in v1.2.0
type AcceptedGiftTypes struct {
// True, if unlimited regular gifts are accepted
UnlimitedGifts bool `json:"unlimited_gifts"`
// True, if limited regular gifts are accepted
LimitedGifts bool `json:"limited_gifts"`
// True, if unique gifts or gifts that can be upgraded to unique for free are accepted
UniqueGifts bool `json:"unique_gifts"`
// True, if a Telegram Premium subscription is accepted
PremiumSubscription bool `json:"premium_subscription"`
}
This object describes the types of gifts that can be gifted to a user or a chat.
type AffiliateInfo ¶
type AffiliateInfo struct {
// Optional. The bot or the user that received an affiliate commission if it was received by a bot or a user
AffiliateUser *User `json:"affiliate_user,omitempty"`
// Optional. The chat that received an affiliate commission if it was received by a chat
AffiliateChat *Chat `json:"affiliate_chat,omitempty"`
// The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users
CommissionPerMile int `json:"commission_per_mile"`
// Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds
Amount int `json:"amount"`
// Optional. The number of 1/1000000000 shares of Telegram Stars received by the affiliate;
// from -999999999 to 999999999; can be negative for refunds
NanostarAmount *int `json:"nanostar_amount,omitempty"`
}
Contains information about the affiliate that received a commission via this transaction.
type Animation ¶
type Animation struct {
// Identifier for this file, which can be used to download or reuse the file
FileId string `json:"file_id"`
// 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.
FileUniqueId string `json:"file_unique_id"`
// Video width as defined by the sender
Width int `json:"width"`
// Video height as defined by the sender
Height int `json:"height"`
// Duration of the video in seconds as defined by the sender
Duration int `json:"duration"`
// Optional. Animation thumbnail as defined by the sender
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
// Optional. Original animation filename as defined by the sender
FileName *string `json:"file_name,omitempty"`
// Optional. MIME type of the file as defined by the sender
MimeType *string `json:"mime_type,omitempty"`
// 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.
FileSize *int64 `json:"file_size,omitempty"`
}
This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
type Audio ¶
type Audio struct {
// Identifier for this file, which can be used to download or reuse the file
FileId string `json:"file_id"`
// 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.
FileUniqueId string `json:"file_unique_id"`
// Duration of the audio in seconds as defined by the sender
Duration int `json:"duration"`
// Optional. Performer of the audio as defined by the sender or by audio tags
Performer *string `json:"performer,omitempty"`
// Optional. Title of the audio as defined by the sender or by audio tags
Title *string `json:"title,omitempty"`
// Optional. Original filename as defined by the sender
FileName *string `json:"file_name,omitempty"`
// Optional. MIME type of the file as defined by the sender
MimeType *string `json:"mime_type,omitempty"`
// 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.
FileSize *int64 `json:"file_size,omitempty"`
// Optional. Thumbnail of the album cover to which the music file belongs
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
}
This object represents an audio file to be treated as music by the Telegram clients.
type BackgroundFill ¶
type BackgroundFill struct {
Type string `json:"type"`
Solid *BackgroundFillSolid
Gradient *BackgroundFillGradient
FreeformGradient *BackgroundFillFreeformGradient
}
This object describes the way a background is filled based on the selected colors. Currently, it can be one of
- BackgroundFillSolid
- BackgroundFillGradient
- BackgroundFillFreeformGradient
func (*BackgroundFill) UnmarshalJSON ¶
func (b *BackgroundFill) UnmarshalJSON(data []byte) error
type BackgroundFillFreeformGradient ¶
type BackgroundFillFreeformGradient struct {
// Type of the background fill, always “freeform_gradient”
Type string `json:"type"`
// A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format
Colors []int `json:"colors"`
}
The background is a freeform gradient that rotates after every message in the chat.
type BackgroundFillGradient ¶
type BackgroundFillGradient struct {
// Type of the background fill, always “gradient”
Type string `json:"type"`
// Top color of the gradient in the RGB24 format
TopColor int `json:"top_color"`
// Bottom color of the gradient in the RGB24 format
BottomColor int `json:"bottom_color"`
// Clockwise rotation angle of the background fill in degrees; 0-359
RotationAngle int `json:"rotation_angle"`
}
The background is a gradient fill.
type BackgroundFillSolid ¶
type BackgroundFillSolid struct {
// Type of the background fill, always “solid”
Type string `json:"type"`
// The color of the background fill in the RGB24 format
Color int `json:"color"`
}
The background is filled using the selected color.
type BackgroundType ¶
type BackgroundType struct {
Type string `json:"type"`
Fill *BackgroundTypeFill
Wallpaper *BackgroundTypeWallpaper
Pattern *BackgroundTypePattern
ChatTheme *BackgroundTypeChatTheme
}
This object describes the type of a background. Currently, it can be one of
BackgroundTypeFill
BackgroundTypeWallpaper
BackgroundTypePattern
BackgroundTypeChatTheme
func (*BackgroundType) UnmarshalJSON ¶
func (b *BackgroundType) UnmarshalJSON(data []byte) error
type BackgroundTypeChatTheme ¶
type BackgroundTypeChatTheme struct {
// Type of the background, always “chat_theme”
Type string `json:"type"`
// Name of the chat theme, which is usually an emoji
ThemeName string `json:"theme_name"`
}
The background is taken directly from a built-in chat theme.
type BackgroundTypeFill ¶
type BackgroundTypeFill struct {
// Type of the background, always “fill”
Type string `json:"type"`
// The background fill
Fill BackgroundFill `json:"fill"`
// Dimming of the background in dark themes, as a percentage; 0-100
DarkThemeDimming int `json:"dark_theme_dimming"`
}
The background is automatically filled based on the selected colors.
type BackgroundTypePattern ¶
type BackgroundTypePattern struct {
// Type of the background, always “pattern”
Type string `json:"type"`
// Document with the pattern
Document Document `json:"document"`
// The background fill that is combined with the pattern
Fill BackgroundFill `json:"fill"`
// Intensity of the pattern when it is shown above the filled background; 0-100
Intensity int `json:"intensity"`
// Optional. True, if the background fill must be applied only to the pattern itself.
// All other pixels are black in this case. For dark themes only
IsInverted *bool `json:"is_inverted,omitempty"`
// Optional. True, if the background moves slightly when the device is tilted
IsMoving *bool `json:"is_moving,omitempty"`
}
The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.
type BackgroundTypeWallpaper ¶
type BackgroundTypeWallpaper struct {
// Type of the background, always “wallpaper”
Type string `json:"type"`
// Document with the wallpaper
Document Document `json:"document"`
// Dimming of the background in dark themes, as a percentage; 0-100
DarkThemeDimming int `json:"dark_theme_dimming"`
// Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12
IsBlurred *bool `json:"is_blurred,omitempty"`
// Optional. True, if the background moves slightly when the device is tilted
IsMoving *bool `json:"is_moving,omitempty"`
}
The background is a wallpaper in the JPEG format.
type BirthDate ¶
type BirthDate struct {
// Day of the user's birth; 1-31
Day int `json:"day"`
// Month of the user's birth; 1-12
Month int `json:"month"`
// Optional. Year of the user's birth
Year *int `json:"year,omitempty"`
}
Describes the birthdate of a user.
type BotCommand ¶
type BotCommand struct {
// Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores.
Command string `json:"command"`
// Description of the command; 1-256 characters.
Description string `json:"description"`
}
This object represents a bot command.
func (BotCommand) Validate ¶
func (b BotCommand) Validate() error
type BotCommandScope ¶
This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:
- -BotCommandScopeDefault
- -BotCommandScopeAllPrivateChats
- -BotCommandScopeAllGroupChats
- -BotCommandScopeAllChatAdministrators
- -BotCommandScopeChat
- -BotCommandScopeChatAdministrators
- -BotCommandScopeChatMember
type BotCommandScopeAllChatAdministrators ¶
type BotCommandScopeAllChatAdministrators struct {
// Scope type, must be all_chat_administrators
Type string `json:"type"`
}
Represents the scope of bot commands, covering all group and supergroup chat administrators.
func (BotCommandScopeAllChatAdministrators) GetBotCommandScopeType ¶
func (b BotCommandScopeAllChatAdministrators) GetBotCommandScopeType() string
func (BotCommandScopeAllChatAdministrators) Validate ¶
func (b BotCommandScopeAllChatAdministrators) Validate() error
type BotCommandScopeAllGroupChats ¶
type BotCommandScopeAllGroupChats struct {
// Scope type, must be all_group_chats
Type string `json:"type"`
}
Represents the scope of bot commands, covering all group and supergroup chats.
func (BotCommandScopeAllGroupChats) GetBotCommandScopeType ¶
func (b BotCommandScopeAllGroupChats) GetBotCommandScopeType() string
func (BotCommandScopeAllGroupChats) Validate ¶
func (b BotCommandScopeAllGroupChats) Validate() error
type BotCommandScopeAllPrivateChats ¶
type BotCommandScopeAllPrivateChats struct {
// Scope type, must be all_private_chats
Type string `json:"type"`
}
Represents the scope of bot commands, covering all private chats.
func (BotCommandScopeAllPrivateChats) GetBotCommandScopeType ¶
func (b BotCommandScopeAllPrivateChats) GetBotCommandScopeType() string
func (BotCommandScopeAllPrivateChats) Validate ¶
func (b BotCommandScopeAllPrivateChats) Validate() error
type BotCommandScopeChat ¶
type BotCommandScopeChat struct {
// Scope type, must be chat
Type string `json:"type"`
// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
ChatId string `json:"chat_id"`
}
Represents the scope of bot commands, covering a specific chat.
func (BotCommandScopeChat) GetBotCommandScopeType ¶
func (b BotCommandScopeChat) GetBotCommandScopeType() string
func (BotCommandScopeChat) Validate ¶
func (b BotCommandScopeChat) Validate() error
type BotCommandScopeChatAdministrators ¶
type BotCommandScopeChatAdministrators struct {
// Scope type, must be chat_administrators
Type string `json:"type"`
// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
ChatId string `json:"chat_id"`
}
Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.
func (BotCommandScopeChatAdministrators) GetBotCommandScopeType ¶
func (b BotCommandScopeChatAdministrators) GetBotCommandScopeType() string
func (BotCommandScopeChatAdministrators) Validate ¶
func (b BotCommandScopeChatAdministrators) Validate() error
type BotCommandScopeChatMember ¶
type BotCommandScopeChatMember struct {
// Scope type, must be chat_member
Type string `json:"type"`
// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
ChatId string `json:"chat_id"`
// Unique identifier of the target user
UserId int `json:"user_id"`
}
Represents the scope of bot commands, covering a specific member of a group or supergroup chat.
func (BotCommandScopeChatMember) GetBotCommandScopeType ¶
func (b BotCommandScopeChatMember) GetBotCommandScopeType() string
func (BotCommandScopeChatMember) Validate ¶
func (b BotCommandScopeChatMember) Validate() error
type BotCommandScopeDefault ¶
type BotCommandScopeDefault struct {
// Scope type, must be default
Type string `json:"type"`
}
Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.
func (BotCommandScopeDefault) GetBotCommandScopeType ¶
func (b BotCommandScopeDefault) GetBotCommandScopeType() string
func (BotCommandScopeDefault) Validate ¶
func (b BotCommandScopeDefault) Validate() error
type BotDescription ¶
type BotDescription struct {
// The bot's description
Description string `json:"description"`
}
This object represents the bot's description.
type BotName ¶
type BotName struct {
// The bot's name
Name string
}
This object represents the bot's name.
type BotShortDescription ¶
type BotShortDescription struct {
// The bot's short description
ShortDescription string `json:"short_description"`
}
This object represents the bot's short description.
type BusinessBotRights ¶ added in v1.2.0
type BusinessBotRights struct {
// Optional. True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours
CanReply *bool `json:"can_reply,omitempty"`
// Optional. True, if the bot can mark incoming private messages as read
CanReadMessages *bool `json:"can_read_messages,omitempty"`
// Optional. True, if the bot can delete messages sent by the bot
CanDeleteOutgoingMessages *bool `json:"can_delete_outgoing_messages,omitempty"`
// Optional. True, if the bot can delete all private messages in managed chats
CanDeleteAllMessages *bool `json:"can_delete_all_messages,omitempty"`
// Optional. True, if the bot can edit the first and last name of the business account
CanEditName *bool `json:"can_edit_name,omitempty"`
// Optional. True, if the bot can edit the bio of the business account
CanEditBio *bool `json:"can_edit_bio,omitempty"`
// Optional. True, if the bot can edit the profile photo of the business account
CanEditProfilePhoto *bool `json:"can_edit_profile_photo,omitempty"`
// Optional. True, if the bot can edit the username of the business account
CanEditUsername *bool `json:"can_edit_username,omitempty"`
// Optional. True, if the bot can change the privacy settings pertaining to gifts for the business account
CanChangeGiftSettings *bool `json:"can_change_gift_settings,omitempty"`
// Optional. True, if the bot can view gifts and the amount of Telegram Stars owned by the business account
CanViewGiftsAndStars *bool `json:"can_view_gifts_and_stars,omitempty"`
// Optional. True, if the bot can convert regular gifts owned by the business account to Telegram Stars
CanConvertGiftsGoStars *bool `json:"can_convert_gifts_go_stars,omitempty"`
// Optional. True, if the bot can transfer and upgrade gifts owned by the business account
CanTransferAndUpgradeGifts *bool `json:"can_transfer_and_upgrade_gifts,omitempty"`
// Optional. True, if the bot can transfer Telegram Stars received by the business account to its own account,
// or use them to upgrade and transfer gifts
CanTransferStars *bool `json:"can_transfer_stars,omitempty"`
// Optional. True, if the bot can post, edit and delete stories on behalf of the business account
CanManageStories *bool `json:"can_manage_stories,omitempty"`
}
Represents the rights of a business bot.
type BusinessConnection ¶
type BusinessConnection struct {
// Unique identifier of the business connection
Id string `json:"id"`
// Business account user that created the business connection
User User `json:"user"`
// Identifier of a private chat with the user who created the business connection.
// 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.
UserChatId int `json:"user_chat_id"`
// Date the connection was established in Unix time
Date int `json:"date"`
// Optional. Rights of the business bot
Rights *BusinessBotRights `json:"rights,omitempty"`
// True, if the connection is active
IsEnabled bool `json:"is_enabled"`
}
Describes the connection of the bot with a business account.
type BusinessIntro ¶
type BusinessIntro struct {
// Optional. Title text of the business intro
Title string `json:"title,omitempty"`
// Optional. Message text of the business intro
Message *string `json:"message,omitempty"`
// Optional. Sticker of the business intro
Sticker *Sticker `json:"sticker,omitempty"`
}
Contains information about the start page settings of a Telegram Business account.
type BusinessLocation ¶
type BusinessLocation struct {
// Address of the business
Address string `json:"address"`
// Optional. Location of the business
Location *Location `json:"location,omitempty"`
}
Contains information about the location of a Telegram Business account.
type BusinessMessagesDeleted ¶
type BusinessMessagesDeleted struct {
// Unique identifier of the business connection
BusinessConnectionId string `json:"business_connection_id"`
// Information about a chat in the business account. The bot may not have access to the chat or the corresponding user.
Chat Chat `json:"chat"`
// The list of identifiers of deleted messages in the chat of the business account
MessageIds []int `json:"message_ids"`
}
/This object is received when messages are deleted from a connected business account.
type BusinessOpeningHours ¶
type BusinessOpeningHours struct {
// Unique name of the time zone for which the opening hours are defined
TimeZone string `json:"time_zone"`
// List of time intervals describing business opening hours
OpeningHours []BusinessOpeningHoursInterval `json:"opening_hours"`
}
Describes the opening hours of a business.
type BusinessOpeningHoursInterval ¶
type BusinessOpeningHoursInterval struct {
// The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 * 24 * 60
OpeningMinute int `json:"opening_minute"`
// The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 * 24 * 60
ClosingMinute int `json:"closing_minute"`
}
Describes an interval of time during which a business is open.
type CallbackGame ¶
type CallbackGame struct{}
A placeholder, currently holds no information. Use BotFather to set up your game.
type CallbackQuery ¶
type CallbackQuery struct {
// Unique identifier for this query
Id string `json:"id"`
// Sender
From User `json:"from"`
// Optional. Message sent by the bot with the callback button that originated the query
Message *MaybeInaccessibleMessage `json:"message,omitempty"`
// Optional. Identifier of the message sent via the bot in inline mode, that originated the query.
InlineMessageId *string `json:"inline_message_id,omitempty"`
// Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent.
// Useful for high scores in games.
ChatInstance string `json:"chat_instance"`
// Optional. Data associated with the callback button.
// Be aware that the message originated the query can contain no callback buttons with this data.
Data *string `json:"data,omitempty"`
// Optional. Short name of a Game to be returned, serves as the unique identifier for the game
GameShortName *string `json:"game_short_name,omitempty"`
}
This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.
IMPORTANT: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters).
type Chat ¶
type Chat struct {
// Unique identifier for this chat. 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 signed 64-bit integer or double-precision float type are safe for storing this identifier.
Id int64 `json:"id"`
// Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
Type string `json:"type"`
// Optional. Title, for supergroups, channels and group chats
Title *string `json:"title,omitempty"`
// Optional. Username, for private chats, supergroups and channels if available
UserName *string `json:"user_name,omitempty"`
// Optional. First name of the other party in a private chat
FirstName *string `json:"first_name,omitempty"`
// Optional. Last name of the other party in a private chat
LastName *string `json:"last_name,omitempty"`
// Optional. True, if the supergroup chat is a forum (has topics enabled)
IsForum *bool `json:"is_forum,omitempty"`
}
This object represents a chat.
type ChatAdministratorRights ¶
type ChatAdministratorRights struct {
// True, if the user's presence in the chat is hidden
IsAnonymous bool `json:"is_anonymous"`
// 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.
CanManageChat bool `json:"can_manage_chat"`
// True, if the administrator can delete messages of other users
CanDeleteMessages bool `json:"can_delete_messages"`
// True, if the administrator can manage video chats
CanManageVideoChats bool `json:"can_manage_video_chats"`
// True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics
CanRestrictMembers bool `json:"can_restrict_members"`
// True, if the administrator can add new administrators with a subset of their own privileges or
// demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)
CanPromoteMembers bool `json:"can_promote_members"`
// True, if the user is allowed to change the chat title, photo and other settings
CanChangeInfo bool `json:"can_change_info"`
// True, if the user is allowed to invite new users to the chat
CanInviteUsers bool `json:"can_invite_users"`
// True, if the administrator can post stories to the chat
CanPostStories bool `json:"can_post_stories"`
// True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive
CanEditStories bool `json:"can_edit_stories"`
// True, if the administrator can delete stories posted by other users
CanDeleteStories bool `json:"can_delete_stories"`
// Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels only
CanPostMessages *bool `json:"can_post_messages,omitempty"`
// Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only
CanEditMessages *bool `json:"can_edit_messages,omitempty"`
// Optional. True, if the user is allowed to pin messages; for groups and supergroups only
CanPinMessages *bool `json:"can_pin_messages,omitempty"`
// Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
CanManageTopics *bool `json:"can_manage_topics,omitempty"`
}
Represents the rights of an administrator in a chat.
type ChatBackground ¶
type ChatBackground struct {
// Type of the background
Type BackgroundType `json:"type"`
}
This object represents a chat background.
type ChatBoost ¶
type ChatBoost struct {
// Unique identifier of the boost
BoostId string `json:"boost_id"`
// Point in time (Unix timestamp) when the chat was boosted
AddDate int `json:"add_date"`
// Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged
ExpirationDate int `json:"expiration_date"`
// Source of the added boost
Source ChatBoostSource `json:"source"`
}
This object contains information about a chat boost.
type ChatBoostAdded ¶
type ChatBoostAdded struct {
BoostCount int `json:"boost_count"`
}
This object represents a service message about a user boosting a chat.
type ChatBoostRemoved ¶
type ChatBoostRemoved struct {
// Chat which was boosted
Chat Chat `json:"chat"`
// Unique identifier of the boost
BoostId string `json:"boost_id"`
// Point in time (Unix timestamp) when the boost was removed
RemoveDate int `json:"remove_date"`
// Source of the removed boost
Source ChatBoostSource `json:"source"`
}
This object represents a boost removed from a chat.
type ChatBoostSource ¶
type ChatBoostSource struct {
Source string `json:"source"`
// FIXME: custom unmarshaling
User *User `json:"user,omitempty"`
GiveawayMessageId *string `json:"giveaway_message_id,omitempty"`
PrizeStarCount *int `json:"prize_star_count,omitempty"`
IsUnclaimed *bool `json:"is_unclaimed,omitempty"`
}
This object describes the source of a chat boost. It can be one of
type ChatBoostSourceGiftCode ¶
type ChatBoostSourceGiftCode struct {
// Source of the boost, always “gift_code”
Source string `json:"source"`
// User for which the gift code was created
User User `json:"user"`
}
The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.
type ChatBoostSourceGiveaway ¶
type ChatBoostSourceGiveaway struct {
// Source of the boost, always “giveaway”
Source string `json:"source"`
// 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.
GiveawayMessageId string `json:"giveaway_message_id"`
// Optional. User that won the prize in the giveaway if any; for Telegram Premium giveaways only
User *User `json:"user,omitempty"`
// Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only
PrizeStarCount *int `json:"prize_star_count,omitempty"`
// Optional. True, if the giveaway was completed, but there was no user to win the prize
IsUnclaimed *bool `json:"is_unclaimed,omitempty"`
}
The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.
type ChatBoostSourcePremium ¶
type ChatBoostSourcePremium struct {
// Source of the boost, always “premium”
Source string `json:"source"`
// User that boosted the chat
User User `json:"user"`
}
The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.
type ChatBoostUpdated ¶
type ChatBoostUpdated struct {
// Chat which was boosted
Chat Chat `json:"chat"`
// Information about the chat boost
Boost ChatBoost `json:"boost"`
}
This object represents a boost added to a chat or changed.
type ChatFullInfo ¶
type ChatFullInfo struct {
// Unique identifier for this chat.
// 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 signed 64-bit integer or double-precision float type are safe for storing this identifier.
Id int64 `json:"id"`
// Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
Type string `json:"type"`
// Optional. Title, for supergroups, channels and group chats
Title *string `json:"title,omitempty,"`
// Optional. Username, for private chats, supergroups and channels if available
UserName *string `json:"user_name,omitempty,"`
// Optional. First name of the other party in a private chat
FirstName *string `json:"first_name,omitempty,"`
// Optional. Last name of the other party in a private chat
LastName *string `json:"last_name,omitempty,"`
// Optional. True, if the supergroup chat is a forum (has topics enabled)
IsForum *bool `json:"is_forum,omitempty,"`
// Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview.
// See https://core.telegram.org/bots/api#accent-colors for more details.
AccentColorId int `json:"accent_color_id"`
// The maximum number of reactions that can be set on a message in the chat
MaxReactionCount int `json:"max_reaction_count"`
// Optional. Chat photo
Photo *ChatPhoto `json:"photo,omitempty,"`
// Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels
ActiveUsernames *[]string `json:"active_usernames,omitempty,"`
// Optional. For private chats, the date of birth of the user
BirthDate *BirthDate `json:"birth_date,omitempty,"`
// Optional. For private chats with business accounts, the intro of the business
BusinessIntro *BusinessIntro `json:"business_intro,omitempty,"`
// Optional. For private chats with business accounts, the location of the business
BusinessLocation *BusinessLocation `json:"business_location,omitempty,"`
// Optional. For private chats with business accounts, the opening hours of the business
BusinessOpeningHours *BusinessOpeningHours `json:"business_opening_hours,omitempty,"`
// Optional. For private chats, the personal channel of the user
PersonalChat *Chat `json:"personal_chat,omitempty,"`
// Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.
AvailableReactions *[]ReactionType `json:"available_reactions,omitempty,"`
// Optional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background
BackgroundCustomEmojiId *string `json:"background_custom_emoji_id,omitempty,"`
// Optional. Identifier of the accent color for the chat's profile background.
// See https://core.telegram.org/bots/api#profile-accent-colors for more details.
ProfileAccentColorId *bool `json:"profile_accent_color_id,omitempty,"`
// Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background
ProfileBackgroundCustomEmojiId *string `json:"profile_background_custom_emoji_id,omitempty,"`
// Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat
EmojiStatusCustomEmojiId *string `json:"emoji_status_custom_emoji_id,omitempty,"`
// Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any
EmojiStatusExpirationDate *bool `json:"emoji_status_expiration_date,omitempty,"`
// Optional. Bio of the other party in a private chat
Bio *string `json:"bio,omitempty,"`
// Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user
HasPrivateForwards *bool `json:"has_private_forwards,omitempty,"`
// Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat
HasRestrictedVoiceAndVideoMessages *bool `json:"has_restricted_voice_and_video_messages,omitempty,"`
// Optional. True, if users need to join the supergroup before they can send messages
JoinToSendMessages *bool `json:"join_to_send_messages,omitempty,"`
// Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators
JoinByRequest *bool `json:"join_by_request,omitempty,"`
// Optional. Description, for groups, supergroups and channel chats
Description *string `json:"description,omitempty,"`
// Optional. Primary invite link, for groups, supergroups and channel chats
InviteLink *string `json:"invite_link,omitempty,"`
// Optional. The most recent pinned message (by sending date)
PinnedMessage *Message `json:"pinned_message,omitempty,"`
// Optional. Default chat member permissions, for groups and supergroups
Permissions *ChatPermissions `json:"permissions,omitempty,"`
// Information about types of gifts that are accepted by the chat or by the corresponding user for private chats
AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"`
// Optional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.
CanSendPaidMedia *bool `json:"can_send_paid_media,omitempty,"`
// Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds
SlowModeDelay *int `json:"slow_mode_delay,omitempty,"`
// 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
UnrestrictBoostCount *int `json:"unrestrict_boost_count,omitempty,"`
// Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds
MessageAutoDeleteTime *int `json:"message_auto_delete_time,omitempty,"`
// Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.
HasAggressiveAntiSpamEnabled *string `json:"has_aggressive_anti_spam_enabled,omitempty,"`
// Optional. True, if non-administrators can only get the list of bots and administrators in the chat
HasHiddenMembers *bool `json:"has_hidden_members,omitempty,"`
// Optional. True, if messages from the chat can't be forwarded to other chats
HasProtectedCount *bool `json:"has_protected_count,omitempty,"`
// Optional. True, if new chat members will have access to old messages; available only to chat administrators
HasVisibleHistory *bool `json:"has_visible_history,omitempty,"`
// Optional. For supergroups, name of the group sticker set
StickerSetName *string `json:"sticker_set_name,omitempty,"`
// Optional. True, if the bot can change the group sticker set
CanSetStickerSet *bool `json:"can_set_sticker_set,omitempty,"`
// 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.
CustomEmojiStickerSetName *string `json:"custom_emoji_sticker_set_name,omitempty,"`
// 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.
LinkedChatId *int64 `json:"linked_chat_id,omitempty,"`
// Optional. For supergroups, the location to which the supergroup is connected
Location *ChatLocation `json:"location,omitempty,"`
}
This object contains full information about a chat.
type ChatInviteLink ¶
type ChatInviteLink struct {
// The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”.
InviteLink string `json:"invite_link"`
// Creator of the link
Creator User `json:"creator"`
// True, if users joining the chat via the link need to be approved by chat administrators
CreatesJoinRequest bool `json:"creates_join_request"`
// True, if the link is primary
IsPrimary bool `json:"is_primary"`
// True, if the link is revoked
IsRevoked bool `json:"is_revoked"`
// Optional. Invite link name
Name *string `json:"name,omitempty"`
// Optional. Point in time (Unix timestamp) when the link will expire or has been expired
ExpireDate *int `json:"expire_date,omitempty"`
// Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
MemberLimit *bool `json:"member_limit,omitempty"`
// Optional. Number of pending join requests created using this link
PendingJoinRequestCount *int `json:"pending_join_request_count,omitempty"`
// Optional. The number of seconds the subscription will be active for before the next payment
SubscriptionPeriod *int `json:"subscription_period,omitempty"`
// Optional. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link
SubscriptionPrice *int `json:"subscription_price,omitempty"`
}
Represents an invite link for a chat.
type ChatJoinRequest ¶
type ChatJoinRequest struct {
// Chat to which the request was sent
Chat Chat `json:"chat"`
// User that sent the join request
User User `json:"user"`
// 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.
// The bot can use this identifier for 5 minutes to send messages until the join request is processed,
// assuming no other administrator contacted the user.
UserChatId int64 `json:"user_chat_id"`
// Date the request was sent in Unix time
Date int `json:"date"`
// Optional. Bio of the user.
Bio *string `json:"bio,omitempty"`
// Optional. Chat invite link that was used by the user to send the join request
InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
}
Represents a join request sent to a chat.
type ChatLocation ¶
type ChatLocation struct {
// The location to which the supergroup is connected. Can't be a live location.
Location Location `json:"location"`
// Location address; 1-64 characters, as defined by the chat owner
Address string `json:"address"`
}
Represents a location to which a chat is connected.
type ChatMember ¶
type ChatMember struct {
Status string `json:"status"`
Owner *ChatMemberOwner
Administrator *ChatMemberAdministrator
Member *ChatMemberMember
Restricted *ChatMemberRestricted
Left *ChatMemberLeft
Banned *ChatMemberBanned
}
This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:
- ChatMemberOwner
- ChatMemberAdministrator
- ChatMemberMember
- ChatMemberRestricted
- ChatMemberLeft
- ChatMemberBanned
func (*ChatMember) UnmarshalJSON ¶
func (c *ChatMember) UnmarshalJSON(data []byte) error
type ChatMemberAdministrator ¶
type ChatMemberAdministrator struct {
// The member's status in the chat, always “administrator”
Status string `json:"status"`
// Information about the user
User User `json:"user"`
// True, if the bot is allowed to edit administrator privileges of that user
CanBeEdited bool `json:"can_be_edited"`
// True, if the user's presence in the chat is hidden
IsAnonymous bool `json:"is_anonymous"`
// 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.
CanManageChat bool `json:"can_manage_chat"`
// True, if the administrator can delete messages of other users
CanDeleteMessages bool `json:"can_delete_messages"`
// True, if the administrator can manage video chats
CanManageVideoChats bool `json:"can_manage_video_chats"`
// True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics
CanRestrictMembers bool `json:"can_restrict_members"`
// True, if the administrator can add new administrators with a subset of their own privileges or
// demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)
CanPromoteMembers bool `json:"can_promote_members"`
// True, if the user is allowed to change the chat title, photo and other settings
CanChangeInfo bool `json:"can_change_info"`
// True, if the user is allowed to invite new users to the chat
CanInviteUsers bool `json:"can_invite_users"`
// True, if the administrator can post stories to the chat
CanPostStories bool `json:"can_post_stories"`
// True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive
CanEditStories bool `json:"can_edit_stories"`
// True, if the administrator can delete stories posted by other users
CanDeleteStories bool `json:"can_delete_stories"`
// Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels only
CanPostMessages *bool `json:"can_post_messages,omitempty"`
// Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only
CanEditMessages *bool `json:"can_edit_messages,omitempty"`
// Optional. True, if the user is allowed to pin messages; for groups and supergroups only
CanPinMessages *bool `json:"can_pin_messages,omitempty"`
// Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
CanManageTopics *bool `json:"can_manage_topics,omitempty"`
// Optional. Custom title for this user
CustomTitle *string `json:"custom_title,omitempty"`
}
Represents a chat member that has some additional privileges.
type ChatMemberBanned ¶
type ChatMemberBanned struct {
// The member's status in the chat, always “kicked”
Status string `json:"status"`
// Information about the user
User User `json:"user"`
// Date when restrictions will be lifted for this user; Unix time. If 0, then the user is banned forever
UntilDate int `json:"until_date"`
}
Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.
type ChatMemberLeft ¶
type ChatMemberLeft struct {
// The member's status in the chat, always “left”
Status string `json:"status"`
// Information about the user
User *User `json:"user"`
}
Represents a chat member that isn't currently a member of the chat, but may join it themselves.
type ChatMemberMember ¶
type ChatMemberMember struct {
// The member's status in the chat, always “member”
Status string `json:"status"`
// Information about the user
User User `json:"user"`
// Optional. Date when the user's subscription will expire; Unix time
UntilDate *int `json:"until_date,omitempty"`
}
Represents a chat member that has no additional privileges or restrictions.
type ChatMemberOwner ¶
type ChatMemberOwner struct {
// The member's status in the chat, always “creator”
Status string `json:"status"`
// Information about the user
User User `json:"user"`
// True, if the user's presence in the chat is hidden
IsAnonymous bool `json:"is_anonymous"`
// Optional. Custom title for this user
CustomTitle *string `json:"custom_title,omitempty"`
}
Represents a chat member that owns the chat and has all administrator privileges.
type ChatMemberRestricted ¶
type ChatMemberRestricted struct {
// The member's status in the chat, always “restricted”
Status string `json:"status"`
// Information about the user
User *User `json:"user"`
// True, if the user is a member of the chat at the moment of the request
IsMember bool `json:"is_member"`
// True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues
CanSendMessages bool `json:"can_send_messages"`
// True, if the user is allowed to send audios
CanSendAudios bool `json:"can_send_audios"`
// True, if the user is allowed to send documents
CanSendDocuments bool `json:"can_send_documents"`
// True, if the user is allowed to send photos
CanSendPhotos bool `json:"can_send_photos"`
// True, if the user is allowed to send videos
CanSendVideos bool `json:"can_send_videos"`
// True, if the user is allowed to send video notes
CanSendVideoNotes bool `json:"can_send_video_notes"`
// True, if the user is allowed to send voice notes
CanSendVoiceNotes bool `json:"can_send_voice_notes"`
// True, if the user is allowed to send polls
CanSendPolls bool `json:"can_send_polls"`
// True, if the user is allowed to send animations, games, stickers and use inline bots
CanSendOtherMessages bool `json:"can_send_other_messages"`
// True, if the user is allowed to add web page previews to their messages
CanAddWebpagePreviews bool `json:"can_add_webpage_previews"`
// True, if the user is allowed to change the chat title, photo and other settings
CanChangeInfo bool `json:"can_change_info"`
// True, if the user is allowed to invite new users to the chat
CanInviteUsers bool `json:"can_invite_users"`
// True, if the user is allowed to pin messages
CanPinMessages bool `json:"can_pin_messages"`
// True, if the user is allowed to create forum topics
CanManageTopics bool `json:"can_manage_topics"`
// Date when restrictions will be lifted for this user; Unix time. If 0, then the user is restricted forever
UntilDate int `json:"until_date"`
}
Represents a chat member that is under certain restrictions in the chat. Supergroups only.
type ChatMemberUpdated ¶
type ChatMemberUpdated struct {
// Chat the user belongs to
Chat Chat `json:"chat"`
// Performer of the action, which resulted in the change
From User `json:"from"`
// Date the change was done in Unix time
Date int `json:"date"`
// Previous information about the chat member
OldChatMember ChatMember `json:"old_chat_member"`
// New information about the chat member
NewChatMember ChatMember `json:"new_chat_member"`
// Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.
InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
// Optional. True, if the user joined the chat after sending a direct join request without using
// an invite link and being approved by an administrator
ViaJoinRequest *bool `json:"via_join_request,omitempty"`
// Optional. True, if the user joined the chat via a chat folder invite link
ViaChatFolderInviteLink *bool `json:"via_chat_folder_invite_link,omitempty"`
}
This object represents changes in the status of a chat member.
type ChatPermissions ¶
type ChatPermissions struct {
// True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues
CanSendMessages *bool `json:"can_send_messages,omitempty"`
// True, if the user is allowed to send audios
CanSendAudios *bool `json:"can_send_audios,omitempty"`
// True, if the user is allowed to send documents
CanSendDocuments *bool `json:"can_send_documents,omitempty"`
// True, if the user is allowed to send photos
CanSendPhotos *bool `json:"can_send_photos,omitempty"`
// True, if the user is allowed to send videos
CanSendVideos *bool `json:"can_send_videos,omitempty"`
// True, if the user is allowed to send video notes
CanSendVideoNotes *bool `json:"can_send_video_notes,omitempty"`
// True, if the user is allowed to send voice notes
CanSendVoiceNotes *bool `json:"can_send_voice_notes,omitempty"`
// True, if the user is allowed to send polls
CanSendPolls *bool `json:"can_send_polls,omitempty"`
// True, if the user is allowed to send animations, games, stickers and use inline bots
CanSendOtherMessages *bool `json:"can_send_other_messages,omitempty"`
// True, if the user is allowed to add web page previews to their messages
CanAddWebpagePreviews *bool `json:"can_add_webpage_previews,omitempty"`
// True, if the user is allowed to change the chat title, photo and other settings
CanChangeInfo *bool `json:"can_change_info,omitempty"`
// True, if the user is allowed to invite new users to the chat
CanInviteUsers *bool `json:"can_invite_users,omitempty"`
// True, if the user is allowed to pin messages
CanPinMessages *bool `json:"can_pin_messages,omitempty"`
// True, if the user is allowed to create forum topics
CanManageTopics *bool `json:"can_manage_topics,omitempty"`
}
Describes actions that a non-administrator user is allowed to take in a chat.
type ChatPhoto ¶
type ChatPhoto struct {
// 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.
SmallFileId string `json:"small_file_id"`
// 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.
SmallFileUniqueId string `json:"small_file_unique_id"`
// 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.
BigFileId string `json:"big_file_id"`
// 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.
BigFileUniqueId string `json:"big_file_unique_id"`
}
This object represents a chat photo.
type ChatShared ¶
type ChatShared struct {
RequestId string `json:"request_id"`
// 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.
// The bot may not have access to the chat and could be unable to use this identifier,
// unless the chat is already known to the bot by some other means.
ChatId int64 `json:"chat_id"`
Title *string `json:"title,omitempty"`
Username *string `json:"username,omitempty"`
Photo *[]PhotoSize `json:"photo,omitempty"`
}
This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.
type ChosenInlineResult ¶
type ChosenInlineResult struct {
// The unique identifier for the result that was chosen
ResultId string `json:"result_id"`
// The user that chose the result
From User `json:"from"`
// Optional. Sender location, only for bots that require user location
Location *Location `json:"location,omitempty"`
// 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.
InlineMessageId *string `json:"inline_message_id,omitempty"`
// The query that was used to obtain the result
Query string `json:"query"`
}
Represents a result of an inline query that was chosen by the user and sent to their chat partner.
Note: It is necessary to enable inline feedback via @BotFather in order to receive these objects in updates.
type Contact ¶
type Contact struct {
// Contact's phone number
PhoneNumber string `json:"phone_number"`
// Contact's first name
FirstName string `json:"first_name"`
// Optional. Contact's last name
LastName *string `json:"last_name,omitempty"`
// Optional. Contact's user identifier in Telegram.
// 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.
UserId *int64 `json:"user_id,omitempty"`
// Optional. Additional data about the contact in the form of a vCard
VCard *string `json:"v_card,omitempty"`
}
This object represents a phone contact.
type CopyTextButton ¶
type CopyTextButton struct {
// The text to be copied to the clipboard; 1-256 characters
Text string
}
This object represents an inline keyboard button that copies specified text to the clipboard.
func (CopyTextButton) Validate ¶
func (c CopyTextButton) Validate() error
type Dice ¶
type Dice struct {
// Value of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀” and “⚽” base emoji, 1-64 for “🎰” base emoji
Value int `json:"value"`
// Emoji on which the dice throw animation is based
Emoji string `json:"emoji"`
}
This object represents an animated emoji that displays a random value.
type Document ¶
type Document struct {
// Identifier for this file, which can be used to download or reuse the file
FileId string `json:"file_id"`
// 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.
FileUniqueId string `json:"file_unique_id"`
// Optional. Document thumbnail as defined by the sender
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
// Optional. Original filename as defined by the sender
FileName *string `json:"file_name,omitempty"`
// Optional. MIME type of the file as defined by the sender
MimeType *string `json:"mime_type,omitempty"`
// 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.
FileSize *int64 `json:"file_size,omitempty"`
}
This object represents a general file (as opposed to photos, voice messages and audio files).
type EncryptedCredentials ¶
type EncryptedCredentials struct {
// Base64-encoded encrypted JSON-serialized data with unique user's payload,
// data hashes and secrets required for EncryptedPassportElement decryption and authentication
Data string `json:"data"`
// Base64-encoded data hash for data authentication
Hash string `json:"hash"`
// Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption
Secret string `json:"secret"`
}
Describes data required for decrypting and authenticating EncryptedPassportElement. See https://core.telegram.org/passport#receiving-information for a complete description of the data decryption and authentication processes.
type EncryptedPassportElement ¶
type EncryptedPassportElement struct {
//Element 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”.
Type string `json:"type"`
//Optional. Base64-encoded encrypted Telegram Passport element data provided by the user;
//available only for “personal_details”, “passport”, “driver_license”,
//“identity_card”, “internal_passport” and “address” types.
//Can be decrypted and verified using the accompanying EncryptedCredentials.
Data *string `json:"data,omitempty"`
// Optional. User's verified phone number; available only for “phone_number” type
PhoneNumber *string `json:"phone_number,omitempty"`
// Optional. User's verified email address; available only for “email” type
Email *string `json:"email,omitempty"`
//Optional. Array of encrypted files with documents provided by the user;
//available only for “utility_bill”, “bank_statement”, “rental_agreement”,
//“passport_registration” and “temporary_registration” types.
//Files can be decrypted and verified using the accompanying EncryptedCredentials.
Files *[]PassportFile `json:"files,omitempty"`
// Optional. Encrypted file with the front side of the document, provided by the user;
// available only for “passport”, “driver_license”, “identity_card” and “internal_passport”.
// The file can be decrypted and verified using the accompanying EncryptedCredentials.
FrontSide *PassportFile `json:"front_side,omitempty"`
// Optional. Encrypted file with the reverse side of the document, provided by the user;
// available only for “driver_license” and “identity_card”.
// The file can be decrypted and verified using the accompanying EncryptedCredentials.
ReverseSide *PassportFile `json:"reverse_side,omitempty"`
// Optional. Encrypted file with the selfie of the user holding a document, provided by the user;
// available if requested for “passport”, “driver_license”, “identity_card” and “internal_passport”.
// The file can be decrypted and verified using the accompanying EncryptedCredentials.
Selfie *PassportFile `json:"selfie,omitempty"`
//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.
Translations *[]PassportFile `json:"translations,omitempty"`
// Base64-encoded element hash for using in PassportElementErrorUnspecified
Hash string `json:"hash"`
}
Describes documents or other Telegram Passport elements shared with the bot by the user.
type ExternalReplyInfo ¶
type ExternalReplyInfo struct {
// Origin of the message replied to by the given message
Origin MessageOrigin `json:"origin"`
// Optional. Chat the original message belongs to. Available only if the chat is a supergroup or a channel.
Chat *Chat `json:"chat,omitempty"`
// Optional. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel.
MessageId *int `json:"message_id,omitempty"`
// Optional. Options used for link preview generation for the original message, if it is a text message
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
// Optional. Message is an animation, information about the animation
Animation *Animation `json:"animation,omitempty"`
// Optional. Message is an audio file, information about the file
Audio *Audio `json:"audio,omitempty"`
// Optional. Message is a general file, information about the file
Document *Document `json:"document,omitempty"`
// Optional. Message contains paid media; information about the paid media
PaidMedia *PaidMediaInfo `json:"paid_media,omitempty"`
// Optional. Message is a photo, available sizes of the photo
Photo *[]PhotoSize `json:"photo,omitempty"`
// Optional. Message is a sticker, information about the sticker
Sticker *Sticker `json:"sticker,omitempty"`
// Optional. Message is a forwarded story
Story *Story `json:"story,omitempty"`
// Optional. Message is a video, information about the video
Video *Video `json:"video,omitempty"`
// Optional. Message is a video note, information about the video message
VideoNote *VideoNote `json:"video_note,omitempty"`
// Optional. Message is a voice message, information about the file
Voice *Voice `json:"voice,omitempty"`
// Optional. True, if the message media is covered by a spoiler animation
HasMediaSpoiler *bool `json:"has_media_spoiler,omitempty"`
// Optional. Message is a shared contact, information about the contact
Contact *Contact `json:"contact,omitempty"`
// Optional. Message is a dice with random value
Dice *Dice `json:"dice,omitempty"`
// Optional. Message is a game, information about the game.
// More about games » https://core.telegram.org/bots/api#games
Game *Game `json:"game,omitempty"`
// Optional. Message is a scheduled giveaway, information about the giveaway
Giveaway *Giveaway `json:"giveaway,omitempty"`
// Optional. A giveaway with public winners was completed
GiveawayWinners *GiveawayWinners `json:"giveaway_winners,omitempty"`
// Optional. Message is an invoice for a payment, information about the invoice.
// More about payments » https://core.telegram.org/bots/api#payments
Invoice *Invoice `json:"invoice,omitempty"`
// Optional. Message is a shared location, information about the location
Location *Location `json:"location"`
// Optional. Message is a native poll, information about the poll
Poll *Poll `json:"poll,omitempty"`
// Optional. Message is a venue, information about the venue
Venue *Venue `json:"venue,omitempty"`
}
This object contains information about a message that is being replied to, which may come from another chat or forum topic.
type File ¶
type File struct {
// Identifier for this file, which can be used to download or reuse the file
FileId string `json:"file_id"`
// 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.
FileUniqueId string `json:"file_unique_id"`
// 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.
FileSize *int64 `json:"file_size,omitempty"`
// Optional. File path. Use https://gotely.telegram.org/file/bot<token>/<file_path> to get the file.
FilePath *string `json:"file_path,omitempty"`
}
This object represents a file ready to be downloaded. The file can be downloaded via the link https://gotely.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile.
type ForceReply ¶
type ForceReply struct {
// Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'
ForceReply bool `json:"force_reply"`
// Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters
InputFieldPlaceholder *string `json:"input_field_placeholder,omitempty"`
//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 to a message in the same chat and forum topic, sender of the original message.
Selective *bool `json:"selective,omitempty"`
}
Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account.
Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:
- Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.
- Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.
The last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.
func (ForceReply) Validate ¶
func (f ForceReply) Validate() error
type ForumTopic ¶
type ForumTopic struct {
// Unique identifier of the forum topic
MessageThreadId int `json:"message_thread_id"`
// Name of the topic
Name string `json:"name"`
// Color of the topic icon in RGB format
IconColor int `json:"icon_color"`
// Optional. Unique identifier of the custom emoji shown as the topic icon
IconCustomEmojiId string `json:"icon_custom_emoji_id"`
}
This object represents a forum topic.
type ForumTopicClosed ¶
type ForumTopicClosed struct{}
This object represents a service message about a forum topic closed in the chat. Currently holds no information.
type ForumTopicCreated ¶
type ForumTopicCreated struct {
// Name of the topic
Name string `json:"name"`
// Color of the topic icon in RGB format
IconColor int `json:"icon_color"`
// Optional. Unique identifier of the custom emoji shown as the topic icon
IconCustomEmojiId *string `json:"icon_custom_emoji_id,omitempty"`
}
This object represents a service message about a new forum topic created in the chat.
type ForumTopicEdited ¶
type ForumTopicEdited struct {
// Optional. New name of the topic, if it was edited
Name *string `json:"name,omitempty"`
// Optional. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed
IconCustomEmojiId *string `json:"icon_custom_emoji_id,omitempty"`
}
This object represents a service message about an edited forum topic.
type ForumTopicReopened ¶
type ForumTopicReopened struct{}
This object represents a service message about a forum topic reopened in the chat. Currently holds no information.
type Game ¶
type Game struct {
// Title of the game
Title string `json:"title"`
// Description of the game
Description string `json:"description"`
// Photo that will be displayed in the game message in chats.
Photo []PhotoSize `json:"photo"`
// 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.
Text *string `json:"text,omitempty"`
// Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
TextEntities *[]MessageEntity `json:"text_entities,omitempty"`
// Optional. Animation that will be displayed in the game message in chats. Upload via BotFather
Animation *Animation `json:"animation,omitempty"`
}
This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
type GameHighScore ¶
type GameHighScore struct {
// Position in high score table for the game
Position int `json:"position"`
// User
User User `json:"user"`
// Score
Score int `json:"score"`
}
This object represents one row of the high scores table for a game.
type GeneralForumTopicHidden ¶
type GeneralForumTopicHidden struct{}
This object represents a service message about General forum topic hidden in the chat. Currently holds no information.
type GeneralForumTopicUnhidden ¶
type GeneralForumTopicUnhidden struct{}
This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.
type Gift ¶
type Gift struct {
// Unique identifier of the gift
Id string `json:"id"`
// The sticker that represents the gift
Sticker Sticker `json:"sticker"`
// The number of Telegram Stars that must be paid to send the sticker
StarCount int `json:"star_count"`
// Optional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one
UpgradeStarCount *int `json:"upgrade_star_count,omitempty"`
// Optional. The total number of the gifts of this type that can be sent; for limited gifts only
TotalCount *int `json:"total_count,omitempty,"`
// Optional. The number of remaining gifts of this type that can be sent; for limited gifts only
RemainingCount *int `json:"remaining_count,omitempty,"`
}
This object represents a gift that can be sent by the bot.
type GiftInfo ¶ added in v1.2.0
type GiftInfo struct {
// Information about the gift
Gift Gift `json:"gift"`
// Optional. Unique identifier of the received gift for the bot;
// only present for gifts received on behalf of business accounts
OwnedGiftId *string `json:"owned_gift_id,omitempty"`
// Optional. Number of Telegram Stars that can be claimed by the receiver by converting the gift;
// omitted if conversion to Telegram Stars is impossible
ConvertStarCount *int `json:"convert_star_count,omitempty"`
// Optional. Number of Telegram Stars that were prepaid by the sender for the ability to upgrade the gift
PrepaidUpgradeStarCount *int `json:"prepaid_upgrade_star_count,omitempty"`
// Optional. True, if the gift can be upgraded to a unique gift
CanBeUpgraded *bool `json:"can_be_upgraded,omitempty"`
// Optional. Text of the message that was added to the gift
Text *string `json:"text,omitempty"`
// Optional. Special entities that appear in the text
Entities *[]MessageEntity `json:"entities,omitempty"`
// Optional. True, if the sender and gift text are shown only to the gift receiver;
// otherwise, everyone will be able to see them
IsPrivate *bool `json:"is_private,omitempty"`
}
Describes a service message about a regular gift that was sent or received.
type Gifts ¶
type Gifts struct {
// The list of gifts
Gifts []Gift `json:"gifts"`
}
This object represent a list of gifts.
type Giveaway ¶
type Giveaway struct {
// The list of chats which the user must join to participate in the giveaway
Chats []Chat `json:"chats"`
// Point in time (Unix timestamp) when winners of the giveaway will be selected
WinnerSelectionDate int `json:"winner_selection_date"`
// The number of users which are supposed to be selected as winners of the giveaway
WinnerCount int `json:"winner_count"`
// Optional. True, if only users who join the chats after the giveaway started should be eligible to win
OnlyNewMembers *bool `json:"only_new_members,omitempty"`
// Optional. True, if the list of giveaway winners will be visible to everyone
HasPublicWinners *bool `json:"has_public_winners,omitempty"`
// /Optional. Description of additional giveaway prize
PrizeDescription *string `json:"prize_description,omitempty"`
// 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.
CountryCodes *[]string `json:"country_codes,omitempty"`
// Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only
PrizeStarCount *int `json:"prize_star_count,omitempty"`
// Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for;
// for Telegram Premium giveaways only
PremiumSubscriptionMonthCount *int `json:"premium_subscription_month_count,omitempty"`
}
This object represents a message about a scheduled giveaway.
type GiveawayCompleted ¶
type GiveawayCompleted struct {
// Number of winners in the giveaway
WinnerCount int `json:"winner_count"`
// Optional. Number of undistributed prizes
UnclaimedPrizeCount *int `json:"unclaimed_prize_count,omitempty"`
// Optional. Message with the giveaway that was completed, if it wasn't deleted
GiveawayMessage *Message `json:"giveaway_message,omitempty"`
// Optional. True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway.
IsStarGiveaway *bool `json:"is_star_giveaway,omitempty"`
}
This object represents a service message about the completion of a giveaway without public winners.
type GiveawayCreated ¶
type GiveawayCreated struct {
PrizeStarCount *int `json:"prize_star_count,omitempty"`
}
This object represents a service message about the creation of a scheduled giveaway.
type GiveawayWinners ¶
type GiveawayWinners struct {
// The chat that created the giveaway
Chat Chat `json:"chat"`
// Identifier of the message with the giveaway in the chat
GiveawayMessageId int `json:"giveaway_message_id"`
// Point in time (Unix timestamp) when winners of the giveaway were selected
WinnersSelectionDate int `json:"winners_selection_date"`
// Total number of winners in the giveaway
WinnerCount int `json:"winner_count"`
// List of up to 100 winners of the giveaway
Winners []User `json:"winners"`
// Optional. The number of other chats the user had to join in order to be eligible for the giveaway
AdditionalChatCount *int `json:"additional_chat_count,omitempty"`
// Optional. The number of Telegram Stars that were split between giveaway winners;
// for Telegram Star giveaways only
PrizeStarCount *int `json:"prize_star_count,omitempty"`
// Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for;
// for Telegram Premium giveaways only
PremiumSubscriptionMonthCount *int `json:"premium_subscription_month_count,omitempty"`
// Optional. Number of undistributed prizes
UnclaimedPrizeCount *int `json:"unclaimed_prize_count,omitempty"`
// Optional. True, if only users who had joined the chats after the giveaway started were eligible to win
OnlyNewMembers *bool `json:"only_new_members,omitempty"`
// Optional. True, if the giveaway was canceled because the payment for it was refunded
WasRefunded *bool `json:"was_refunded,omitempty"`
// Optional. Description of additional giveaway prize
PrizeDescription *string `json:"prize_description,omitempty"`
}
This object represents a message about the completion of a giveaway with public winners.
type InaccessibleMessage ¶
type InaccessibleMessage struct {
// Chat the message belonged to
Chat Chat `json:"chat"`
// Unique message identifier inside the chat
MessageId int `json:"message_id"`
// Always 0. The field can be used to differentiate regular and inaccessible messages.
Date int `json:"date"`
}
This object describes a message that was deleted or is otherwise inaccessible to the bot.
type InlineKeyboardButton ¶
type InlineKeyboardButton struct {
// Label text on the button
Text string `json:"text"`
// Optional. HTTP or tg:// URL to be opened when the button is pressed.
// Links tg://user?id=<user_id> can be used to mention a user by their identifier without using a username,
// if this is allowed by their privacy settings.
Url *string `json:"url,omitempty"`
// Optional. Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes
CallbackData *string `json:"callback_data,omitempty"`
// 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 a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.
WebApp *WebAppInfo `json:"web_app,omitempty"`
// Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.
LoginUrl *LoginUrl `json:"login_url,omitempty"`
// 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.
// May be empty, in which case just the bot's username will be inserted.
// Not supported for messages sent on behalf of a Telegram Business account.
SwitchInlineQuery *string `json:"switch_inline_query,omitempty"`
//Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field.
//May be empty, in which case only the bot's username will be inserted.
//
//This offers a quick way for the user to open your bot in inline mode in the same chat -
//good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.
SwitchInlineQueryCurrentChat *string `json:"switch_inline_query_current_chat,omitempty"`
// 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.
// Not supported for messages sent on behalf of a Telegram Business account.
SwitchInlineQueryChosenChat *SwitchInlineQueryChosenChat `json:"switch_inline_query_chosen_chat,omitempty"`
// Optional. Description of the button that copies the specified text to the clipboard.
CopyText *CopyTextButton `json:"copy_text,omitempty"`
// Optional. Description of the game that will be launched when the user presses the button.
//
//IMPORTANT: This type of button must always be the first button in the first row.
CallbackGame *CallbackGame `json:"callback_game,omitempty"`
//Optional. Specify True, to send a Pay button. Substrings “⭐” and “XTR” in the buttons's text will be replaced with a Telegram Star icon.
//
//IMPORTANT: This type of button must always be the first button in the first row and can only be used in invoice messages.
Pay *bool `json:"pay,omitempty"`
}
This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.
func (InlineKeyboardButton) Validate ¶
func (b InlineKeyboardButton) Validate() error
type InlineKeyboardMarkup ¶
type InlineKeyboardMarkup struct {
// Array of button rows, each represented by an Array of InlineKeyboardButton objects
Keyboard [][]InlineKeyboardButton `json:"keyboard"`
}
This object represents an inline keyboard that appears right next to the message it belongs to.
func (InlineKeyboardMarkup) Validate ¶
func (m InlineKeyboardMarkup) Validate() error
type InlineQuery ¶
type InlineQuery struct {
// Unique identifier for this query
Id string `json:"id"`
// Sender
From User `json:"from"`
// Text of the query (up to 256 characters)
Query string `json:"query"`
// Offset of the results to be returned, can be controlled by the bot
Offset string `json:"offset"`
// 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
ChatType *string `json:"chat_type,omitempty"`
// Optional. Sender location, only for bots that request user location
Location *Location `json:"location,omitempty"`
}
This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
type InlineQueryResult ¶
This object represents one result of an inline query. Telegram clients currently support results of the following 20 types
- InlineQueryResultCachedAudio
- InlineQueryResultCachedDocument
- InlineQueryResultCachedGif
- InlineQueryResultCachedMpeg4Gif
- InlineQueryResultCachedPhoto
- InlineQueryResultCachedSticker
- InlineQueryResultCachedVideo
- InlineQueryResultCachedVoice
- InlineQueryResultArticle
- InlineQueryResultAudio
- InlineQueryResultContact
- InlineQueryResultGame
- InlineQueryResultDocument
- InlineQueryResultGif
- InlineQueryResultLocation
- InlineQueryResultMpeg4Gif
- InlineQueryResultPhoto
- InlineQueryResultVenue
- InlineQueryResultVideo
- InlineQueryResultVoice
Note: All URLs passed in inline query results will be available to end users and therefore must be assumed to be public.
type InlineQueryResultArticle ¶
type InlineQueryResultArticle struct {
// Type of the result, must be article
Type string `json:"type"`
// Unique identifier for this result, 1-64 Bytes
Id string `json:"id"`
// Title of the result
Title string `json:"title"`
// Content of the message to be sent
InputMessageContent InputMessageContent `json:"input_message_content"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. URL of the result
Url *string `json:"url,omitempty"`
// Optional. Pass True if you don't want the URL to be shown in the message
HideUrl *bool `json:"hide_url,omitempty"`
// Optional. Short description of the result
Description *string `json:"description,omitempty"`
// Optional. Url of the thumbnail for the result
ThumbnailUrl *string `json:"thumbnail_url,omitempty"`
// Optional. Thumbnail width
ThumbnailWidth *int `json:"thumbnail_width,omitempty"`
// Optional. Thumbnail height
ThumbnailHeight *int `json:"thumbnail_height,omitempty"`
}
Represents a link to an article or web page.
func (InlineQueryResultArticle) GetInlineQueryResultType ¶
func (i InlineQueryResultArticle) GetInlineQueryResultType() string
func (InlineQueryResultArticle) Validate ¶
func (i InlineQueryResultArticle) Validate() error
type InlineQueryResultAudio ¶
type InlineQueryResultAudio struct {
// Type of the result, must be audio
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// A valid URL for the audio file
AudioUrl string `json:"audio_url"`
// Title
Title string `json:"title"`
// Optional. Caption, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the audio caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. Performer
Performer *string `json:"performer,omitempty"`
// Optional. Audio duration in seconds
AudioDuration *int `json:"audio_duration,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the audio
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
func (InlineQueryResultAudio) GetInlineQueryResultType ¶
func (i InlineQueryResultAudio) GetInlineQueryResultType() string
func (InlineQueryResultAudio) Validate ¶
func (i InlineQueryResultAudio) Validate() error
type InlineQueryResultCachedAudio ¶
type InlineQueryResultCachedAudio struct {
// Type of the result, must be audio
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// A valid file identifier for the audio file
AudioFileId string `json:"audio_file_id"`
// Optional. Caption, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the audio caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the audio
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
func (InlineQueryResultCachedAudio) GetInlineQueryResultType ¶
func (i InlineQueryResultCachedAudio) GetInlineQueryResultType() string
func (InlineQueryResultCachedAudio) Validate ¶
func (i InlineQueryResultCachedAudio) Validate() error
type InlineQueryResultCachedDocument ¶
type InlineQueryResultCachedDocument struct {
// Type of the result, must be document
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// Title for the result
Title string `json:"title"`
// A valid file identifier for the file
DocumentFileId string `json:"document_file_id"`
// Optional. Short description of the result
Description *string `json:"description,omitempty"`
// Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the document caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the file
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.
func (InlineQueryResultCachedDocument) GetInlineQueryResultType ¶
func (i InlineQueryResultCachedDocument) GetInlineQueryResultType() string
func (InlineQueryResultCachedDocument) Validate ¶
func (i InlineQueryResultCachedDocument) Validate() error
type InlineQueryResultCachedGif ¶
type InlineQueryResultCachedGif struct {
// Type of the result, must be gif
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// A valid file identifier for the GIF file
GifFileId string `json:"gif_file_id"`
// Optional. Title for the result
Title *string `json:"title,omitempty"`
// Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the GIF animation
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.
func (InlineQueryResultCachedGif) GetInlineQueryResultType ¶
func (i InlineQueryResultCachedGif) GetInlineQueryResultType() string
func (InlineQueryResultCachedGif) Validate ¶
func (i InlineQueryResultCachedGif) Validate() error
type InlineQueryResultCachedMpeg4Gif ¶
type InlineQueryResultCachedMpeg4Gif struct {
// Type of the result, must be mpeg4_gif
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// A valid file identifier for the MPEG4 file
Mpeg4FileId string `json:"mpeg_4_file_id"`
// Optional. Title for the result
Title *string `json:"title,omitempty"`
// Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the video animation
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
func (InlineQueryResultCachedMpeg4Gif) GetInlineQueryResultType ¶
func (i InlineQueryResultCachedMpeg4Gif) GetInlineQueryResultType() string
func (InlineQueryResultCachedMpeg4Gif) Validate ¶
func (i InlineQueryResultCachedMpeg4Gif) Validate() error
type InlineQueryResultCachedPhoto ¶
type InlineQueryResultCachedPhoto struct {
// Type of the result, must be photo
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// A valid file identifier of the photo
PhotoFileId string `json:"photo_file_id"`
// Optional. Title for the result
Title *string `json:"title,omitempty"`
// Optional. Short description of the result
Description *string `json:"description,omitempty"`
// Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the photo caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// /Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the photo
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
func (InlineQueryResultCachedPhoto) GetInlineQueryResultType ¶
func (i InlineQueryResultCachedPhoto) GetInlineQueryResultType() string
func (InlineQueryResultCachedPhoto) Validate ¶
func (i InlineQueryResultCachedPhoto) Validate() error
type InlineQueryResultCachedSticker ¶
type InlineQueryResultCachedSticker struct {
// Type of the result, must be sticker
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// A valid file identifier of the sticker
StickerFileId string `json:"sticker_file_id"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the sticker
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.
func (InlineQueryResultCachedSticker) GetInlineQueryResultType ¶
func (i InlineQueryResultCachedSticker) GetInlineQueryResultType() string
func (InlineQueryResultCachedSticker) Validate ¶
func (i InlineQueryResultCachedSticker) Validate() error
type InlineQueryResultCachedVideo ¶
type InlineQueryResultCachedVideo struct {
// Type of the result, must be video
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// A valid file identifier for the video file
VideoFileId string `json:"video_file_id"`
// Title for the result
Title string `json:"title"`
// Optional. Short description of the result
Description *string `json:"description,omitempty"`
// /Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the video caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the video
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
func (InlineQueryResultCachedVideo) GetInlineQueryResultType ¶
func (i InlineQueryResultCachedVideo) GetInlineQueryResultType() string
func (InlineQueryResultCachedVideo) Validate ¶
func (i InlineQueryResultCachedVideo) Validate() error
type InlineQueryResultCachedVoice ¶
type InlineQueryResultCachedVoice struct {
// Type of the result, must be voice
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// A valid file identifier for the voice message
VoiceFileId string `json:"voice_file_id"`
// Voice message title
Title string `json:"title"`
// Optional. Caption, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the voice message caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the voice message
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.
func (InlineQueryResultCachedVoice) GetInlineQueryResultType ¶
func (i InlineQueryResultCachedVoice) GetInlineQueryResultType() string
func (InlineQueryResultCachedVoice) Validate ¶
func (i InlineQueryResultCachedVoice) Validate() error
type InlineQueryResultContact ¶
type InlineQueryResultContact struct {
// Type of the result, must be contact
Type string `json:"type"`
// Unique identifier for this result, 1-64 Bytes
Id string `json:"id"`
// Contact's phone number
PhoneNumber string `json:"phone_number"`
// Contact's first name
FirstName string `json:"first_name"`
// Optional. Contact's last name
LastName *string `json:"last_name,omitempty"`
// Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes
VCard *string `json:"v_card,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the contact
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
// Optional. Url of the thumbnail for the result
ThumbnailUrl string `json:"thumbnail_url,omitempty"`
// Optional. Thumbnail width
ThumbnailWidth *int `json:"thumbnail_width,omitempty"`
// Optional. Thumbnail height
ThumbnailHeight *int `json:"thumbnail_height,omitempty"`
}
Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.
func (InlineQueryResultContact) GetInlineQueryResultType ¶
func (i InlineQueryResultContact) GetInlineQueryResultType() string
func (InlineQueryResultContact) Validate ¶
func (i InlineQueryResultContact) Validate() error
type InlineQueryResultDocument ¶
type InlineQueryResultDocument struct {
// Type of the result, must be document
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// Title for the result
Title string `json:"title"`
// Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the document caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// A valid URL for the file
DocumentUrl string `json:"document_url"`
// MIME type of the content of the file, either “application/pdf” or “application/zip”
MimeType string `json:"mime_type"`
// Optional. Short description of the result
Description *string `json:"description,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the file
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
// Optional. URL of the thumbnail (JPEG only) for the file
ThumbnailUrl *string `json:"thumbnail_url,omitempty"`
// Optional. Thumbnail width
ThumbnailWidth *int `json:"thumbnail_width,omitempty"`
// Optional. Thumbnail height
ThumbnailHeight *int `json:"thumbnail_height,omitempty"`
}
Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.
func (InlineQueryResultDocument) GetInlineQueryResultType ¶
func (i InlineQueryResultDocument) GetInlineQueryResultType() string
func (InlineQueryResultDocument) Validate ¶
func (i InlineQueryResultDocument) Validate() error
type InlineQueryResultGame ¶
type InlineQueryResultGame struct {
// Type of the result, must be game
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// Short name of the game
GameShortName string `json:"game_short_name"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}
Represents a Game.
func (InlineQueryResultGame) GetInlineQueryResultType ¶
func (i InlineQueryResultGame) GetInlineQueryResultType() string
func (InlineQueryResultGame) Validate ¶
func (i InlineQueryResultGame) Validate() error
type InlineQueryResultGif ¶
type InlineQueryResultGif struct {
// Type of the result, must be gif
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// A valid URL for the GIF file. File size must not exceed 1MB
GifUrl string `json:"gif_url"`
// Optional. Width of the GIF
GifWidth *int `json:"gif_width,omitempty"`
// Optional. Height of the GIF
GifHeight *int `json:"gif_height,omitempty"`
// Optional. Duration of the GIF in seconds
GifDuration *int `json:"gif_duration,omitempty"`
// URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
ThumbnailUrl string `json:"thumbnail_url"`
//Optional. MIME type of the thumbnail, must be one of
//“image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”
ThumbnailMimeType *string `json:"thumbnail_mime_type,omitempty"`
// Optional. Title for the result
Title *string `json:"title,omitempty"`
// Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the caption. See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Content of the message to be sent instead of the GIF animation
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}
Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
func (InlineQueryResultGif) GetInlineQueryResultType ¶
func (i InlineQueryResultGif) GetInlineQueryResultType() string
func (InlineQueryResultGif) Validate ¶
func (i InlineQueryResultGif) Validate() error
type InlineQueryResultLocation ¶
type InlineQueryResultLocation struct {
// Type of the result, must be location
Type string `json:"type"`
// Unique identifier for this result, 1-64 Bytes
Id string `json:"id"`
// Location latitude in degrees
Latitude *float32 `json:"latitude"`
// Location longitude in degrees
Longitude *float32 `json:"longitude"`
// Location title
Title string `json:"title"`
// Optional. The radius of uncertainty for the location, measured in meters; 0-1500
HorizontalAccuracy *float32 `json:"horizontal_accuracy,omitempty"`
// Optional. Period in seconds during which the location can be updated, should be between 60 and 86400,
// or 0x7FFFFFFF for live locations that can be edited indefinitely.
LivePeriod *int `json:"live_period,omitempty"`
// Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
Heading *int `json:"heading,omitempty"`
// 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.
ProximityAlertRadius *int `json:"proximity_alert_radius,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the location
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
// Optional. Url of the thumbnail for the result
ThumbnailUrl *string `json:"thumbnail_url,omitempty"`
// Optional. Thumbnail width
ThumbnailWidth *int `json:"thumbnail_width,omitempty"`
// Optional. Thumbnail height
ThumbnailHeight *int `json:"thumbnail_height,omitempty"`
}
Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location
func (InlineQueryResultLocation) GetInlineQueryResultType ¶
func (i InlineQueryResultLocation) GetInlineQueryResultType() string
func (InlineQueryResultLocation) Validate ¶
func (i InlineQueryResultLocation) Validate() error
type InlineQueryResultMpeg4Gif ¶
type InlineQueryResultMpeg4Gif struct {
// Type of the result, must be mpeg4_gif
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// A valid URL for the MPEG4 file. File size must not exceed 1MB
Mpeg4Url string `json:"mpeg4_url"`
// Optional. Video width
Mpeg4Width *int `json:"mpeg4_width,omitempty"`
// Optional. Video height
Mpeg4Height *int `json:"mpeg4_height,omitempty"`
// Optional. Video duration in seconds
Mpeg4Duration *int `json:"mpeg4_duration,omitempty"`
// URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
ThumbnailUrl string `json:"thumbnail_url"`
// Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”
ThumbnailMimeType *string `json:"thumbnail_mime_type,omitempty"`
// Optional. Title for the result
Title *string `json:"title,omitempty"`
// Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the video animation
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
func (InlineQueryResultMpeg4Gif) GetInlineQueryResultType ¶
func (i InlineQueryResultMpeg4Gif) GetInlineQueryResultType() string
func (InlineQueryResultMpeg4Gif) Validate ¶
func (i InlineQueryResultMpeg4Gif) Validate() error
type InlineQueryResultPhoto ¶
type InlineQueryResultPhoto struct {
// Type of the result, must be photo
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB
PhotoUrl string `json:"photo_url"`
// URL of the thumbnail for the photo
ThumbnailUrl string `json:"thumbnail_url"`
// Optional. Width of the photo
PhotoWidth *int `json:"photo_width,omitempty"`
// Optional. Height of the photo
PhotoHeight *int `json:"photo_height,omitempty"`
// Optional. Title for the result
Title *string `json:"title,omitempty"`
// Optional. Short description of the result
Description *string `json:"description,omitempty"`
// Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the photo caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the photo
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
func (InlineQueryResultPhoto) GetInlineQueryResultType ¶
func (i InlineQueryResultPhoto) GetInlineQueryResultType() string
func (InlineQueryResultPhoto) Validate ¶
func (i InlineQueryResultPhoto) Validate() error
type InlineQueryResultVenue ¶
type InlineQueryResultVenue struct {
// Type of the result, must be venue
Type string `json:"type"`
// Unique identifier for this result, 1-64 Bytes
Id string `json:"id"`
// Latitude of the venue location in degrees
Latitude *float32 `json:"latitude"`
// Longitude of the venue location in degrees
Longitude *float32 `json:"longitude"`
// Title of the venue
Title string `json:"title"`
// Address of the venue
Address string `json:"address"`
// Optional. Foursquare identifier of the venue if known
FoursquareId *string `json:"foursquare_id,omitempty"`
//Optional. Foursquare type of the venue, if known.
//(For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
FourSquareType *string `json:"four_square_type,omitempty"`
// Optional. Google Places identifier of the venue
GooglePlaceId *string `json:"google_place_id,omitempty"`
//Optional. Google Places type of the venue.
//(See https://developers.google.com/places/web-service/supported_types)
GooglePlaceType *string `json:"google_place_type,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the venue
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
// Optional. Url of the thumbnail for the result
ThumbnailUrl *string `json:"thumbnail_url,omitempty"`
// Optional. Thumbnail width
ThumbnailWidth *int `json:"thumbnail_width,omitempty"`
// Optional. Thumbnail height
ThumbnailHeight *int `json:"thumbnail_height,omitempty"`
}
Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.
func (InlineQueryResultVenue) GetInlineQueryResultType ¶
func (i InlineQueryResultVenue) GetInlineQueryResultType() string
func (InlineQueryResultVenue) Validate ¶
func (i InlineQueryResultVenue) Validate() error
type InlineQueryResultVideo ¶
type InlineQueryResultVideo struct {
// Type of the result, must be video
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// A valid URL for the embedded video player or video file
VideoUrl string `json:"video_url"`
// MIME type of the content of the video URL, “text/html” or “video/mp4”
MimeType string `json:"mime_type"`
// URL of the thumbnail (JPEG only) for the video
ThumbnailUrl string `json:"thumbnail_url"`
// Title for the result
Title string `json:"title"`
// Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the video caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Video width
VideoWidth *int `json:"video_width,omitempty"`
// Optional. Video height
VideoHeight *int `json:"video_height,omitempty"`
// Optional. Video duration in seconds
VideoDuration *int `json:"video_duration,omitempty"`
// Optional. Short description of the result
Description *string `json:"description,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the video.
// This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using input_message_content.
func (InlineQueryResultVideo) GetInlineQueryResultType ¶
func (i InlineQueryResultVideo) GetInlineQueryResultType() string
func (InlineQueryResultVideo) Validate ¶
func (i InlineQueryResultVideo) Validate() error
type InlineQueryResultVoice ¶
type InlineQueryResultVoice struct {
// Type of the result, must be voice
Type string `json:"type"`
// Unique identifier for this result, 1-64 bytes
Id string `json:"id"`
// A valid URL for the voice recording
VoiceUrl string `json:"voice_url"`
// Recording title
Title string `json:"title"`
// Optional. Caption, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the voice message caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. Recording duration in seconds
VoiceDuration *int `json:"voice_duration,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the voice recording
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.
func (InlineQueryResultVoice) GetInlineQueryResultType ¶
func (i InlineQueryResultVoice) GetInlineQueryResultType() string
func (InlineQueryResultVoice) Validate ¶
func (i InlineQueryResultVoice) Validate() error
type InlineQueryResultsButton ¶
type InlineQueryResultsButton struct {
// Label text on the button
Text string
// 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 switchInlineQuery inside the Web App.
WebApp *WebAppInfo
//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.
//
//Example: An inline bot that sends YouTube videos can ask the user to
//connect the bot to their YouTube account to adapt search results accordingly.
//To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any.
//The user presses the button, switches to a private chat with the bot and, in doing so,
//passes a start parameter that instructs the bot to return an OAuth link. Once done,
//the bot can offer a switch_inline button so that the user can easily return to the
//chat where they wanted to use the bot's inline capabilities.
StartParameter *string
}
This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.
func (InlineQueryResultsButton) Validate ¶
func (i InlineQueryResultsButton) Validate() error
type InputContactMessageContent ¶
type InputContactMessageContent struct {
// Contact's phone number
PhoneNumber string `json:"phone_number"`
// Contact's first name
FirstName string `json:"first_name"`
// Optional. Contact's last name
LastName string `json:"last_name"`
// Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes
VCard string `json:"v_card"`
}
Represents the content of a contact message to be sent as the result of an inline query.
func (InputContactMessageContent) GetInputMessageContentType ¶
func (i InputContactMessageContent) GetInputMessageContentType() string
func (InputContactMessageContent) Validate ¶
func (i InputContactMessageContent) Validate() error
type InputFile ¶
InputFile represents a file to be uploaded. It supports different sources (local path, byte data, or remote identifier) and must be posted using multipart/form-data.
type InputFileFromReader ¶
InputFileFromReader represents a file stored on the local filesystem.
func (InputFileFromReader) Validate ¶
func (i InputFileFromReader) Validate() error
Validates the file path and checks file existence.
type InputFileFromRemote ¶
type InputFileFromRemote string
InputFileFromRemote represents a file identified by a remote ID or URL.
func (InputFileFromRemote) Validate ¶
func (i InputFileFromRemote) Validate() error
Validates the remote FileId or URL.
type InputInvoiceMessageContent ¶
type InputInvoiceMessageContent struct {
// Product name, 1-32 characters
Title string `json:"title"`
// Product description, 1-255 characters
Description string `json:"description"`
// Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
Payload string `json:"payload"`
// Optional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
ProviderToken *string `json:"provider_token,omitempty"`
// Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
Currency string `json:"currency"`
//Price breakdown, a JSON-serialized list of components
//(e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).
//Must contain exactly one item for payments in Telegram Stars.
Prices []LabeledPrice `json:"prices"`
// 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.
// See the exp parameter in https://core.telegram.org/bots/payments/currencies.json,
// it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
// Defaults to 0. Not supported for payments in Telegram Stars.
MaxTipAmount *int `json:"max_tip_amount,omitempty"`
// 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.
SuggestedTipAmounts *[]int `json:"suggested_tip_amounts,omitempty"`
// 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.
ProviderData *string `json:"provider_data,omitempty"`
// Optional. URL of the product photo for the invoice.
// Can be a photo of the goods or a marketing image for a service.
PhotoUrl *string `json:"photo_url,omitempty"`
// Optional. Photo size in bytes
PhotoSize *int `json:"photo_size,omitempty"`
// Optional. Photo width
PhotoWidth *int `json:"photo_width,omitempty"`
// Optional. Photo height
PhotoHeight *int `json:"photo_height,omitempty"`
// Optional. Pass True if you require the user's full name to complete the order.
// Ignored for payments in Telegram Stars.
NeedName *bool `json:"need_name,omitempty"`
// Optional. Pass True if you require the user's phone number to complete the order.
// Ignored for payments in Telegram Stars.
NeedPhoneNumber *bool `json:"need_phone_number,omitempty"`
// Optional. Pass True if you require the user's email address to complete the order.
// Ignored for payments in Telegram Stars.
NeedEmail *bool `json:"need_email,omitempty"`
// Optional. Pass True if you require the user's shipping address to complete the order.
// Ignored for payments in Telegram Stars.
NeedShippingAddress *bool `json:"need_shipping_address,omitempty"`
// Optional. Pass True if the user's phone number should be sent to the provider.
// Ignored for payments in Telegram Stars.
SendPhoneNumberToProvider *bool `json:"send_phone_number_to_provider,omitempty"`
// Optional. Pass True if the user's email address should be sent to the provider.
// Ignored for payments in Telegram Stars.
SendEmailToProvider *bool `json:"send_email_to_provider,omitempty"`
// Optional. Pass True if the final price depends on the shipping method.
// Ignored for payments in Telegram Stars.
IsFlexible *bool `json:"is_flexible,omitempty"`
}
Represents the content of an invoice message to be sent as the result of an inline query.
func (InputInvoiceMessageContent) GetInputMessageContentType ¶
func (i InputInvoiceMessageContent) GetInputMessageContentType() string
func (InputInvoiceMessageContent) Validate ¶
func (i InputInvoiceMessageContent) Validate() error
type InputLocationMessageContent ¶
type InputLocationMessageContent struct {
// Latitude of the location in degrees
Latitude *float64 `json:"latitude"`
// Longitude of the location in degrees
Longitude *float64 `json:"longitude"`
// Optional. The radius of uncertainty for the location, measured in meters; 0-1500
HorizontalAccuracy *float64 `json:"horizontal_accuracy,omitempty"`
// Optional. Period in seconds during which the location can be updated, should be between 60 and 86400,
// or 0x7FFFFFFF for live locations that can be edited indefinitely.
LivePeriod *int `json:"live_period,omitempty"`
// Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
Heading *int `json:"heading,omitempty"`
// 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.
ProximityAlertRadius *int `json:"proximity_alert_radius,omitempty"`
}
Represents the content of a location message to be sent as the result of an inline query.
func (InputLocationMessageContent) GetInputMessageContentType ¶
func (i InputLocationMessageContent) GetInputMessageContentType() string
func (InputLocationMessageContent) Validate ¶
func (i InputLocationMessageContent) Validate() error
type InputMedia ¶
type InputMedia interface {
SetMedia(string, io.Reader)
WriteTo(mw *multipart.Writer) error
Validate() error
}
This object represents the content of a media message to be sent. It should be one of
type InputMediaAnimation ¶
type InputMediaAnimation struct {
// REQUIRED:
// 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://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Media string `json:"media"`
// Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side.
// 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://<file_attach_name>” if
// the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Thumbnail *string `json:"thumbnail,omitempty"`
// Caption of the animation to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Mode for parsing entities in the animation caption. See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Animation width
Width *int `json:"width,omitempty"`
// Animation height
Height *int `json:"height,omitempty"`
// Animation duration in seconds
Duration *int `json:"duration,omitempty"`
// Pass True if the animation needs to be covered with a spoiler animation
HasSpoiler *bool `json:"has_spoiler,omitempty"`
// contains filtered or unexported fields
}
Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
IMPORTANT: It is strongly recommended to use the SetInputMedia method to ensure proper handling of file attachments, including the use of "attach://" prefixes for new files or validation of media URLs.
func (*InputMediaAnimation) SetMedia ¶
func (i *InputMediaAnimation) SetMedia(media string, r io.Reader)
SetMedia sets Media to "attach://<media>" if r is not nil, or to media if r is nil (for remote files like Telegram file ID or HTTP URL).
func (*InputMediaAnimation) SetThumbnail ¶
func (i *InputMediaAnimation) SetThumbnail(thumb string, r io.Reader)
SetThumbnail sets Thumbnail to "attach://<thumbnail>" if r is not nil, or to media if r is nil (for remote files like Telegram file ID or HTTP URL).
func (InputMediaAnimation) Validate ¶
func (i InputMediaAnimation) Validate() error
type InputMediaAudio ¶
type InputMediaAudio struct {
// REQUIRED:
// 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://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Media string `json:"media"`
// Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side.
// 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://<file_attach_name>” if
// the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Thumbnail *string `json:"thumbnail,omitempty"`
// Caption of the audio to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Mode for parsing entities in the audio caption. See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Duration of the audio in seconds
Duration *int `json:"duration,omitempty"`
// Performer of the audio
Performer *string `json:"performer,omitempty"`
// Title of the audio
Title *string `json:"title,omitempty"`
// contains filtered or unexported fields
}
Represents an audio file to be treated as music to be sent.
IMPORTANT: It is strongly recommended to use the SetInputMedia method to ensure proper handling of file attachments, including the use of "attach://" prefixes for new files or validation of media URLs.
func (*InputMediaAudio) SetMedia ¶
func (i *InputMediaAudio) SetMedia(media string, r io.Reader)
SetMedia sets Media to "attach://<media>" if r is not nil, or to media if r is nil (for remote files like Telegram file ID or HTTP URL).
func (*InputMediaAudio) SetThumbnail ¶
func (i *InputMediaAudio) SetThumbnail(thumb string, r io.Reader)
SetThumbnail sets Media to "attach://<thumb>" if r is not nil, or to media if r is nil (for remote files like Telegram file ID or HTTP URL).
func (InputMediaAudio) Validate ¶
func (i InputMediaAudio) Validate() error
type InputMediaDocument ¶
type InputMediaDocument struct {
// 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://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Media string `json:"media"`
// Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side.
// 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://<file_attach_name>” if
// the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Thumbnail *string `json:"thumbnail,omitempty"`
// Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the document caption.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// 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.
DisableContentTypeDetection *bool `json:"disable_content_type_detection,omitempty"`
// contains filtered or unexported fields
}
Represents a general file to be sent.
IMPORTANT: It is strongly recommended to use the SetInputMedia method to ensure proper handling of file attachments, including the use of "attach://" prefixes for new files or validation of media URLs.
func (*InputMediaDocument) SetMedia ¶
func (i *InputMediaDocument) SetMedia(media string, r io.Reader)
SetMedia sets Media to "attach://<media>" if r is not nil, or to media if r is nil (for remote files like Telegram file ID or HTTP URL).
func (*InputMediaDocument) SetThumbnail ¶
func (i *InputMediaDocument) SetThumbnail(thumb string, r io.Reader)
SetThumbnail sets Media to "attach://<thumb>" if r is not nil, or to media if r is nil (for remote files like Telegram file ID or HTTP URL).
func (InputMediaDocument) Validate ¶
func (i InputMediaDocument) Validate() error
type InputMediaPhoto ¶
type InputMediaPhoto struct {
// REQUIRED:
// 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://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Media string `json:"media"`
// Caption of the photo to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Mode for parsing entities in the photo caption. See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Pass True if the photo needs to be covered with a spoiler animation
HasSpoiler *bool `json:"has_spoiler,omitempty"`
// contains filtered or unexported fields
}
Represents a photo to be sent.
IMPORTANT: It is strongly recommended to use the SetMedia method to ensure proper handling of file attachments, including the use of "attach://" prefixes for new files or validation of media URLs.
func (*InputMediaPhoto) SetMedia ¶
func (i *InputMediaPhoto) SetMedia(media string, r io.Reader)
SetMedia sets Media to "attach://<media>" if r is not nil, or to media if r is nil (for remote files like Telegram file ID or HTTP URL).
func (InputMediaPhoto) Validate ¶
func (i InputMediaPhoto) Validate() error
type InputMediaVideo ¶
type InputMediaVideo struct {
// REQUIRED:
// 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://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Media string `json:"media"`
// Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side.
// 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://<file_attach_name>” if
// the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Thumbnail *string `json:"thumbnail,omitempty"`
// Optional. Cover for the video in the message.
// 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://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Cover *string `json:"cover,omitempty"`
// Optional. Start timestamp for the video in the message
StartTimestamp *int `json:"start_timestamp,omitempty"`
// Caption of the video to be sent, 0-1024 characters after entities parsing
Caption *string `json:"caption,omitempty"`
// Mode for parsing entities in the video caption. See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Video width
Width *int `json:"width,omitempty"`
// Video height
Height *int `json:"height,omitempty"`
// Video duration in seconds
Duration *int `json:"duration,omitempty"`
// Pass True if the uploaded video is suitable for streaming
SupportsStreaming *bool `json:"supports_streaming,omitempty"`
// Pass True if the video needs to be covered with a spoiler animation
HasSpoiler *bool `json:"has_spoiler,omitempty"`
// contains filtered or unexported fields
}
Represents a video to be sent.
IMPORTANT: It is strongly recommended to use the SetInputMedia method to ensure proper handling of file attachments, including the use of "attach://" prefixes for new files or validation of media URLs.
func (*InputMediaVideo) SetCover ¶
func (i *InputMediaVideo) SetCover(cover string, r io.Reader)
SetMedia sets Media to "attach://<media>" if r is not nil, or to media if r is nil (for remote files like Telegram file ID or HTTP URL).
func (*InputMediaVideo) SetMedia ¶
func (i *InputMediaVideo) SetMedia(media string, r io.Reader)
SetMedia sets Media to "attach://<media>" if r is not nil, or to media if r is nil (for remote files like Telegram file ID or HTTP URL).
func (*InputMediaVideo) SetThumbnail ¶
func (i *InputMediaVideo) SetThumbnail(thumb string, r io.Reader)
SetThumbnail sets Media to "attach://<thumbnail>" if r is not nil, or to media if r is nil (for remote files like Telegram file ID or HTTP URL).
func (InputMediaVideo) Validate ¶
func (i InputMediaVideo) Validate() error
type InputMessageContent ¶
This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types:
- InputTextMessageContent
- InputLocationMessageContent
- InputVenueMessageContent
- InputContactMessageContent
- InputInvoiceMessageContent
type InputPaidMedia ¶
type InputPaidMedia interface {
SetPaidMedia(string, io.Reader)
WriteTo(mw *multipart.Writer) error
Validate() error
}
This object describes the paid media to be sent. Currently, it can be one of
- InputPaidMediaPhoto
- InputPaidMediaVideo
type InputPaidMediaPhoto ¶
type InputPaidMediaPhoto struct {
// 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://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Media string `json:"media"`
// contains filtered or unexported fields
}
The paid media to send is a photo.
IMPORTANT: It is strongly recommended to use the SetPaidMedia method to ensure proper handling of file attachments, including the use of "attach://" prefixes for new files or validation of media URLs.
func (*InputPaidMediaPhoto) SetPaidMedia ¶
func (i *InputPaidMediaPhoto) SetPaidMedia(media string, r io.Reader)
func (InputPaidMediaPhoto) Validate ¶
func (i InputPaidMediaPhoto) Validate() error
type InputPaidMediaVideo ¶
type InputPaidMediaVideo struct {
// 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://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Media string `json:"media"`
// Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side.
// 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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Thumbnail *string `json:"thumbnail,omitempty,"`
// Optional. Cover for the video in the message.
// 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://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Cover *string `json:"cover,omitempty"`
// Optional. Start timestamp for the video in the message
StartTimestamp *int `json:"start_timestamp,omitempty"`
// Optional. Video width
Width *int `json:"width,omitempty,"`
// Optional. Video height
Height *int `json:"height,omitempty,"`
// Optional. Video duration in seconds
Duration *int `json:"duration,omitempty,"`
// Optional. Pass True if the uploaded video is suitable for streaming
SupportsStreaming *bool `json:"supports_streaming,omitempty,"`
// contains filtered or unexported fields
}
The paid media to send is a video.
IMPORTANT: It is strongly recommended to use the SetPaidMedia method to ensure proper handling of file attachments, including the use of "attach://" prefixes for new files or validation of media URLs.
func (*InputPaidMediaVideo) SetCover ¶
func (i *InputPaidMediaVideo) SetCover(cover string, r io.Reader)
func (*InputPaidMediaVideo) SetPaidMedia ¶
func (i *InputPaidMediaVideo) SetPaidMedia(media string, r io.Reader)
func (*InputPaidMediaVideo) SetThumbnail ¶
func (i *InputPaidMediaVideo) SetThumbnail(thumb string, r io.Reader)
func (InputPaidMediaVideo) Validate ¶
func (i InputPaidMediaVideo) Validate() error
type InputPollOption ¶
type InputPollOption struct {
// Option text, 1-100 characters
Text string `json:"text"`
// Optional. Mode for parsing entities in the text. See https://core.telegram.org/bots/api#formatting-options for more details.
// Currently, only custom emoji entities are allowed
TextParseMode *string `json:"text_parse_mode,omitempty"`
// Optional. A JSON-serialized list of special entities that appear in the poll option text.
// It can be specified instead of text_parse_mode
TextEntities *[]MessageEntity `json:"text_entities,omitempty"`
}
This object contains information about one answer option in a poll to be sent.
func (InputPollOption) Validate ¶
func (i InputPollOption) Validate() error
type InputProfilePhoto ¶ added in v1.2.0
type InputProfilePhoto interface {
SetPhoto(photo string, r io.Reader)
WriteTo(mw *multipart.Writer) error
Validate() error
}
This object describes a profile photo to set. Currently, it can be one of
- InputProfilePhotoStatic
- InputProfilePhotoAnimated
It's important to use SetPhoto method to ensure properly set fields.
type InputProfilePhotoAnimated ¶ added in v1.2.0
type InputProfilePhotoAnimated struct {
// The animated profile photo.
// Profile photos can't be reused and can only be uploaded as a new file,
// so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>.
// More information on Sending Files https://core.telegram.org/bots/api#sending-files
Animation string `json:"animation"`
// Optional. Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0.
MainFrameTimeStamp *float64 `json:"main_frame_time_stamp,omitempty"`
// contains filtered or unexported fields
}
A static profile photo in the .JPG format.
func (*InputProfilePhotoAnimated) SetPhoto ¶ added in v1.2.0
func (p *InputProfilePhotoAnimated) SetPhoto(photo string, r io.Reader)
func (InputProfilePhotoAnimated) Validate ¶ added in v1.2.0
func (p InputProfilePhotoAnimated) Validate() error
type InputProfilePhotoStatic ¶ added in v1.2.0
type InputProfilePhotoStatic struct {
// The static profile photo.
// Profile photos can't be reused and can only be uploaded as a new file,
// so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>.
// More information on Sending Files https://core.telegram.org/bots/api#sending-files
Photo string `json:"photo"`
// contains filtered or unexported fields
}
A static profile photo in the .JPG format.
func (*InputProfilePhotoStatic) SetPhoto ¶ added in v1.2.0
func (p *InputProfilePhotoStatic) SetPhoto(photo string, r io.Reader)
func (InputProfilePhotoStatic) Validate ¶ added in v1.2.0
func (p InputProfilePhotoStatic) Validate() error
type InputSticker ¶
type InputSticker struct {
// 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,
// upload a new one using multipart/form-data,
// or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
// Animated and video stickers can't be uploaded via HTTP URL.
// More information on Sending Files » https://core.telegram.org/bots/api#sending-files
Sticker InputFile `json:"sticker"`
//Format of the added sticker, must be one of “static” for a .WEBP or .PNG image,
//“animated” for a .TGS animation, “video” for a WEBM video
Format string `json:"format"`
// List of 1-20 emoji associated with the sticker
EmojiList []string `json:"emoji_list"`
// Optional. Position where the mask should be placed on faces. For “mask” stickers only.
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
// 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.
Keywords *[]string `json:"keywords,omitempty"`
}
This object describes a sticker to be added to a sticker set.
func (InputSticker) Validate ¶
func (i InputSticker) Validate() error
type InputStoryContent ¶ added in v1.2.0
type InputStoryContent interface {
Validate() error
SetStoryContent(content string, r io.Reader)
WriteTo(mw *multipart.Writer) error
}
This object describes the content of a story to post. Currently, it can be one of
- InputStoryContentPhoto
- InputStoryContentVideo
type InputStoryContentPhoto ¶ added in v1.2.0
type InputStoryContentPhoto struct {
// The photo to post as a story.
// The photo must be of the size 1080x1920 and must not exceed 10 MB.
// The photo can't be reused and can only be uploaded as a new file,
// so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>.
// More information on Sending Files https://core.telegram.org/bots/api#sending-files
Photo string `json:"photo"`
// contains filtered or unexported fields
}
Describes a photo to post as a story.
func (*InputStoryContentPhoto) SetStoryContent ¶ added in v1.2.0
func (p *InputStoryContentPhoto) SetStoryContent(photo string, r io.Reader)
func (InputStoryContentPhoto) Validate ¶ added in v1.2.0
func (p InputStoryContentPhoto) Validate() error
type InputStoryContentVideo ¶ added in v1.2.0
type InputStoryContentVideo struct {
// The video to post as a story.
// The video must be of the size 720x1280, streamable, encoded with H.265 codec,
// with key frames added each second in the MPEG4 format, and must not exceed 30 MB.
// The video can't be reused and can only be uploaded as a new file,
// so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>.
// More information on Sending Files https://core.telegram.org/bots/api#sending-files
Video string `json:"photo"`
// Optional. Precise duration of the video in seconds; 0-60
Duration *float64 `json:"duration,omitempty"`
// Optional. Timestamp in seconds of the frame that will be used as the static cover for the story.
// Defaults to 0.0.
CoverFrameTimestamp *float64 `json:"cover_frame_timestamp,omitempty"`
// Optional. Pass True if the video has no sound
IsAnimation bool `json:"is_animation,omitempty"`
// contains filtered or unexported fields
}
Describes a video to post as a story.
func (*InputStoryContentVideo) SetStoryContent ¶ added in v1.2.0
func (p *InputStoryContentVideo) SetStoryContent(video string, r io.Reader)
func (InputStoryContentVideo) Validate ¶ added in v1.2.0
func (p InputStoryContentVideo) Validate() error
type InputTextMessageContent ¶
type InputTextMessageContent struct {
// Text of the message to be sent, 1-4096 characters
MessageText string `json:"message_text"`
// Optional. Mode for parsing entities in the message text.
// See https://core.telegram.org/bots/api#formatting-options for more details.
ParseMode *string `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in message text, which can be specified instead of parse_mode
Entities *[]MessageEntity `json:"entities,omitempty"`
// Optional. Link preview generation options for the message
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
}
Represents the content of a text message to be sent as the result of an inline query.
func (InputTextMessageContent) GetInputMessageContentType ¶
func (i InputTextMessageContent) GetInputMessageContentType() string
func (InputTextMessageContent) Validate ¶
func (i InputTextMessageContent) Validate() error
type InputVenueMessageContent ¶
type InputVenueMessageContent struct {
// Latitude of the venue in degrees
Latitude *float64 `json:"latitude"`
// Longitude of the venue in degrees
Longitude *float64 `json:"longitude"`
// Name of the venue
Title string `json:"title"`
// Address of the venue
Address string `json:"address"`
// Optional. Foursquare identifier of the venue, if known
FoursquareId *string `json:"foursquare_id,omitempty"`
//Optional. Foursquare type of the venue, if known.
//(For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
FoursquareType *string `json:"foursquare_type,omitempty"`
// Optional. Google Places identifier of the venue
GooglePlaceId *string `json:"google_place_id,omitempty"`
//Optional. Google Places type of the venue.
//(See https://developers.google.com/places/web-service/supported_types)
GooglePlaceType *string `json:"google_place_type,omitempty"`
}
Represents the content of a venue message to be sent as the result of an inline query.
func (InputVenueMessageContent) GetInputMessageContentType ¶
func (i InputVenueMessageContent) GetInputMessageContentType() string
func (InputVenueMessageContent) Validate ¶
func (i InputVenueMessageContent) Validate() error
type Invoice ¶
type Invoice struct {
// Product name
Title string `json:"title"`
// Product description
Description string `json:"description"`
// Unique bot deep-linking parameter that can be used to generate this invoice
StartParameter string `json:"start_parameter"`
// Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
Currency string `json:"currency"`
// 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.
// See the exp parameter in https://core.telegram.org/bots/payments/currencies.json,
// it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
TotalAmount string `json:"total_amount"`
}
This object contains basic information about an invoice.
type KeyboardButton ¶
type KeyboardButton struct {
// Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed
Text string `json:"text"`
// 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.
RequestUsers *KeyboardButtonRequestUsers `json:"request_users,omitempty"`
// 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.
RequestChat *KeyboardButtonRequestChat `json:"request_chat,omitempty"`
// Optional. If True, the user's phone number will be sent as a contact when the button is pressed.
// Available in private chats only.
RequestContact *bool `json:"request_contact,omitempty"`
// Optional. If True, the user's current location will be sent when the button is pressed.
// Available in private chats only.
RequestLocation *bool `json:"request_location,omitempty"`
// 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.
RequestPoll *KeyboardButtonPollType `json:"request_poll,omitempty"`
// Optional. If specified, the described Web App will be launched when the button is pressed.
// The Web App will be able to send a “web_app_data” service message.
// Available in private chats only.
WebApp *WebAppInfo `json:"web_app,omitempty"`
}
This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, String can be used instead of this object to specify the button text.
func (KeyboardButton) Validate ¶
func (k KeyboardButton) Validate() error
type KeyboardButtonPollType ¶
type KeyboardButtonPollType struct {
// 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.
Type *string `json:"type,omitempty"`
}
This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
func (KeyboardButtonPollType) Validate ¶
func (k KeyboardButtonPollType) Validate() error
type KeyboardButtonRequestChat ¶
type KeyboardButtonRequestChat struct {
RequestId int32 `json:"request_id"`
// Pass True to request a channel chat, pass False to request a group or a supergroup chat.
ChatIsChannel bool `json:"chat_is_channel"`
// Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat.
// If not specified, no additional restrictions are applied.
ChatIsForum *bool `json:"chat_is_forum,omitempty"`
// 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.
ChatHasUsername *bool `json:"chat_has_username,omitempty"`
// Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.
ChatIsCreated *bool `json:"chat_is_created,omitempty"`
// Optional. A JSON-serialized object listing the required administrator rights of the user in the chat.
// The rights must be a superset of bot_administrator_rights.
// If not specified, no additional restrictions are applied.
UserAdministratorRights *ChatAdministratorRights `json:"user_administrator_rights,omitempty"`
// 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.
BotAdministratorRights *ChatAdministratorRights `json:"bot_administrator_rights,omitempty"`
// Optional. Pass True to request a chat with the bot as a member.
// Otherwise, no additional restrictions are applied.
BotIsMember *bool `json:"bot_is_member,omitempty"`
// Optional. Pass True to request the chat's title
RequestTitle *bool `json:"request_title,omitempty"`
// Optional. Pass True to request the chat's username
RequestUsername *bool `json:"request_username,omitempty"`
// Optional. Pass True to request the chat's photo
RequestPhoto *bool `json:"request_photo,omitempty"`
}
This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats » https://core.telegram.org/bots/features#chat-and-user-selection
func (KeyboardButtonRequestChat) Validate ¶
func (k KeyboardButtonRequestChat) Validate() error
type KeyboardButtonRequestUsers ¶
type KeyboardButtonRequestUsers struct {
// Signed 32-bit identifier of the request that will be received back in the UsersShared object.
// Must be unique within the message
RequestId int32 `json:"request_id"`
// Optional. Pass True to request bots, pass False to request regular users.
// If not specified, no additional restrictions are applied.
UserIsBot *bool `json:"user_is_bot,omitempty"`
// Optional. Pass True to request premium users, pass False to request non-premium users.
// If not specified, no additional restrictions are applied.
UserIsPremium *bool `json:"user_is_premium,omitempty"`
// Optional. The maximum number of users to be selected; 1-10. Defaults to 1.
MaxQuantity *int `json:"max_quantity,omitempty"`
// Optional. Pass True to request the users' first and last names
RequestName *bool `json:"request_name,omitempty"`
// Optional. Pass True to request the users' usernames
RequestUsername *bool `json:"request_username,omitempty"`
// Optional. Pass True to request the users' photos
RequestPhoto *bool `json:"request_photo,omitempty"`
}
This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. More about requesting users » https://core.telegram.org/bots/features#chat-and-user-selection
func (KeyboardButtonRequestUsers) Validate ¶
func (k KeyboardButtonRequestUsers) Validate() error
type LabeledPrice ¶
type LabeledPrice struct {
// Portion label
Label string `json:"label"`
// Price of the product in the smallest units of the currency (integer, not float/double).
// For example, for a price of US$ 1.45 pass amount = 145.
// See the exp parameter in https://core.telegram.org/bots/payments/currencies.json,
// it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
Amount int `json:"amount"`
}
This object represents a portion of the price for goods or services.
func (LabeledPrice) Validate ¶
func (l LabeledPrice) Validate() error
type LinkPreviewOptions ¶
type LinkPreviewOptions struct {
// Optional. True, if the link preview is disabled
IsDisabled *bool `json:"is_disabled,omitempty"`
// Optional. URL to use for the link preview. If empty, then the first URL found in the message text will be used
UrlFileId *string `json:"url_file_id,omitempty"`
// 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
PreferSmallMedia *bool `json:"prefer_small_media,omitempty"`
// Optional. True, if the media in the link preview is supposed to be enlarged;
// ignored if the URL isn't explicitly specified or media size change isn't supported for the preview
PreferLargeMedia *bool `json:"prefer_large_media,omitempty"`
// Optional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text
ShowAboveText *bool `json:"show_above_text,omitempty"`
}
Describes the options used for link preview generation.
func (LinkPreviewOptions) Validate ¶
func (l LinkPreviewOptions) Validate() error
type Location ¶
type Location struct {
// Latitude as defined by the sender
Latitude float64 `json:"latitude"`
// Longitude as defined by the sender
Longitude float64 `json:"longitude"`
// Optional. The radius of uncertainty for the location, measured in meters; 0-1500
HorizontalAccuracy *float64 `json:"horizontal_accuracy,omitempty"`
// Optional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.
LivePeriod *int `json:"live_period,omitempty"`
// Optional. The direction in which user is moving, in degrees; 1-360. For active live locations only.
Heading *int `json:"heading,omitempty"`
// Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.
ProximityAlertRadius *int `json:"proximity_alert_radius,omitempty"`
}
This object represents a point on the map.
type LocationAddress ¶ added in v1.2.0
type LocationAddress struct {
// The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located
CountryCode string `json:"country_code"`
// Optional. State of the location
State *string `json:"state,omitempty"`
// Optional. City of the location
City *string `json:"city,omitempty"`
// Optional. Street address of the location
Street *string `json:"street,omitempty"`
}
Describes the physical address of a location.
type LoginUrl ¶
type LoginUrl struct {
//An HTTPS 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.
//
//IMPORTANT: You must always check the hash of the received data to verify the authentication and
//the integrity of the data as described in https://core.telegram.org/widgets/login#checking-authorization.
Url string `json:"url"`
// Optional. New text of the button in forwarded messages.
ForwardText *string `json:"forward_text,omitempty"`
// 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. See Linking your domain to the bot for more details.
BotUsername *string `json:"bot_username,omitempty"`
// Optional. Pass True to request the permission for your bot to send messages to the user.
RequestWriteAccess *bool `json:"request_write_access,omitempty"`
}
This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in.
Telegram apps support these buttons as of version 5.7.
type MaskPosition ¶
type MaskPosition struct {
// The part of the face relative to which the mask should be placed.
// One of “forehead”, “eyes”, “mouth”, or “chin”.
Point string `json:"point"`
// 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.
XShift *float32 `json:"x_shift"`
// 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.
YShift *float32 `json:"y_shift"`
// Mask scaling coefficient. For example, 2.0 means double size.
Scale *float32 `json:"scale"`
}
This object describes the position on faces where a mask should be placed by default.
func (MaskPosition) Validate ¶
func (m MaskPosition) Validate() error
type MaybeInaccessibleMessage ¶
type MaybeInaccessibleMessage struct {
Date int
Accessible *Message
Inaccessible *InaccessibleMessage
}
This object describes a message that can be inaccessible to the bot. It can be one of:
- Message
- InaccessibleMessage
func (*MaybeInaccessibleMessage) UnmarshalJSON ¶
func (m *MaybeInaccessibleMessage) UnmarshalJSON(data []byte) error
type MenuButton ¶
This object describes the bot's menu button in a private chat. It should be one of
If a menu button other than MenuButtonDefault is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands.
type MenuButtonCommands ¶
type MenuButtonCommands struct {
// Type of the button, must be commands
Type string `json:"type"`
}
Represents a menu button, which opens the bot's list of commands.
func (MenuButtonCommands) GetMenuButtonType ¶
func (m MenuButtonCommands) GetMenuButtonType() string
func (MenuButtonCommands) Validate ¶
func (m MenuButtonCommands) Validate() error
type MenuButtonDefault ¶
type MenuButtonDefault struct {
// Type of the button, must be default
Type string `json:"type"`
}
Describes that no specific value for the menu button was set.
func (MenuButtonDefault) GetMenuButtonType ¶
func (m MenuButtonDefault) GetMenuButtonType() string
func (MenuButtonDefault) Validate ¶
func (m MenuButtonDefault) Validate() error
type MenuButtonResponse ¶
type MenuButtonResponse struct {
Type string `json:"type"`
Text *string `json:"text,omitempty"`
WebApp *WebAppInfo `json:"web_app,omitempty"`
}
MenuButtonResponse represents the generalized form of a bot's menu button in a private chat. This type is used exclusively for reading responses from the `getMenuButton` method.
It serves as a base structure containing all possible fields of different menu button types:
This type provides methods to convert itself into a more specific `MenuButton` implementation for further processing.
type MenuButtonWebApp ¶
type MenuButtonWebApp struct {
// Type of the button, must be web_app
Type string `json:"type"`
// Text on the button
Text string `json:"text"`
// 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.
// Alternatively, a t.me link to a Web App of the bot can be specified in the object instead of the Web App's URL,
// in which case the Web App will be opened as if the user pressed the link.
WebApp WebAppInfo `json:"web_app"`
}
Represents a menu button, which launches a Web App.
func (MenuButtonWebApp) GetMenuButtonType ¶
func (m MenuButtonWebApp) GetMenuButtonType() string
func (MenuButtonWebApp) Validate ¶
func (m MenuButtonWebApp) Validate() error
type Message ¶
type Message struct {
// Unique message identifier inside this chat.
// In specific instances (e.g., message containing a video sent to a big chat),
// the server might automatically schedule a message instead of sending it immediately.
// In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent
MessageId int `json:"message_id"`
// Optional. Unique identifier of a message thread to which the message belongs; for supergroups only
MessageThreadId *int `json:"message_thread_id,omitempty"`
// Optional. Sender of the message; may be empty for messages sent to channels.
// For backward compatibility, if the message was sent on behalf of a chat,
// the field contains a fake sender user in non-channel chats
From *User `json:"from,omitempty"`
// Optional. Sender of the message when sent on behalf of a chat.
// For example, the supergroup itself for messages sent by its anonymous administrators or
// a linked channel for messages automatically forwarded to the channel's discussion group.
// For backward compatibility, if the message was sent on behalf of a chat,
// the field from contains a fake sender user in non-channel chats.
SenderChat *Chat `json:"sender_chat,omitempty"`
// Optional. If the sender of the message boosted the chat, the number of boosts added by the user
SenderBoostCount *int `json:"sender_boost_count,omitempty"`
// Optional. The bot that actually sent the message on behalf of the business account.
// Available only for outgoing messages sent on behalf of the connected business account.
SenderBusinessBot *User `json:"sender_business_bot,omitempty"`
// Date the message was sent in Unix time. It is always a positive number, representing a valid date.
Date int `json:"date"`
// Optional. Unique identifier of the business connection from which the message was received.
// If non-empty, the message belongs to a chat of the corresponding business account that is
// independent from any potential bot chat which might share the same identifier.
BusinessConnectionId *string `json:"business_connection_id,omitempty"`
// Chat the message belongs to
Chat Chat `json:"chat"`
// Optional. Information about the original message for forwarded messages
ForwardOrigin *MessageOrigin `json:"forward_origin,omitempty"`
// Optional. True, if the message is sent to a forum topic
IsTopicMessage *bool `json:"is_topic_message,omitempty"`
// Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group
IsAutomaticForward *bool `json:"is_automatic_forward,omitempty"`
// 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.
ReplyToMessage *Message `json:"reply_to_message,omitempty"`
// Optional. Information about the message that is being replied to, which may come from another chat or forum topic
ExternalReply *ExternalReplyInfo `json:"external_reply,omitempty"`
// Optional. For replies that quote part of the original message, the quoted part of the message
Quote *TextQuote `json:"quote,omitempty"`
// Optional. For replies to a story, the original story
ReplyToStory *Story `json:"reply_to_story,omitempty"`
// Optional. Bot through which the message was sent
ViaBot *User `json:"via_bot,omitempty"`
// Optional. Date the message was last edited in Unix time
EditDate *int `json:"edit_date,omitempty"`
// Optional. True, if the message can't be forwarded
HasProtectedContent *bool `json:"has_protected_content,omitempty"`
// Optional. True, if the message was sent by an implicit action, for example,
// as an away or a greeting business message, or as a scheduled message
IsFromOffline *bool `json:"is_from_offline,omitempty"`
// Optional. The unique identifier of a media message group this message belongs to
MediaGroupId *string `json:"media_group_id,omitempty"`
// Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator
AuthorSignature *string `json:"author_signature,omitempty"`
//Optional. The number of Telegram Stars that were paid by the sender of the message to send it
PaidStarCount *int `json:"paid_star_count,omitempty"`
// Optional. For text messages, the actual UTF-8 text of the message
Text *string `json:"text,omitempty"`
// Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text
Entities *[]MessageEntity `json:"entities,omitempty"`
// Optional. Options used for link preview generation for the message,
// if it is a text message and link preview options were changed
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
// Optional. Unique identifier of the message effect added to the message
EffectId *string `json:"effect_id,omitempty"`
// Optional. Message is an animation, information about the animation.
// For backward compatibility, when this field is set, the document field will also be set
Animation *Animation `json:"animation,omitempty"`
// Optional. Message is an audio file, information about the file
Audio *Audio `json:"audio,omitempty"`
// Optional. Message is a general file, information about the file
Document *Document `json:"document,omitempty"`
// Optional. Message contains paid media; information about the paid media
PaidMedia *PaidMediaInfo `json:"paid_media,omitempty"`
// Optional. Message is a photo, available sizes of the photo
Photo *[]PhotoSize `json:"photo,omitempty"`
// Optional. Message is a sticker, information about the sticker
Sticker *Sticker `json:"sticker,omitempty"`
// Optional. Message is a forwarded story
Story *Story `json:"story,omitempty"`
// Optional. Message is a video, information about the video
Video *Video `json:"video,omitempty"`
// Optional. Message is a video note, information about the video message
VideoNote *VideoNote `json:"video_note,omitempty"`
// Optional. Message is a voice message, information about the file
Voice *Voice `json:"voice,omitempty"`
// Optional. Caption for the animation, audio, document, paid media, photo, video or voice
Caption *string `json:"caption,omitempty"`
// Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption
CaptionEntities *[]MessageEntity `json:"caption_entities,omitempty"`
// Optional. True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. True, if the message media is covered by a spoiler animation
HasMediaSpoiler *bool `json:"has_media_spoiler,omitempty"`
// Optional. Message is a shared contact, information about the contact
Contact *Contact `json:"contact,omitempty"`
// Optional. Message is a dice with random value
Dice *Dice `json:"dice,omitempty"`
// Optional. Message is a game, information about the game. More about games » https://core.telegram.org/bots/api#games
Game *Game `json:"game,omitempty"`
// Optional. Message is a native poll, information about the poll
Poll *Poll `json:"poll,omitempty"`
// Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set
Venue *Venue `json:"venue,omitempty"`
// Optional. Message is a shared location, information about the location
Location *Location `json:"location,omitempty"`
// Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)
NewChatMembers *[]User `json:"new_chat_members,omitempty"`
// Optional. A member was removed from the group, information about them (this member may be the bot itself)
LeftChatMember *User `json:"left_chat_member,omitempty"`
// Optional. A chat title was changed to this value
NewChatTitle *string `json:"new_chat_title,omitempty"`
// Optional. A chat photo was change to this value
NewChatPhoto *[]PhotoSize `json:"new_chat_photo,omitempty"`
// Optional. Service message: the chat photo was deleted
DeleteChatPhoto *bool `json:"delete_chat_photo,omitempty"`
// Optional. Service message: the group has been created
GroupChatCreated *bool `json:"group_chat_created,omitempty"`
// 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.
SuperGroupCreated *bool `json:"super_group_created,omitempty"`
// 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.
ChannelChatCreated *bool `json:"channel_chat_created"`
// Optional. Service message: auto-delete timer settings changed in the chat
MessageAutoDeleteTimerChanged *MessageAutoDeleteTimerChanged `json:"message_auto_delete_timer_changed,omitempty"`
// Optional. The group has been migrated to a supergroup with the specified identifier.
// 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 signed 64-bit integer or double-precision float type are safe for storing this identifier.
MigrateToChatId *int64 `json:"migrate_to_chat_id,omitempty"`
// Optional. The supergroup has been migrated from a group with the specified identifier.
// 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 signed 64-bit integer or double-precision float type are safe for storing this identifier.
MigrateFromChatId *int64 `json:"migrate_from_chat_id,omitempty"`
// Optional. Specified message was pinned. Note that the Message object in this field
// will not contain further reply_to_message fields even if it itself is a reply.
PinnedMessage *MaybeInaccessibleMessage `json:"pinned_message,omitempty"`
// Optional. Message is an invoice for a payment, information about the invoice.
// More about payments » https://core.telegram.org/bots/api#payments
Invoice *Invoice `json:"invoice,omitempty"`
// Optional. Message is a service message about a successful payment, information about the payment.
// More about payments » https://core.telegram.org/bots/api#payments
SuccessfulPayment *SuccessfulPayment `json:"successful_payment,omitempty"`
// Optional. Message is a service message about a refunded payment, information about the payment.
// More about payments » https://core.telegram.org/bots/api#payments
RefundedPayment *RefundedPayment `json:"refunded_payment,omitempty"`
UsersShared *UsersShared `json:"users_shared,omitempty"`
ChatShared *ChatShared `json:"chat_shared,omitempty"`
// Optional. Service message: a regular gift was sent or received
Gift *GiftInfo `json:"gift,omitempty"`
// Optional. Service message: a unique gift was sent or received
UniqueGift *UniqueGiftInfo `json:"unique_gift,omitempty"`
// Optional. The domain name of the website on which the user has logged in.
// More about Telegram Login » https://core.telegram.org/widgets/login
ConnectedWebsite *string `json:"connected_website,omitempty"`
// 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
WriteAccessAllowed *WriteAccessAllowed `json:"write_access_allowed,omitempty"`
// Optional. Telegram Passport data
PassportData *PassportData `json:"passport_data,omitempty"`
// Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.
ProximityAlertTriggered *ProximityAlertTriggered `json:"proximity_alert_triggered,omitempty"`
// Optional. Service message: user boosted the chat
BoostAdded *ChatBoostAdded `json:"boost_added,omitempty"`
// Optional. Service message: chat background set
ChatBackgroundSet *ChatBackground `json:"chat_background_set,omitempty"`
// Optional. Service message: forum topic created
ForumTopicCreated *ForumTopicCreated `json:"forum_topic_created,omitempty"`
// Optional. Service message: forum topic edited
ForumTopicEdited *ForumTopicEdited `json:"forum_topic_edited,omitempty"`
// Optional. Service message: forum topic closed
ForumTopicClosed *ForumTopicClosed `json:"forum_topic_closed,omitempty"`
// Optional. Service message: forum topic reopened
ForumTopicReopened *ForumTopicReopened `json:"forum_topic_reopened,omitempty"`
// Optional. Service message: the 'General' forum topic hidden
GeneralForumTopicHidden *GeneralForumTopicHidden `json:"general_forum_topic_hidden,omitempty"`
GeneralForumTopicUnhidden *GeneralForumTopicUnhidden `json:"general_forum_topic_unhidden,omitempty"`
// Optional. Service message: a scheduled giveaway was created
GiveawayCreated *GiveawayCreated `json:"giveaway_created,omitempty"`
// Optional. The message is a scheduled giveaway message
Giveaway *Giveaway `json:"giveaway,omitempty"`
// Optional. A giveaway with public winners was completed
GiveawayWinners *GiveawayWinners `json:"giveaway_winners,omitempty"`
// Optional. Service message: a giveaway without public winners was completed
GiveawayCompleted *GiveawayCompleted `json:"giveaway_completed,omitempty"`
//Optional. Service message: the price for paid messages has changed in the chat
PaidMessagePriceChanged *PaidMessagePriceChanged `json:"paid_message_price_changed,omitempty"`
// Optional. Service message: video chat scheduled
VideoChatScheduled *VideoChatScheduled `json:"video_chat_scheduled,omitempty"`
// Optional. Service message: video chat started
VideoChatStarted *VideoChatStarted `json:"video_chat_started,omitempty"`
// Optional. Service message: video chat ended
VideoChatEnded *VideoChatEnded `json:"video_chat_ended,omitempty"`
// Optional. Service message: new participants invited to a video chat
VideoChatParticipantsInvited *VideoChatParticipantsInvited `json:"video_chat_participants_invited,omitempty"`
// Optional. Service message: data sent by a Web App
WebAppData *WebAppData `json:"web_app_data,omitempty"`
// Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}
This object represents a message.
type MessageAutoDeleteTimerChanged ¶
type MessageAutoDeleteTimerChanged struct {
// New auto-delete time for messages in the chat; in seconds
MessageAutoDeleteTime int `json:"message_auto_delete_time"`
}
This object represents a service message about a change in auto-delete timer settings.
type MessageEntity ¶
type MessageEntity struct {
//Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag or #hashtag@chatusername),
//“cashtag” ($USD or $USD@chatusername), “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),
//“expandable_blockquote” (collapsed-by-default 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)
Type string `json:"type"`
// Offset in UTF-16 code units to the start of the entity
Offset int `json:"offset"`
// Length of the entity in UTF-16 code units
Length int `json:"length"`
// Optional. For “text_link” only, URL that will be opened after user taps on the text
Url *string `json:"url,omitempty"`
// Optional. For “text_mention” only, the mentioned user
User *User `json:"user,omitempty"`
// Optional. For “pre” only, the programming language of the entity text
Language *string `json:"language,omitempty"`
// Optional. For “custom_emoji” only, unique identifier of the custom emoji.
// Use [methods.GetCustomEmojiStickers] to get full information about the sticker
CustomEmojiId *string `json:"custom_emoji_id,omitempty"`
}
func (MessageEntity) Validate ¶ added in v1.1.1
func (m MessageEntity) Validate() error
type MessageId ¶
type MessageId struct {
// Unique message identifier. In specific instances (e.g., message containing a video sent to a big chat),
// the server might automatically schedule a message instead of sending it immediately.
// In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent
MessageId int
}
This object represents a unique message identifier.
type MessageOrigin ¶
type MessageOrigin struct {
Type string
User *MessageOriginUser
HiddenUser *MessageOriginHiddenUser
Chat *MessageOriginChat
Channel *MessageOriginChannel
}
This object describes the origin of a message. It can be one of
-MessageOriginUser
-MessageOriginHiddenUser
-MessageOriginChat
-MessageOriginChannel
func (*MessageOrigin) UnmarshalJSON ¶
func (m *MessageOrigin) UnmarshalJSON(data []byte) error
type MessageOriginChannel ¶
type MessageOriginChannel struct {
// Type of the message origin, always “channel”
Type string `json:"type"`
// Date the message was sent originally in Unix time
Date int `json:"date"`
// Channel chat to which the message was originally sent
Chat Chat `json:"chat"`
// Unique message identifier inside the chat
MessageId int `json:"message_id"`
// Optional. Signature of the original post author
AuthorSignature *string `json:"author_signature,omitempty"`
}
The message was originally sent to a channel chat.
type MessageOriginChat ¶
type MessageOriginChat struct {
// Type of the message origin, always “chat”
Type string `json:"type"`
// Date the message was sent originally in Unix time
Date int `json:"date"`
// Chat that sent the message originally
SenderChat Chat `json:"sender_chat"`
// Optional. For messages originally sent by an anonymous chat administrator, original message author signature
AuthorSignature *string `json:"author_signature,omitempty"`
}
The message was originally sent on behalf of a chat to a group chat.
type MessageOriginHiddenUser ¶
type MessageOriginHiddenUser struct {
// Type of the message origin, always “hidden_user”
Type string `json:"type"`
// Date the message was sent originally in Unix time
Date int `json:"date"`
// Name of the user that sent the message originally
SenderUsername string `json:"sender_username"`
}
The message was originally sent by an unknown user.
type MessageOriginUser ¶
type MessageOriginUser struct {
// Type of the message origin, always “user”
Type string `json:"type"`
// Date the message was sent originally in Unix time
Date int `json:"date"`
// User that sent the message originally
SenderUser User `json:"sender_user"`
}
The message was originally sent by a known user.
type MessageReactionCountUpdated ¶
type MessageReactionCountUpdated struct {
// The chat containing the message
Chat Chat `json:"chat"`
// Unique message identifier inside the chat
MessageId int `json:"message_id"`
// Date of the change in Unix time
Date int `json:"date"`
// List of reactions that are present on the message
Reactions []ReactionCount `json:"reactions"`
}
This object represents reaction changes on a message with anonymous reactions.
type MessageReactionUpdated ¶
type MessageReactionUpdated struct {
// The chat containing the message the user reacted to
Chat Chat `json:"chat"`
// Unique identifier of the message inside the chat
MessageId int `json:"message_id"`
// Optional. The user that changed the reaction, if the user isn't anonymous
User *User `json:"user,omitempty"`
// Optional. The chat on behalf of which the reaction was changed, if the user is anonymous
ActorChat *Chat `json:"actor_chat,omitempty"`
// Date of the change in Unix time
Date int `json:"date"`
// Previous list of reaction types that were set by the user
OldReaction []ReactionType `json:"old_reaction"`
// New list of reaction types that have been set by the user
NewReaction []ReactionType `json:"new_reaction"`
}
This object represents a change of a reaction on a message performed by a user.
type OrderInfo ¶
type OrderInfo struct {
// Optional. User name
Name *string `json:"name,omitempty"`
// Optional. User's phone number
PhoneNumber *string `json:"phone_number,omitempty"`
// Optional. User email
Email *string `json:"email,omitempty"`
// Optional. User shipping address
ShippingAddress *ShippingAddress `json:"shipping_address,omitempty"`
}
This object represents information about an order.
type OwnedGift ¶ added in v1.2.0
type OwnedGift struct {
// Type of the gift
Type string `json:"type"`
Regular *OwnedGiftRegular
Unique *OwnedGiftUnique
}
This object describes a gift received and owned by a user or a chat. Currently, it can be one of
- OwnedGiftRegular
- OwnedGiftUnique
func (*OwnedGift) UnmarshalJSON ¶ added in v1.2.0
type OwnedGiftRegular ¶ added in v1.2.0
type OwnedGiftRegular struct {
// Type of the gift, always “regular”
Type string `json:"type"`
// Information about the regular gift
Gift Gift `json:"gift"`
// Date the gift was sent in Unix time
SendDate int `json:"send_date"`
// Optional. Unique identifier of the gift for the bot;
// for gifts received on behalf of business accounts only
OwnedGiftId *string `json:"owned_gift_id,omitempty"`
// Optional. Sender of the gift if it is a known user
SenderUser *User `json:"sender_user,omitempty"`
// Optional. Text of the message that was added to the gift
Text *string `json:"text,omitempty"`
// Optional. Special entities that appear in the text
Entities *[]MessageEntity `json:"entities,omitempty"`
// Optional. True, if the sender and gift text are shown only to the gift receiver;
// otherwise, everyone will be able to see them
IsPrivate *bool `json:"is_private,omitempty"`
// Optional. True, if the gift is displayed on the account's profile page;
// for gifts received on behalf of business accounts only
IsSaved *bool `json:"is_saved,omitempty"`
// Optional. True, if the gift can be upgraded to a unique gift;
// for gifts received on behalf of business accounts only
CanBeUpgraded *bool `json:"can_be_upgraded,omitempty"`
// Optional. True, if the gift was refunded and isn't available anymore
WasRefunded *bool `json:"was_refunded,omitempty"`
// Optional. Number of Telegram Stars that can be claimed by the receiver instead of the gift;
// omitted if the gift cannot be converted to Telegram Stars
ConvertStarCount *int `json:"convert_star_count,omitempty"`
// Optional. Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift
PrepaidUpgradeStarCount *int `json:"prepaid_upgrade_star_count,omitempty"`
}
Describes a regular gift owned by a user or a chat.
type OwnedGiftUnique ¶ added in v1.2.0
type OwnedGiftUnique struct {
// Type of the gift, always “unique”
Type string `json:"type"`
// Information about the unique gift
Gift UniqueGift `json:"gift"`
// Date the gift was sent in Unix time
SenderDate int `json:"sender_date"`
// Optional. Unique identifier of the received gift for the bot;
// for gifts received on behalf of business accounts only
OwnedGiftId *string `json:"owned_gift_id,omitempty"`
// Optional. Sender of the gift if it is a known user
SenderUser *User `json:"sender_user,omitempty"`
// Optional. True, if the gift is displayed on the account's profile page;
// for gifts received on behalf of business accounts only
IsSaved *bool `json:"is_saved,omitempty"`
// Optional. True, if the gift can be transferred to another owner;
// for gifts received on behalf of business accounts only
CanBeTransferred *bool `json:"can_be_transferred,omitempty"`
// Optional. Number of Telegram Stars that must be paid to transfer the gift;
// omitted if the bot cannot transfer the gift
TransferStarCount *int `json:"transfer_star_count,omitempty"`
}
Describes a unique gift received and owned by a user or a chat.
type OwnedGifts ¶ added in v1.2.0
type OwnedGifts struct {
// The total number of gifts owned by the user or the chat
TotalCount int `json:"total_count"`
// The list of gifts
Gifts []OwnedGift `json:"gifts"`
// Optional. Offset for the next request. If empty, then there are no more results
NextOffset *string `json:"next_offset.omitempty"`
}
Contains the list of gifts received and owned by a user or a chat.
type PaidMedia ¶
type PaidMedia struct {
Type string `json:"type"`
Preview *PaidMediaPreview
Photo *PaidMediaPhoto
Video *PaidMediaVideo
}
This object describes paid media. Currently, it can be one of
- PaidMediaPreview
- PaidMediaPhoto
- PaidMediaVideo
func (*PaidMedia) UnmarshalJSON ¶
type PaidMediaInfo ¶
type PaidMediaInfo struct {
// The number of Telegram Stars that must be paid to buy access to the media
StarCount string `json:"star_count"`
// Information about the paid media
PaidMedia []PaidMedia `json:"paid_media"`
}
Describes the paid media added to a message.
type PaidMediaPhoto ¶
type PaidMediaPhoto struct {
// Type of the paid media, always “photo”
Type string `json:"type"`
// The photo
Photo []PhotoSize `json:"photo"`
}
The paid media is a photo.
type PaidMediaPreview ¶
type PaidMediaPreview struct {
// Type of the paid media, always “preview”
Type string `json:"type"`
// Optional. Media width as defined by the sender
Width *int `json:"width,omitempty"`
// Optional. Media height as defined by the sender
Height *int `json:"height,omitempty"`
// Optional. Duration of the media in seconds as defined by the sender
Duration *int `json:"duration,omitempty"`
}
The paid media isn't available before the payment.
type PaidMediaPurchased ¶
type PaidMediaPurchased struct {
// User who purchased the media
User User `json:"user"`
// Bot-specified paid media payload
PaidMediaPayload string `json:"paid_media_payload"`
}
This object contains information about a paid media purchase.
type PaidMediaVideo ¶
type PaidMediaVideo struct {
// Type of the paid media, always “video”
Type string `json:"type"`
// The video
Video Video `json:"video"`
}
The paid media is a video.
type PaidMessagePriceChanged ¶ added in v1.2.0
type PaidMessagePriceChanged struct {
//The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message
PaidMessageStarCount int `json:"paid_message_star_count"`
}
Describes a service message about a change in the price of paid messages within a chat.
type PassportData ¶
type PassportData struct {
// Array with information about documents and other Telegram Passport elements that was shared with the bot
Data []EncryptedPassportElement `json:"data"`
// Encrypted credentials required to decrypt the data
Credentials EncryptedCredentials `json:"credentials"`
}
Describes Telegram Passport data shared with the bot by the user.
type PassportElementError ¶
This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:
- PassportElementErrorDataField
- PassportElementErrorFrontSide
- PassportElementErrorReverseSide
- PassportElementErrorSelfie
- PassportElementErrorFile
- PassportElementErrorFiles
- PassportElementErrorTranslationFile
- PassportElementErrorTranslationFiles
- PassportElementErrorUnspecified
type PassportElementErrorDataField ¶
type PassportElementErrorDataField struct {
// Error source, must be data
Source string `json:"source"`
// The section of the user's Telegram Passport which has the error,
// one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”
Type string `json:"type"`
// Name of the data field which has the error
FieldName string `json:"field_name"`
// Base64-encoded data hash
DataHash string `json:"data_hash"`
// Error message
Message string `json:"message"`
}
Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.
func (PassportElementErrorDataField) GetPassportElementErrorSource ¶
func (p PassportElementErrorDataField) GetPassportElementErrorSource() string
func (PassportElementErrorDataField) Validate ¶
func (p PassportElementErrorDataField) Validate() error
type PassportElementErrorFile ¶
type PassportElementErrorFile struct {
// Error source, must be file
Source string `json:"source"`
// The section of the user's Telegram Passport which has the issue,
// one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
Type string `json:"type"`
// Base64-encoded file hash
FileHash string `json:"file_hash"`
// Error message
Message string `json:"message"`
}
Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
func (PassportElementErrorFile) GetPassportElementErrorSource ¶
func (p PassportElementErrorFile) GetPassportElementErrorSource() string
func (PassportElementErrorFile) Validate ¶
func (p PassportElementErrorFile) Validate() error
type PassportElementErrorFiles ¶
type PassportElementErrorFiles struct {
// Error source, must be files
Source string `json:"source"`
// The section of the user's Telegram Passport which has the issue,
// one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
Type string `json:"type"`
// List of base64-encoded file hashes
FileHashes []string `json:"file_hashes"`
// Error message
Message string `json:"message"`
}
Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
func (PassportElementErrorFiles) GetPassportElementErrorSource ¶
func (p PassportElementErrorFiles) GetPassportElementErrorSource() string
func (PassportElementErrorFiles) Validate ¶
func (p PassportElementErrorFiles) Validate() error
type PassportElementErrorFrontSide ¶
type PassportElementErrorFrontSide struct {
// Error source, must be front_side
Source string `json:"source"`
// The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”
Type string `json:"type"`
// Base64-encoded hash of the file with the front side of the document
FileHash string `json:"file_hash"`
// Error message
Message string `json:"message"`
}
Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.
func (PassportElementErrorFrontSide) GetPassportElementErrorSource ¶
func (p PassportElementErrorFrontSide) GetPassportElementErrorSource() string
func (PassportElementErrorFrontSide) Validate ¶
func (p PassportElementErrorFrontSide) Validate() error
type PassportElementErrorReverseSide ¶
type PassportElementErrorReverseSide struct {
// Error source, must be reverse_side
Source string `json:"source"`
// The section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card”
Type string `json:"type"`
// Base64-encoded hash of the file with the reverse side of the document
FileHash string `json:"file_hash"`
// Error message
Message string `json:"message"`
}
Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.
func (PassportElementErrorReverseSide) GetPassportElementErrorSource ¶
func (p PassportElementErrorReverseSide) GetPassportElementErrorSource() string
func (PassportElementErrorReverseSide) Validate ¶
func (p PassportElementErrorReverseSide) Validate() error
type PassportElementErrorSelfie ¶
type PassportElementErrorSelfie struct {
// Error source, must be selfie
Source string `json:"source"`
// The section of the user's Telegram Passport which has the issue,
// one of “passport”, “driver_license”, “identity_card”, “internal_passport”
Type string `json:"type"`
// Base64-encoded hash of the file with the selfie
FileHash string `json:"file_hash"`
// Error message
Message string `json:"message"`
}
Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
func (PassportElementErrorSelfie) GetPassportElementErrorSource ¶
func (p PassportElementErrorSelfie) GetPassportElementErrorSource() string
func (PassportElementErrorSelfie) Validate ¶
func (p PassportElementErrorSelfie) Validate() error
type PassportElementErrorTranslationFile ¶
type PassportElementErrorTranslationFile struct {
// Error source, must be translation_file
Source string `json:"source"`
//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”
Type string `json:"type"`
// Base64-encoded file hash
FileHash string `json:"file_hash"`
// Error message
Message string `json:"message"`
}
Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.
func (PassportElementErrorTranslationFile) GetPassportElementErrorSource ¶
func (p PassportElementErrorTranslationFile) GetPassportElementErrorSource() string
func (PassportElementErrorTranslationFile) Validate ¶
func (p PassportElementErrorTranslationFile) Validate() error
type PassportElementErrorTranslationFiles ¶
type PassportElementErrorTranslationFiles struct {
// Error source, must be translation_files
Source string `json:"source"`
//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”
Type string `json:"type"`
// List of base64-encoded file hashes
FileHashes []string `json:"file_hashes"`
// Error message
Message string `json:"message"`
}
Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
func (PassportElementErrorTranslationFiles) GetPassportElementErrorSource ¶
func (p PassportElementErrorTranslationFiles) GetPassportElementErrorSource() string
func (PassportElementErrorTranslationFiles) Validate ¶
func (p PassportElementErrorTranslationFiles) Validate() error
type PassportElementErrorUnspecified ¶
type PassportElementErrorUnspecified struct {
// Error source, must be unspecified
Source string `json:"source"`
// Type of element of the user's Telegram Passport which has the issue
Type string `json:"type"`
// Base64-encoded element hash
ElementHash string `json:"element_hash"`
// Error message
Message string `json:"message"`
}
Represents an issue in an unspecified place. The error is considered resolved when new data is added.
func (PassportElementErrorUnspecified) GetPassportElementErrorSource ¶
func (p PassportElementErrorUnspecified) GetPassportElementErrorSource() string
func (PassportElementErrorUnspecified) Validate ¶
func (p PassportElementErrorUnspecified) Validate() error
type PassportFile ¶
type PassportFile struct {
// Identifier for this file, which can be used to download or reuse the file
FileId string `json:"file_id"`
// 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.
FileUniqueId string `json:"file_unique_id"`
// File size in bytes
FileSize int `json:"file_size"`
// Unix time when the file was uploaded
FileDate string `json:"file_date"`
}
This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.
type PhotoSize ¶
type PhotoSize struct {
// Identifier for this file, which can be used to download or reuse the file
FileId string `json:"file_id"`
// 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.
FileUniqueId string `json:"file_unique_id"`
// Photo width
Width int `json:"width"`
// Photo height
Height int `json:"height"`
// Optional. File size in bytes
FileSize *int `json:"file_size,omitempty"`
}
This object represents one size of a photo or a file / sticker thumbnail.
type Poll ¶
type Poll struct {
// Unique poll identifier
Id string `json:"id"`
// Poll question, 1-300 characters
Question string `json:"question"`
// Optional. Special entities that appear in the question.
// Currently, only custom emoji entities are allowed in poll questions
QuestionEntities []MessageEntity `json:"question_entities"`
// /List of poll options
Options []PollOption `json:"options"`
// Total number of users that voted in the poll
TotalVoterCount int `json:"total_voter_count"`
// True, if the poll is closed
IsClosed bool `json:"is_closed"`
// True, if the poll is anonymous
IsAnonymous bool `json:"is_anonymous"`
// Poll type, currently can be “regular” or “quiz”
Type string `json:"type"`
// True, if the poll allows multiple answers
AllowsMultipleAnswers bool `json:"allows_multiple_answers"`
// Optional. 0-based identifier of the correct answer option.
// Available only for polls in the quiz mode, which are closed, or
// was sent (not forwarded) by the bot or to the private chat with the bot.
CorrectOptionId *int `json:"correct_option_id,omitempty"`
// Optional. Text that is shown when a user chooses an incorrect answer or
// taps on the lamp icon in a quiz-style poll, 0-200 characters
Explanation *string `json:"explanation,omitempty"`
// Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation
ExplanationEntities *[]MessageEntity `json:"explanation_entities,omitempty"`
// Optional. Amount of time in seconds the poll will be active after creation
OpenPeriod *int `json:"open_period,omitempty"`
// Optional. Point in time (Unix timestamp) when the poll will be automatically closed
CloseDate *int `json:"close_date,omitempty"`
}
This object contains information about a poll.
type PollAnswer ¶
type PollAnswer struct {
// Unique poll identifier
PollId string `json:"poll_id"`
// Optional. The chat that changed the answer to the poll, if the voter is anonymous
VoterChat *Chat `json:"voter_chat"`
// Optional. The user that changed the answer to the poll, if the voter isn't anonymous
User *User `json:"user"`
// 0-based identifiers of chosen answer options. May be empty if the vote was retracted.
OptionIds []int `json:"option_ids"`
}
This object represents an answer of a user in a non-anonymous poll.
type PollOption ¶
type PollOption struct {
// Option text, 1-100 characters
Text string `json:"text"`
// Optional. Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts
VoterCount int `json:"voter_count"`
// Optional. Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts
TextEntities *[]MessageEntity `json:"text_entities,omitempty"`
}
This object contains information about one answer option in a poll.
type PreCheckoutQuery ¶
type PreCheckoutQuery struct {
// Unique query identifier
Id string `json:"id"`
// User who sent the query
From *User `json:"from"`
// Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
Currency string `json:"currency"`
// 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.
// See the exp parameter in https://core.telegram.org/bots/payments/currencies.json,
// it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
TotalAmount int `json:"total_amount"`
// Bot-specified invoice payload
InvoicePayload string `json:"invoice_payload"`
// Optional. Identifier of the shipping option chosen by the user
ShippingOptionId *string `json:"shipping_option_id,omitempty"`
// Optional. Order information provided by the user
OrderInfo *OrderInfo `json:"order_info,omitempty"`
}
This object contains information about an incoming pre-checkout query.
type PreparedInlineMessage ¶
type PreparedInlineMessage struct {
// Unique identifier of the prepared message
Id string
// Expiration date of the prepared message, in Unix time. Expired prepared messages can no longer be used
ExpirationDate int
}
Describes an inline message to be sent by a user of a Mini App.
type ProximityAlertTriggered ¶
type ProximityAlertTriggered struct {
// User that triggered the alert
Traveler User `json:"traveler"`
// User that set the alert
Watcher User `json:"watcher"`
// The distance between the users
Distance int `json:"distance"`
}
This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.
type ReactionCount ¶
type ReactionCount struct {
// Type of the reaction
Type ReactionType `json:"type"`
// Number of times the reaction was added
TotalCount int `json:"total_count"`
}
Represents a reaction added to a message along with the number of times it was added.
type ReactionType ¶
This object describes the type of a reaction. Currently, it can be one of:
- ReactionTypeEmoji
- ReactionTypeCustomEmoji
- ReactionTypePaid
type ReactionTypeCustomEmoji ¶
type ReactionTypeCustomEmoji struct {
// Type of the reaction, always “custom_emoji”
Type string `json:"type"`
// Custom emoji identifier
CustomEmojiId string `json:"custom_emoji_id"`
}
The reaction is based on a custom emoji.
func (ReactionTypeCustomEmoji) GetReactionType ¶
func (r ReactionTypeCustomEmoji) GetReactionType() string
func (ReactionTypeCustomEmoji) Validate ¶
func (r ReactionTypeCustomEmoji) Validate() error
type ReactionTypeEmoji ¶
type ReactionTypeEmoji struct {
// Type of the reaction, always “emoji”
Type string `json:"type"`
//Reaction emoji. Currently, it can be one of
//"👍", "👎", "❤", "🔥", "🥰", "👏", "😁", "🤔", "🤯", "😱", "🤬", "😢",
//"🎉", "🤩", "🤮", "💩", "🙏", "👌", "🕊", "🤡", "🥱", "🥴", "😍", "🐳",
//"❤🔥", "🌚", "🌭", "💯", "🤣", "⚡", "🍌", "🏆", "💔", "🤨", "😐", "🍓",
//"🍾", "💋", "🖕", "😈", "😴", "😭", "🤓", "👻", "👨💻", "👀", "🎃", "🙈",
//"😇", "😨", "🤝", "✍", "🤗", "🫡", "🎅", "🎄", "☃", "💅", "🤪", "🗿",
//"🆒", "💘", "🙉", "🦄", "😘", "💊", "🙊", "😎", "👾", "🤷♂", "🤷", "🤷♀", "😡"
Emoji string `json:"emoji"`
}
The reaction is based on an emoji.
func (ReactionTypeEmoji) GetReactionType ¶
func (r ReactionTypeEmoji) GetReactionType() string
func (ReactionTypeEmoji) Validate ¶
func (r ReactionTypeEmoji) Validate() error
type ReactionTypePaid ¶
type ReactionTypePaid struct {
// Type of the reaction, always “paid”
Type string `json:"type"`
}
The reaction is paid.
func (ReactionTypePaid) GetReactionType ¶
func (r ReactionTypePaid) GetReactionType() string
func (ReactionTypePaid) Validate ¶
func (r ReactionTypePaid) Validate() error
type RefundedPayment ¶
type RefundedPayment struct {
// Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars.
// Currently, always “XTR”
Currency string `json:"currency"`
// Total refunded price in the smallest units of the currency (integer, not float/double).
// For example, for a price of US$ 1.45, total_amount = 145.
// See the exp parameter in https://core.telegram.org/bots/payments/currencies.json,
// it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
TotalAmount int `json:"total_amount"`
// Bot-specified invoice payload
InvoicePayload string `json:"invoice_payload"`
// Telegram payment identifier
TelegramPaymentChargeId string `json:"telegram_payment_charge_id"`
// Optional. Provider payment identifier
ProviderPaymentChargeId *string `json:"provider_payment_charge_id,omitempty"`
}
This object contains basic information about a refunded payment.
type ReplyKeyboardMarkup ¶
type ReplyKeyboardMarkup struct {
// Array of button rows, each represented by an Array of KeyboardButton objects
Keyboard [][]KeyboardButton `json:"keyboard"`
// 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.
IsPersistent *bool `json:"is_persistent,omitempty"`
// Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons).
// Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
ResizeKeyboard *bool `json:"resize_keyboard,omitempty"`
// Optional. Requests clients to hide the keyboard as soon as it's been used.
// The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat -
// the user can press a special button in the input field to see the custom keyboard again. Defaults to false.
OneTimeKeyboard *bool `json:"one_time_keyboard,omitempty"`
// Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters
InputFieldPlaceholder *string `json:"input_field_placeholder,omitempty"`
//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 to a message in the same chat and forum topic, sender of the original message.
//
//Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.
Selective *bool `json:"selective,omitempty"`
}
This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.
func (ReplyKeyboardMarkup) Validate ¶
func (r ReplyKeyboardMarkup) Validate() error
type ReplyKeyboardRemove ¶
type ReplyKeyboardRemove struct {
// Requests clients to remove the custom keyboard (user will not be able to summon this keyboard;
// if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)
RemoveKeyboard bool `json:"remove_keyboard"`
//Optional. Use this parameter if you want to remove the keyboard for specific users only. Targets:
//
//1) users that are @mentioned in the text of the Message object;
//
//2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.
//
//Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user,
//while still showing the keyboard with poll options to users who haven't voted yet.
Selective *bool `json:"selective,omitempty"`
}
Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.
type ReplyMarkup ¶
type ReplyMarkup struct {
ReplyMarkupInterface
}
The ReplyMarkup interface unifies the possible types of reply markup objects that can be used in Telegram Bot API methods for customizing keyboards in messages.
type ReplyMarkupInterface ¶
type ReplyMarkupInterface interface {
// contains filtered or unexported methods
}
type ReplyParameters ¶
type ReplyParameters struct {
// Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified
MessageId int `json:"message_id"`
// 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).
// Not supported for messages sent on behalf of a business account.
ChatId *string `json:"chat_id,omitempty"`
// Optional. Pass True if the message should be sent even if the specified message to be replied to is not found.
// Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account.
AllowSendingWithoutReply *bool `json:"allow_sending_without_reply,omitempty"`
// 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.
Quote *string `json:"quote,omitempty"`
// Optional. Mode for parsing entities in the quote.
// See https://core.telegram.org/bots/api#formatting-options for more details.
QuoteParseMode *string `json:"quote_parse_mode,omitempty"`
// Optional. A JSON-serialized list of special entities that appear in the quote.
// It can be specified instead of quote_parse_mode.
QuoteEntities *[]MessageEntity `json:"quote_entities,omitempty"`
// Optional. Position of the quote in the original message in UTF-16 code units
QuotePosition *int `json:"quote_position,omitempty"`
}
Describes reply parameters for the message that is being sent.
func (ReplyParameters) Validate ¶
func (r ReplyParameters) Validate() error
type ResponseParameters ¶
type ResponseParameters struct {
// Optional. The group has been migrated to a supergroup with the specified identifier.
// 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 signed 64-bit integer or double-precision float type are safe for storing this identifier.
MigrateToChatId *int `json:"migrate_to_chat_id,omitempty"`
// Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated
RetryAfter *int `json:"retry_after,omitempty"`
}
Describes why a request was unsuccessful.
type RevenueWithdrawalState ¶
type RevenueWithdrawalState struct {
// Type of the state
Type string `json:"type"`
Pending *RevenueWithdrawalStatePending
Succeeded *RevenueWithdrawalStateSucceeded
Failed *RevenueWithdrawalStateFailed
}
This object describes the state of a revenue withdrawal operation. Currently, it can be one of
- RevenueWithdrawalStatePending
- RevenueWithdrawalStateSucceeded
- RevenueWithdrawalStateFailed
func (*RevenueWithdrawalState) UnmarshalJSON ¶
func (s *RevenueWithdrawalState) UnmarshalJSON(data []byte) error
type RevenueWithdrawalStateFailed ¶
type RevenueWithdrawalStateFailed struct {
// Type of the state, always “failed”
Type string `json:"type"`
}
The withdrawal failed and the transaction was refunded.
type RevenueWithdrawalStatePending ¶
type RevenueWithdrawalStatePending struct {
// Type of the state, always “pending”
Type string `json:"type"`
}
The withdrawal is in progress.
type RevenueWithdrawalStateSucceeded ¶
type RevenueWithdrawalStateSucceeded struct {
// Type of the state, always “succeeded”
Type string `json:"type"`
// Date the withdrawal was completed in Unix time
Date int `json:"date"`
// An HTTPS URL that can be used to see transaction details
Url string `json:"url"`
}
The withdrawal succeeded.
type SentWebAppMessage ¶
type SentWebAppMessage struct {
// Optional. Identifier of the sent inline message.
// Available only if there is an inline keyboard attached to the message.
InlineMessageId *string `json:"inline_message_id,omitempty"`
}
Describes an inline message sent by a Web App on behalf of a user.
type SharedUser ¶
type SharedUser struct {
// some programming languages may have difficulty/silent defects in interpreting it.
// But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers.
// The bot may not have access to the user and could be unable to use this identifier,
// unless the user is already known to the bot by some other means.
UserId int64 `json:"user_id"`
FirstName *string `json:"first_name,omitempty"`
LastName *string `json:"last_name,omitempty"`
Username *string `json:"username,omitempty"`
Photo *[]PhotoSize `json:"photo,omitempty"`
}
This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.
type ShippingAddress ¶
type ShippingAddress struct {
// Two-letter ISO 3166-1 alpha-2 country code
CountryCode string `json:"country_code"`
// State, if applicable
State string `json:"state"`
// City
City string `json:"city"`
// First line for the address
StreetLine1 string `json:"street_line1"`
// Second line for the address
StreetLine2 string `json:"street_line2"`
// Address post code
PostCode string `json:"post_code"`
}
This object represents a shipping address.
type ShippingOption ¶
type ShippingOption struct {
// Shipping option identifier
Id string `json:"id"`
// Option title
Title string `json:"title"`
// List of price portions
Prices []LabeledPrice `json:"prices"`
}
This object represents one shipping option.
func (ShippingOption) Validate ¶
func (s ShippingOption) Validate() error
type ShippingQuery ¶
type ShippingQuery struct {
// Unique query identifier
Id string `json:"id"`
// User who sent the query
From User `json:"from"`
// Bot-specified invoice payload
InvoicePayload string `json:"invoice_payload"`
// User specified shipping address
ShippingAddress ShippingAddress `json:"shipping_address"`
}
This object contains information about an incoming shipping query.
type StarAmount ¶ added in v1.2.0
type StarAmount struct {
// Integer amount of Telegram Stars, rounded to 0; can be negative
Amount int `json:"amount"`
// Optional. The number of 1/1000000000 shares of Telegram Stars;
// from -999999999 to 999999999;
// can be negative if and only if amount is non-positive
NanostarAmount *int `json:"nanostar_amount,omitempty"`
}
Describes an amount of Telegram Stars.
type StarTransaction ¶
type StarTransaction struct {
// Unique identifier of the transaction.
// Coincides with the identifier of the original transaction for refund transactions.
// Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users.
Id string `json:"id"`
// Integer amount of Telegram Stars transferred by the transaction
Amount int `json:"amount"`
// Optional. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999
NanostarAmount *int `json:"nanostar_amount,omitempty"`
// Date the transaction was created in Unix time
Date int `json:"date"`
//Optional. Source of an incoming transaction
//(e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions
Source *TransactionPartner `json:"source,omitempty,"`
//Optional. Receiver of an outgoing transaction
//(e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions
Receiver *TransactionPartner `json:"receiver,omitempty,"`
}
Describes a Telegram Star transaction.
type StarTransactions ¶
type StarTransactions struct {
// The list of transactions
Transactions []StarTransaction `json:"transactions"`
}
Contains a list of Telegram Star transactions.
type Sticker ¶
type Sticker struct {
// Identifier for this file, which can be used to download or reuse the file
FileId string `json:"file_id"`
// 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.
FileUniqueId string `json:"file_unique_id"`
// Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”.
// The type of the sticker is independent from its format,
// which is determined by the fields is_animated and is_video.
Type string `json:"type"`
// Sticker width
Width int `json:"width"`
// Sticker height
Height int `json:"height"`
// True, if the sticker is animated
IsAnimated bool `json:"is_animated"`
// True, if the sticker is a video sticker
IsVideo bool `json:"is_video"`
// Optional. Sticker thumbnail in the .WEBP or .JPG format
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
// Optional. Emoji associated with the sticker
Emoji *string `json:"emoji,omitempty"`
// Optional. Name of the sticker set to which the sticker belongs
SetName *string `json:"set_name,omitempty"`
// Optional. For premium regular stickers, premium animation for the sticker
PremiumAnimation *File `json:"premium_animation,omitempty"`
// Optional. For mask stickers, the position where the mask should be placed
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
// Optional. For custom emoji stickers, unique identifier of the custom emoji
CustomEmojiId *string `json:"custom_emoji_id,omitempty"`
// 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
NeedsRepainting *bool `json:"needs_repainting,omitempty"`
// Optional. File size in bytes
FileSize *int `json:"file_size,omitempty"`
}
This object represents a sticker.
type StickerSet ¶
type StickerSet struct {
// Sticker set name
Name string `json:"name"`
// Sticker set title
Title string `json:"title"`
// Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji”
StickerType string `json:"sticker_type"`
// List of all set stickers
Stickers []Sticker `json:"stickers"`
// Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
}
This object represents a sticker set.
type Story ¶
type Story struct {
// Chat that posted the story
Chat Chat `json:"chat"`
// Unique identifier for the story in the chat
Id int `json:"id"`
}
This object represents a story.
type StoryArea ¶ added in v1.2.0
type StoryArea struct {
// Position of the area
Position StoryAreaPosition `json:"position"`
// Type of the area
Type StoryAreaType `json:"type"`
}
Describes a clickable area on a story media.
type StoryAreaPosition ¶ added in v1.2.0
type StoryAreaPosition struct {
// The abscissa of the area's center, as a percentage of the media width
XPercentage float64 `json:"x_percentage"`
// The ordinate of the area's center, as a percentage of the media height
YPercentage float64 `json:"y_percentage"`
// The width of the area's rectangle, as a percentage of the media width
WidthPercentage float64 `json:"width_percentage"`
// The height of the area's rectangle, as a percentage of the media height
HeightPercentage float64 `json:"height_percentage"`
// The clockwise rotation angle of the rectangle, in degrees; 0-360
RotationAngle float64 `json:"rotation_angle"`
// The radius of the rectangle corner rounding, as a percentage of the media width
CornerRadiusPercentage float64 `json:"corner_radius_percentage"`
}
Describes the position of a clickable area within a story.
type StoryAreaType ¶ added in v1.2.0
type StoryAreaType struct {
Type string
Location *StoryAreaTypeLocation
SuggestedReaction *StoryAreaTypeSuggestedReaction
Link *StoryAreaTypeLink
Weather *StoryAreaTypeWeather
UniqueGift *StoryAreaTypeUniqueGift
}
Describes the type of a clickable area on a story. Currently, it can be one of
- StoryAreaTypeLocation
- StoryAreaTypeSuggestedReaction
- StoryAreaTypeLink
- StoryAreaTypeWeather
- StoryAreaTypeUniqueGift
func (*StoryAreaType) UnmarshalJSON ¶ added in v1.2.0
func (s *StoryAreaType) UnmarshalJSON(data []byte) error
type StoryAreaTypeLink ¶ added in v1.2.0
type StoryAreaTypeLink struct {
// Type of the area, always “link”
Type string `json:"type"`
// HTTP or tg:// URL to be opened when the area is clicked
Url string `json:"url"`
}
Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.
type StoryAreaTypeLocation ¶ added in v1.2.0
type StoryAreaTypeLocation struct {
// Type of the area, always “location”
Type string `json:"type"`
// Location latitude in degrees
Latitude *float64 `json:"latitude"`
// Location longitude in degrees
Longtitude *float64 `json:"longtitude"`
// Optional. Address of the location
Address *LocationAddress `json:"address,omitempty"`
}
Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.
type StoryAreaTypeSuggestedReaction ¶ added in v1.2.0
type StoryAreaTypeSuggestedReaction struct {
// Type of the area, always “suggested_reaction”
Type string `json:"type"`
// Type of the reaction
ReactionType ReactionType `json:"reaction_type"`
// Optional. Pass True if the reaction area has a dark background
IsDark *bool `json:"is_dark,omitempty"`
// Optional. Pass True if reaction area corner is flipped
IsFlipped *bool `json:"is_flipped,omitempty"`
}
Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.
type StoryAreaTypeUniqueGift ¶ added in v1.2.0
type StoryAreaTypeUniqueGift struct {
// Type of the area, always “unique_gift”
Type string `json:"type"`
// Unique name of the gift
Name string `json:"name"`
}
Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.
type StoryAreaTypeWeather ¶ added in v1.2.0
type StoryAreaTypeWeather struct {
// Type of the area, always “weather”
Type string `json:"type"`
// Temperature, in degree Celsius
Temperatue float64 `json:"temperatue"`
// Emoji representing the weather
Emoji string `json:"emoji"`
// A color of the area background in the ARGB format
BackgroundColor int `json:"background_color"`
}
Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.
type SuccessfulPayment ¶
type SuccessfulPayment struct {
// Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
Currency string `json:"currency"`
// 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.
// See the exp parameter in https://core.telegram.org/bots/payments/currencies.json,
// it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
TotalAmount string `json:"total_amount"`
// Bot-specified invoice payload
InvoicePayload string `json:"invoice_payload"`
// Optional. Expiration date of the subscription, in Unix time; for recurring payments only
SubscriptionExpirationDate *int `json:"subscription_expiration_date,omitempty"`
// Optional. True, if the payment is a recurring payment for a subscription
IsRecurring *bool `json:"is_recurring,omitempty"`
// Optional. True, if the payment is the first payment for a subscription
IsFirstRecurring *bool `json:"is_first_recurring,omitempty"`
// Optional. Identifier of the shipping option chosen by the user
ShippingOptionId *string `json:"shipping_option_id,omitempty"`
// Optional. Order information provided by the user
OrderInfo *OrderInfo `json:"order_info,omitempty"`
// Telegram payment identifier
TelegramPaymentChargeId string `json:"telegram_payment_charge_id"`
// Provider payment identifier
ProviderPaymentChargeId string `json:"provider_payment_charge_id"`
}
This object contains basic information about a successful payment.
type SwitchInlineQueryChosenChat ¶
type SwitchInlineQueryChosenChat struct {
// Optional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted
Query *string `json:"query,omitempty"`
// Optional. True, if private chats with users can be chosen
AllowUserChats *bool `json:"allow_user_chats,omitempty"`
// /Optional. True, if private chats with bots can be chosen
AllowBotChats *bool `json:"allow_bot_chats,omitempty"`
// Optional. True, if group and supergroup chats can be chosen
AllowGroupChats *bool `json:"allow_group_chats,omitempty"`
// Optional. True, if channel chats can be chosen
AllowChannelChats *bool `json:"allow_channel_chats,omitempty"`
}
This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.
type TextQuote ¶
type TextQuote struct {
// Text of the quoted part of a message that is replied to by the given message
Text string `json:"text"`
// Optional. Special entities that appear in the quote.
// Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are kept in quotes.
Entities *[]MessageEntity `json:"entities,omitempty"`
// Approximate quote position in the original message in UTF-16 code units as specified by the sender
Position int `json:"position"`
// Optional. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.
IsManual *bool `json:"is_manual,omitempty"`
}
This object contains information about the quoted part of a message that is replied to by the given message.
type TransactionPartner ¶
type TransactionPartner struct {
Type string
User *TransactionPartnerUser
Chat *TransactionPartnerChat
AffiliateProgram *TransactionPartnerAffiliateProgram
Fragment *TransactionPartnerFragment
TelegramAds *TransactionPartnerTelegramAds
TelegramApi *TransactionPartnerTelegramApi
Other *TransactionPartnerOther
}
This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of:
TransactionPartnerUser
TransactionPartnerChat
TransactionPartnerAffiliateProgram
TransactionPartnerFragment
TransactionPartnerTelegramAds
TransactionPartnerTelegramApi
TransactionPartnerOther
func (*TransactionPartner) UnmarshalJSON ¶
func (t *TransactionPartner) UnmarshalJSON(data []byte) error
type TransactionPartnerAffiliateProgram ¶
type TransactionPartnerAffiliateProgram struct {
// Type of the transaction partner, always “affiliate_program”
Type string `json:"type"`
// Optional. Information about the bot that sponsored the affiliate program
SponsorUser *User `json:"sponsor_user,omitempty"`
// The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users
CommissionPerMile int `json:"commission_per_mile"`
}
Describes the affiliate program that issued the affiliate commission received via this transaction.
type TransactionPartnerChat ¶
type TransactionPartnerChat struct {
// Type of the transaction partner, always “chat”
Type string `json:"type"`
// Information about the chat
Chat Chat `json:"chat"`
// Optional. The gift sent to the chat by the bot
Gift *Gift `json:"gift,omitempty"`
}
Describes a transaction with a chat.
type TransactionPartnerFragment ¶
type TransactionPartnerFragment struct {
// Type of the transaction partner, always “fragment”
Type string `json:"type"`
// Optional. State of the transaction if the transaction is outgoing
WithdrawalState *RevenueWithdrawalState `json:"withdrawal_state,omitempty"`
}
Describes a withdrawal transaction with Fragment.
type TransactionPartnerOther ¶
type TransactionPartnerOther struct {
// Type of the transaction partner, always “other”
Type string `json:"type"`
}
Describes a transaction with an unknown source or recipient.
type TransactionPartnerTelegramAds ¶
type TransactionPartnerTelegramAds struct {
// Type of the transaction partner, always “telegram_ads”
Type string `json:"type"`
}
Describes a withdrawal transaction to the Telegram Ads platform.
type TransactionPartnerTelegramApi ¶
type TransactionPartnerTelegramApi struct {
// Type of the transaction partner, always “telegram_api”
Type string `json:"type"`
// The number of successful requests that exceeded regular limits and were therefore billed
RequestCount int `json:"request_count"`
}
Describes a transaction with payment for https://core.telegram.org/bots/api#paid-broadcasts.
type TransactionPartnerUser ¶
type TransactionPartnerUser struct {
// Type of the transaction partner, always “user”
Type string `json:"type"`
// Type of the transaction, currently one of “invoice_payment” for payments via invoices,
// “paid_media_payment” for payments for paid media, “gift_purchase” for gifts sent by the bot,
// “premium_purchase” for Telegram Premium subscriptions gifted by the bot,
// “business_account_transfer” for direct transfers from managed business accounts
TransactionType string `json:"transaction_type"`
// Information about the user
User User `json:"user"`
// Optional. Information about the affiliate that received a commission via this transaction
Affiliate *AffiliateInfo `json:"affiliate,omitempty"`
// Optional. Bot-specified invoice payload
InvoicePayload *string `json:"invoice_payload,omitempty,"`
// Optional. The duration of the paid subscription
SubscriptionPeriod *int `json:"subscription_period"`
// Optional. Information about the paid media bought by the user
PaidMedia *[]PaidMedia `json:"paid_media,omitempty,"`
// Optional. Bot-specified paid media payload
PaidMediaPayload *string `json:"paid_media_payload,omitempty,"`
// Optional. The gift sent to the user by the bot
Gift *Gift `json:"gift,omitempty"`
// Optional. Number of months the gifted Telegram Premium subscription will be active for;
// for “premium_purchase” transactions only
PremiumSubscriptionPeriod *int `json:"premium_subscription_period"`
}
Describes a transaction with a user.
type UniqueGift ¶ added in v1.2.0
type UniqueGift struct {
// Human-readable name of the regular gift from which this unique gift was upgraded
BaseName string `json:"base_name"`
// Unique name of the gift. This name can be used in https://t.me/nft/... links and story areas
Name string `json:"name"`
// Unique number of the upgraded gift among gifts upgraded from the same regular gift
Number int `json:"number"`
// Model of the gift
Model UniqueGiftModel `json:"model"`
// Symbol of the gift
Symbol UniqueGiftSymbol `json:"symbol"`
// Backdrop of the gift
Backdrop UniqueGiftBackdrop `json:"backdrop"`
}
This object describes a unique gift that was upgraded from a regular gift.
type UniqueGiftBackdrop ¶ added in v1.2.0
type UniqueGiftBackdrop struct {
// Name of the backdrop
Name string `json:"name"`
// Colors of the backdrop
Colors UniqueGiftBackdropColors `json:"colors"`
// The number of unique gifts that receive this backdrop for every 1000 gifts upgraded
RarityPerMile int `json:"rarity_per_mile"`
}
This object describes the backdrop of a unique gift.
type UniqueGiftBackdropColors ¶ added in v1.2.0
type UniqueGiftBackdropColors struct {
// The color in the center of the backdrop in RGB format
CenterColor int `json:"center_color"`
// The color on the edges of the backdrop in RGB format
EdgeColor int `json:"edge_color"`
// The color to be applied to the symbol in RGB format
SymbolColor int `json:"symbol_color"`
// The color for the text on the backdrop in RGB format
TextColor int `json:"text_color"`
}
This object describes the colors of the backdrop of a unique gift.
type UniqueGiftInfo ¶ added in v1.2.0
type UniqueGiftInfo struct {
// Information about the gift
Gift UniqueGift `json:"gift"`
// Origin of the gift. Currently, either “upgrade” or “transfer”
Origin string `json:"origin"`
// Optional. Unique identifier of the received gift for the bot;
// only present for gifts received on behalf of business accounts
OwnedGiftId *string `json:"owned_gift_id,omitempty"`
// Optional. Number of Telegram Stars that must be paid to transfer the gift;
// omitted if the bot cannot transfer the gift
TransferStarCount *int `json:"transfer_star_count,omitempty"`
}
Describes a service message about a unique gift that was sent or received.
type UniqueGiftModel ¶ added in v1.2.0
type UniqueGiftModel struct {
// Name of the model
Name string `json:"name"`
// The sticker that represents the unique gift
Sticker Sticker `json:"sticker"`
// The number of unique gifts that receive this model for every 1000 gifts upgraded
RarityPerMile int `json:"rarity_per_mile"`
}
This object describes the model of a unique gift.
type UniqueGiftSymbol ¶ added in v1.2.0
type UniqueGiftSymbol struct {
// Name of the model
Name string `json:"name"`
// The sticker that represents the unique gift
Sticker Sticker `json:"sticker"`
// The number of unique gifts that receive this model for every 1000 gifts upgraded
RarityPerMile int `json:"rarity_per_mile"`
}
This object describes the symbol shown on the pattern of a unique gift.
type Update ¶
type Update struct {
// The update's unique identifier.
// Update identifiers start from a certain positive number and increase sequentially.
// This identifier becomes especially handy if you're using webhooks,
// since it allows you to ignore repeated updates or to restore the correct update sequence,
// should they get out of order.
// If there are no new updates for at least a week,
// then identifier of the next update will be chosen randomly instead of sequentially.
UpdateId int `json:"update_id"`
// Optional. New incoming message of any kind - text, photo, sticker, etc.
Message *Message `json:"message,omitempty"`
// Optional. New incoming channel post of any kind - text, photo, sticker, etc.
ChannelPost *Message `json:"channel_post,omitempty"`
// Optional. New version of a channel post that is known to the bot and was edited.
// This update may at times be triggered by changes to message fields
// that are either unavailable or not actively used by your bot.
EditedChannelPost *Message `json:"edited_channel_post,omitempty"`
// Optional. New version of a message that is known to the bot and was edited.
// This update may at times be triggered by changes to message fields
// that are either unavailable or not actively used by your bot.
EditedMessage *Message `json:"edited_message,omitempty"`
// Optional. The bot was connected to or disconnected from a business account,
// or a user edited an existing connection with the bot
BusinessConnection *BusinessConnection `json:"business_connection,omitempty"`
// Optional. New message from a connected business account
BusinessMessage *Message `json:"business_message,omitempty"`
// Optional. New version of a message from a connected business account
EditedBusinessMessage *Message `json:"edited_business_message,omitempty"`
// Optional. Messages were deleted from a connected business account
DeletedBusinessMessage *BusinessMessagesDeleted `json:"deleted_business_message,omitempty"`
// 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.
MessageReaction *MessageReactionUpdated `json:"message_reaction,omitempty"`
// 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.
// The updates are grouped and can be sent with delay up to a few minutes.
MessageReactionCount *MessageReactionCountUpdated `json:"message_reaction_count,omitempty"`
// Optional. New incoming inline query
InlineQuery *InlineQuery `json:"inline_query,omitempty"`
// Optional. The result of an inline query that was chosen by a user and sent to their chat partner.
// Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.
ChosenInlineQuery *ChosenInlineResult `json:"chosen_inline_query,omitempty"`
// Optional. New incoming callback query
CallbackQuery *CallbackQuery `json:"callback_query,omitempty"`
// Optional. New incoming shipping query. Only for invoices with flexible price
ShippingQuery *ShippingQuery `json:"shipping_query,omitempty"`
// Optional. A user purchased paid media with a non-empty payload sent by the bot in a non-channel chat
PurchasedPaidMedia *PaidMediaPurchased `json:"purchased_paid_media,omitempty"`
// Optional. New incoming pre-checkout query. Contains full information about checkout
PreCheckoutQuery *PreCheckoutQuery `json:"pre_checkout_query,omitempty"`
// Optional. New poll state. Bots receive only updates about manually stopped polls and polls, which are sent by the bot
Poll *Poll `json:"poll,omitempty"`
// Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.
PollAnswer *PollAnswer `json:"poll_answer,omitempty"`
// 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.
MyChatMember *ChatMemberUpdated `json:"my_chat_member,omitempty"`
// 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.
ChatMember *ChatMemberUpdated `json:"chat_member,omitempty"`
// Optional. A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates.
ChatJoinRequest *ChatJoinRequest `json:"chat_join_request,omitempty"`
// Optional. A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.
ChatBoost *ChatBoostUpdated `json:"chat_boost,omitempty"`
// Optional. A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates.
RemovedChatBoost *ChatBoostRemoved `json:"removed_chat_boost,omitempty"`
}
This object represents an incoming update. At most one of the optional parameters can be present in any given update.
type User ¶
type User struct {
// Unique identifier for this user or bot.
// 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.
Id int64 `json:"id"`
// User's or bot's first name
FirstName string `json:"first_name"`
// True, if this user is a bot
IsBot bool `json:"is_bot"`
// Optional. User's or bot's last name
LastName *string `json:"last_name,omitempty"`
// Optional. User's or bot's username
UserName *string `json:"user_name,omitempty"`
// Optional. IETF language tag of the user's language
LanguageCode *string `json:"language_code,omitempty"`
// Optional. True, if the bot can be invited to groups. Returned only in getMe.
CanJoinGroups *bool `json:"can_join_groups,omitempty"`
// Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.
CanReadAllGroupMessages *bool `json:"can_read_all_group_messages,omitempty"`
// Optional. True, if the bot supports inline queries. Returned only in getMe.
SupportInlineQueries *bool `json:"support_inline_queries,omitempty"`
// Optional. True, if this user is a Telegram Premium user
IsPremium *bool `json:"is_premium,omitempty"`
// Optional. True, if this user added the bot to the attachment menu
AddedToAttachmentMenu *bool `json:"added_to_attachment_menu,omitempty"`
// Optional. True, if the bot can be connected to a Telegram Business account to receive its messages. Returned only in getMe.
CanConnectToBusiness *bool `json:"can_connect_to_business,omitempty"`
// Optional. True, if the bot has a main Web App. Returned only in getMe.
HasMainWebApp *bool `json:"has_main_web_app,omitempty"`
}
This object represents a Telegram user or bot.
type UserChatBoosts ¶
type UserChatBoosts struct {
// The list of boosts added to the chat by the user
Boosts []ChatBoost `json:"boosts"`
}
This object represents a list of boosts added to a chat by a user.
type UserProfilePhotos ¶
type UserProfilePhotos struct {
// Total number of profile pictures the target user has
TotalCount int `json:"total_count"`
// Requested profile pictures (in up to 4 sizes each)
Photos [][]PhotoSize `json:"photos"`
}
This object represent a user's profile pictures.
type UsersShared ¶
type UsersShared struct {
RequestId string `json:"request_id"`
Users []SharedUser `json:"users"`
}
This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button.
type Venue ¶
type Venue struct {
// Venue location. Can't be a live location
Location Location `json:"location"`
// Name of the venue
Title string `json:"title"`
// Address of the venue
Address string `json:"address"`
// Optional. Foursquare identifier of the venue
FoursquareId *string `json:"foursquare_id,omitempty"`
//Optional. Foursquare type of the venue.
//(For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
FourSquareType *string `json:"four_square_type,omitempty"`
// Optional. Google Places identifier of the venue
GooglePlaceId *string `json:"google_place_id,omitempty"`
// Optional. Google Places type of the venue. (See supported types: https://developers.google.com/places/web-service/supported_types)
GooglePlaceType *string `json:"google_place_type,omitempty"`
}
This object represents a venue.
type Video ¶
type Video struct {
// Identifier for this file, which can be used to download or reuse the file
FileId string `json:"file_id"`
// 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.
FileUniqueId string `json:"file_unique_id"`
// Video width as defined by the sender
Width int `json:"width"`
// Video height as defined by the sender
Height int `json:"height"`
// Duration of the video in seconds as defined by the sender
Duration int `json:"duration"`
// Optional. Video thumbnail
Thumbnail *PhotoSize `json:"thumbnail,omitempty,"`
// Optional. Available sizes of the cover of the video in the message
Cover *[]PhotoSize `json:"cover,omitempty"`
// Optional. Timestamp in seconds from which the video will play in the message
StartTimestamp *int `json:"start_timestamp,omitempty"`
// Optional. Original filename as defined by the sender
FileName *string `json:"file_name,omitempty,"`
// Optional. MIME type of the file as defined by the sender
MimeType *string `json:"mime_type,omitempty,"`
// 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.
FileSize *int64 `json:"file_size,omitempty,"`
}
This object represents a video file.
type VideoChatEnded ¶
type VideoChatEnded struct {
// Video chat duration in seconds
Duration int `json:"duration"`
}
This object represents a service message about a video chat ended in the chat.
type VideoChatParticipantsInvited ¶
type VideoChatParticipantsInvited struct {
// New members that were invited to the video chat
Users []User `json:"users"`
}
This object represents a service message about new members invited to a video chat.
type VideoChatScheduled ¶
type VideoChatScheduled struct {
// Point in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator
StartDate int `json:"start_date"`
}
This object represents a service message about a video chat scheduled in the chat.
type VideoChatStarted ¶
type VideoChatStarted struct{}
This object represents a service message about a video chat started in the chat. Currently holds no information.
type VideoNote ¶
type VideoNote struct {
// Identifier for this file, which can be used to download or reuse the file
FileId string `json:"file_id"`
// 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.
FileUniqueId string `json:"file_unique_id"`
// Video width and height (diameter of the video message) as defined by the sender
Length int `json:"length"`
// Duration of the video in seconds as defined by the sender
Duration int `json:"duration"`
// Optional. Video thumbnail
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
// Optional. File size in bytes
FileSize *int `json:"file_size,omitempty"`
}
This object represents a video message (available in Telegram apps as of v.4.0).
type Voice ¶
type Voice struct {
// Identifier for this file, which can be used to download or reuse the file
FileId string `json:"file_id"`
// 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.
FileUniqueId string `json:"file_unique_id"`
// Duration of the audio in seconds as defined by the sender
Duration int `json:"duration"`
// Optional. MIME type of the file as defined by the sender
MimeType *string `json:"mime_type,omitempty"`
// 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.
FileSize *int `json:"file_size,omitempty"`
}
This object represents a voice note.
type WebAppData ¶
type WebAppData struct {
// The data. Be aware that a bad client can send arbitrary data in this field.
Data string `json:"data"`
// Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field.
ButtonText string `json:"button_text"`
}
Describes data sent from a Web App to the bot.
type WebAppInfo ¶
type WebAppInfo struct {
// An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps
Url string `json:"url"`
}
Describes a Web App.
func (WebAppInfo) Validate ¶
func (w WebAppInfo) Validate() error
type WriteAccessAllowed ¶
type WriteAccessAllowed struct {
// Optional. True, if the access was granted after the user accepted an explicit request from a Web App sent by the method requestWriteAccess
FromRequest *bool `json:"from_request,omitempty"`
// Optional. Name of the Web App, if the access was granted when the Web App was launched from a link
WebAppName *string `json:"web_app_name,omitempty"`
// Optional. True, if the access was granted when the bot was added to the attachment or side menu
FromAttachmentMenu *bool `json:"from_attachment_menu,omitempty"`
}
This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess.