gogram

package module
v0.0.0-...-2b08455 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 26, 2026 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

View Source
const (
	CommandStart    = "/start"
	CommandHelp     = "/help"
	CommandSettings = "/settings"
)
View Source
const (
	CommandMaxLen    = 32
	StartParamMaxLen = 64

	MessageMaxLen    = 4096
	CaptionMaxLen    = 1024
	MediaGroupMaxLen = 10
)
View Source
const (
	MessageEntityMention              = "mention"               // @username
	MessageEntityHashtag              = "hashtag"               // #hashtag or #hashtag@chatusername
	MessageEntityCashtag              = "cashtag"               // $USD or $USD@chatusername
	MessageEntityBotCommand           = "bot_command"           // /start@jobs_bot
	MessageEntityBotURL               = "url"                   // https://telegram.org
	MessageEntityEmail                = "email"                 // do-not-reply@telegram.org
	MessageEntityPhoneNumber          = "phone_number"          // +1-212-555-0123
	MessageEntityBold                 = "bold"                  // bold text
	MessageEntityItalic               = "italic"                // italic text
	MessageEntityUnderline            = "underline"             // underlined text
	MessageEntityStrikethrough        = "strikethrough"         // strikethrough text
	MessageEntitySpoiler              = "spoiler"               // spoiler message
	MessageEntityBlockquote           = "blockquote"            // block quotation
	MessageEntityExpandableBlockquote = "expandable_blockquote" // collapsed-by-default block quotation
	MessageEntityCode                 = "code"                  // monowidth string
	MessageEntityPre                  = "pre"                   // mmonowidth block
	MessageEntityTextLink             = "text_link"             // for clickable text URLs
	MessageEntityTextMention          = "text_mention"          // for users [without usernames]
	MessageEntityCustomEmoji          = "custom_emoji"          // for inline custom emoji stickers
)
View Source
const (
	ParseModeHTML       = "HTML"       // https://core.telegram.org/bots/api#html-style
	ParseModeMarkdown   = "Markdown"   // https://core.telegram.org/bots/api#markdown-style
	ParseModeMarkdownV2 = "MarkdownV2" // https://core.telegram.org/bots/api#markdownv2-style
)
View Source
const (
	ChatPrivate    = "private"
	ChatGroup      = "group"
	ChatSupergroup = "supergroup"
	ChatChannel    = "channel"
)
View Source
const (
	ChatActionTyping          = "typing"            // for text messages
	ChatActionUploadPhoto     = "upload_photo"      // for photos
	ChatActionRecordVideo     = "record_video"      // for videos
	ChatActionUploadVideo     = "upload_video"      // for videos
	ChatActionRecordVoice     = "record_voice"      // for voice notes
	ChatActionUploadVoice     = "upload_voice"      // for voice notes
	ChatActionUploadDocument  = "upload_document"   // for general files
	ChatActionChooseSticker   = "choose_sticker"    // for stickers
	ChatActionFindLocation    = "find_location"     // for location data
	ChatActionRecordVideoNote = "record_video_note" // for video notes.
	ChatActionUploadVideoNote = "upload_video_note" // for video notes.
)
View Source
const BusinessStartPayloadPrefix = "bizChat" // bizChat<user_chat_id>

Variables

View Source
var (
	ErrBadRequestWrongRemoteFileIdentifierSpecified = NewError(http.StatusBadRequest, "Bad Request: wrong remote file identifier specified: Wrong character in the string")
	ErrBadRequestCantUseFileOfTypeDocumentAsPhoto   = NewError(http.StatusBadRequest, "Bad Request: can't use file of type Document as Photo")
	// ErrBadRequestParticipantIDInvalid means what bot don`t meet this user yet (and can`t use his id in any request).
	ErrBadRequestParticipantIDInvalid = NewError(http.StatusBadRequest, "Bad Request: PARTICIPANT_ID_INVALID")
	ErrBadRequestChatNotFound         = NewError(http.StatusBadRequest, "Bad Request: chat not found")
	ErrBadRequestFileMustBeNonEmpty   = NewError(http.StatusBadRequest, "Bad Request: file must be non-empty")
)
View Source
var (
	ErrConflictWithBot = NewError(http.StatusConflict, "Conflict: terminated by other getUpdates request; make sure that only one bot instance is running")
)
View Source
var (
	ErrForbiddenBotWasBlockedByTheUser = NewError(http.StatusForbidden, "Forbidden: bot was blocked by the user")
)
View Source
var (
	ErrNotFoundBanned = NewError(http.StatusNotFound, "Contact https://t.me/BotSupport for assistance")
)
View Source
var RequiredCommands = [...]string{
	CommandStart,
	CommandHelp,
	CommandSettings,
}
View Source
var StartParamRegexp = regexp.MustCompile("[A-Za-z0-9_-]{1,64}")

Functions

func AsJSON

func AsJSON[T any](pointer *T) jsonWrapper[T]

func ConvertBytesToString

func ConvertBytesToString(b []byte) string

func ConvertStringToBytes

func ConvertStringToBytes(s string) []byte

func DownloadByFileID

func DownloadByFileID(client *Client, fileID, filePath string) error

func DownloadFile

func DownloadFile(client *Client, file *File, path string) error

func ExtractArgs

func ExtractArgs(text string) []string

func ExtractPayload

func ExtractPayload(text string) string

func NewError

func NewError(code int, text string) error

func ReceiveFileReader

func ReceiveFileReader(client *Client, file *File) (io.ReadCloser, error)

func ReceiveFileReaderByFileID

func ReceiveFileReaderByFileID(client *Client, fileID string) (io.ReadCloser, error)

Types

type APIError

type APIError struct {
	Err         error
	Description string
}

APIError with description.

func (*APIError) Error

func (e *APIError) Error() string

func (*APIError) Unwrap

func (e *APIError) Unwrap() error

type AcceptedGiftTypes

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"`

	// True, if transfers of unique gifts from channels are accepted
	GiftsFromChannels bool `json:"gifts_from_channels"`
}

AcceptedGiftTypes

This object describes the types of gifts that can be gifted to a user or a chat.

type AddStickerToSetOption

type AddStickerToSetOption func(params *AddStickerToSetParams) AddStickerToSetOption

func WithAddStickerToSetName

func WithAddStickerToSetName(value string) AddStickerToSetOption

Sticker set name

func WithAddStickerToSetSticker

func WithAddStickerToSetSticker(value InputSticker) AddStickerToSetOption

A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.

func WithAddStickerToSetUserID

func WithAddStickerToSetUserID(value int64) AddStickerToSetOption

User identifier of sticker set owner

type AddStickerToSetParams

type AddStickerToSetParams struct {
	// User identifier of sticker set owner
	UserID int64 `json:"user_id"`

	// Sticker set name
	Name string `json:"name"`

	// A JSON-serialized object with information about the added sticker.
	// If exactly the same sticker had already been added to the set, then the set isn't changed.
	Sticker InputSticker `json:"sticker"`
}

func (*AddStickerToSetParams) Option

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
	CommissionPerMille int64 `json:"commission_per_mille"`

	// Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds
	Amount int64 `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 int64 `json:"nanostar_amount,omitempty"`
}

AffiliateInfo

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 int64 `json:"width"`

	// Video height as defined by the sender
	Height int64 `json:"height"`

	// Duration of the video in seconds as defined by the sender
	Duration int64 `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"`
}

Animation

This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).

type AnswerCallbackQueryOption

type AnswerCallbackQueryOption func(params *AnswerCallbackQueryParams) AnswerCallbackQueryOption

func WithAnswerCallbackQueryCacheTime

func WithAnswerCallbackQueryCacheTime(value int64) AnswerCallbackQueryOption

The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.

func WithAnswerCallbackQueryCallbackQueryID

func WithAnswerCallbackQueryCallbackQueryID(value string) AnswerCallbackQueryOption

Unique identifier for the query to be answered

func WithAnswerCallbackQueryShowAlert

func WithAnswerCallbackQueryShowAlert(value bool) AnswerCallbackQueryOption

If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.

func WithAnswerCallbackQueryText

func WithAnswerCallbackQueryText(value string) AnswerCallbackQueryOption

Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters

func WithAnswerCallbackQueryURL

func WithAnswerCallbackQueryURL(value string) AnswerCallbackQueryOption

URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button.

Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.

type AnswerCallbackQueryParams

type AnswerCallbackQueryParams struct {
	// Unique identifier for the query to be answered
	CallbackQueryID string `json:"callback_query_id"`

	// Text of the notification.
	// If not specified, nothing will be shown to the user, 0-200 characters
	Text string `json:"text,omitempty"`

	// If True, an alert will be shown by the client instead of a notification at the top of the chat screen.
	// Defaults to false.
	ShowAlert bool `json:"show_alert,omitempty"`

	// URL that will be opened by the user's client.
	// If you have created a [Game] and accepted the conditions via [@BotFather], specify the URL that opens your game - note that this will only work if the query comes from a [callback_game] button.
	//
	// Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
	//
	// [Game]: https://core.telegram.org/bots/api#game
	// [@BotFather]: https://t.me/botfather
	// [callback_game]: https://core.telegram.org/bots/api#inlinekeyboardbutton
	URL string `json:"url,omitempty"`

	// The maximum amount of time in seconds that the result of the callback query may be cached client-side.
	// Telegram apps will support caching starting in version 3.14.
	// Defaults to 0.
	CacheTime int64 `json:"cache_time,omitempty"`
}

func (*AnswerCallbackQueryParams) Option

type AnswerInlineQueryOption

type AnswerInlineQueryOption func(params *AnswerInlineQueryParams) AnswerInlineQueryOption

func WithAnswerInlineQueryButton

func WithAnswerInlineQueryButton(value *InlineQueryResultsButton) AnswerInlineQueryOption

A JSON-serialized object describing a button to be shown above inline query results

func WithAnswerInlineQueryCacheTime

func WithAnswerInlineQueryCacheTime(value int64) AnswerInlineQueryOption

The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.

func WithAnswerInlineQueryInlineQueryID

func WithAnswerInlineQueryInlineQueryID(value string) AnswerInlineQueryOption

Unique identifier for the answered query

func WithAnswerInlineQueryIsPersonal

func WithAnswerInlineQueryIsPersonal(value bool) AnswerInlineQueryOption

Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.

func WithAnswerInlineQueryNextOffset

func WithAnswerInlineQueryNextOffset(value string) AnswerInlineQueryOption

Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes.

func WithAnswerInlineQueryResults

func WithAnswerInlineQueryResults(value []InlineQueryResult) AnswerInlineQueryOption

A JSON-serialized array of results for the inline query

type AnswerInlineQueryParams

type AnswerInlineQueryParams struct {
	// Unique identifier for the answered query
	InlineQueryID string `json:"inline_query_id"`

	// A JSON-serialized array of results for the inline query
	Results []InlineQueryResult `json:"results"`

	// The maximum amount of time in seconds that the result of the inline query may be cached on the server.
	// Defaults to 300.
	CacheTime int64 `json:"cache_time,omitempty"`

	// Pass True if results may be cached on the server side only for the user that sent the query.
	// By default, results may be returned to any user who sends the same query.
	IsPersonal bool `json:"is_personal,omitempty"`

	// Pass the offset that a client should send in the next query with the same text to receive more results.
	// Pass an empty string if there are no more results or if you don't support pagination.
	// Offset length can't exceed 64 bytes.
	NextOffset string `json:"next_offset,omitempty"`

	// A JSON-serialized object describing a button to be shown above inline query results
	Button *InlineQueryResultsButton `json:"button,omitempty"`
}

func (*AnswerInlineQueryParams) Option

type AnswerPreCheckoutQueryOption

type AnswerPreCheckoutQueryOption func(params *AnswerPreCheckoutQueryParams) AnswerPreCheckoutQueryOption

func WithAnswerPreCheckoutQueryErrorMessage

func WithAnswerPreCheckoutQueryErrorMessage(value string) AnswerPreCheckoutQueryOption

Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.

func WithAnswerPreCheckoutQueryOk

func WithAnswerPreCheckoutQueryOk(value bool) AnswerPreCheckoutQueryOption

Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.

func WithAnswerPreCheckoutQueryPreCheckoutQueryID

func WithAnswerPreCheckoutQueryPreCheckoutQueryID(value string) AnswerPreCheckoutQueryOption

Unique identifier for the query to be answered

type AnswerPreCheckoutQueryParams

type AnswerPreCheckoutQueryParams struct {
	// Unique identifier for the query to be answered
	PreCheckoutQueryID string `json:"pre_checkout_query_id"`

	// Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order.
	// Use False if there are any problems.
	Ok bool `json:"ok"`

	// Required if ok is False.
	// Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g.
	// "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details.
	// Please choose a different color or garment!").
	// Telegram will display this message to the user.
	ErrorMessage string `json:"error_message,omitempty"`
}

func (*AnswerPreCheckoutQueryParams) Option

type AnswerShippingQueryOption

type AnswerShippingQueryOption func(params *AnswerShippingQueryParams) AnswerShippingQueryOption

func WithAnswerShippingQueryErrorMessage

func WithAnswerShippingQueryErrorMessage(value string) AnswerShippingQueryOption

Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”). Telegram will display this message to the user.

func WithAnswerShippingQueryOk

func WithAnswerShippingQueryOk(value bool) AnswerShippingQueryOption

Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)

func WithAnswerShippingQueryShippingOptions

func WithAnswerShippingQueryShippingOptions(value []ShippingOption) AnswerShippingQueryOption

Required if ok is True. A JSON-serialized array of available shipping options.

func WithAnswerShippingQueryShippingQueryID

func WithAnswerShippingQueryShippingQueryID(value string) AnswerShippingQueryOption

Unique identifier for the query to be answered

type AnswerShippingQueryParams

type AnswerShippingQueryParams struct {
	// Unique identifier for the query to be answered
	ShippingQueryID string `json:"shipping_query_id"`

	// Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)
	Ok bool `json:"ok"`

	// Required if ok is True.
	// A JSON-serialized array of available shipping options.
	ShippingOptions []ShippingOption `json:"shipping_options,omitempty"`

	// Required if ok is False.
	// Error message in human readable form that explains why it is impossible to complete the order (e.g.
	// “Sorry, delivery to your desired address is unavailable”).
	// Telegram will display this message to the user.
	ErrorMessage string `json:"error_message,omitempty"`
}

func (*AnswerShippingQueryParams) Option

type AnswerWebAppQueryOption

type AnswerWebAppQueryOption func(params *AnswerWebAppQueryParams) AnswerWebAppQueryOption

func WithAnswerWebAppQueryResult

func WithAnswerWebAppQueryResult(value InlineQueryResult) AnswerWebAppQueryOption

A JSON-serialized object describing the message to be sent

func WithAnswerWebAppQueryWebAppQueryID

func WithAnswerWebAppQueryWebAppQueryID(value string) AnswerWebAppQueryOption

Unique identifier for the query to be answered

type AnswerWebAppQueryParams

type AnswerWebAppQueryParams struct {
	// Unique identifier for the query to be answered
	WebAppQueryID string `json:"web_app_query_id"`

	// A JSON-serialized object describing the message to be sent
	Result InlineQueryResult `json:"result"`
}

func (*AnswerWebAppQueryParams) Option

type ApproveChatJoinRequestOption

type ApproveChatJoinRequestOption func(params *ApproveChatJoinRequestParams) ApproveChatJoinRequestOption

func WithApproveChatJoinRequestChatID

func WithApproveChatJoinRequestChatID(value string) ApproveChatJoinRequestOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithApproveChatJoinRequestUserID

func WithApproveChatJoinRequestUserID(value int64) ApproveChatJoinRequestOption

Unique identifier of the target user

type ApproveChatJoinRequestParams

type ApproveChatJoinRequestParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier of the target user
	UserID int64 `json:"user_id"`
}

func (*ApproveChatJoinRequestParams) Option

type ApproveSuggestedPostOption

type ApproveSuggestedPostOption func(params *ApproveSuggestedPostParams) ApproveSuggestedPostOption

func WithApproveSuggestedPostChatID

func WithApproveSuggestedPostChatID(value int64) ApproveSuggestedPostOption

Unique identifier for the target direct messages chat

func WithApproveSuggestedPostMessageID

func WithApproveSuggestedPostMessageID(value int64) ApproveSuggestedPostOption

Identifier of a suggested post message to approve

func WithApproveSuggestedPostSendDate

func WithApproveSuggestedPostSendDate(value int64) ApproveSuggestedPostOption

Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future

type ApproveSuggestedPostParams

type ApproveSuggestedPostParams struct {
	// Unique identifier for the target direct messages chat
	ChatID int64 `json:"chat_id"`

	// Identifier of a suggested post message to approve
	MessageID int64 `json:"message_id"`

	// Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created.
	// If specified, then the date must be not more than 2678400 seconds (30 days) in the future
	SendDate int64 `json:"send_date,omitempty"`
}

func (*ApproveSuggestedPostParams) Option

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 int64 `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"`
}

Audio

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

type BackgroundFill

BackgroundFill

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) MarshalJSON

func (r *BackgroundFill) MarshalJSON() ([]byte, error)

func (*BackgroundFill) UnmarshalJSON

func (r *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 []int64 `json:"colors"`
}

BackgroundFillFreeformGradient

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 int64 `json:"top_color"`

	// Bottom color of the gradient in the RGB24 format
	BottomColor int64 `json:"bottom_color"`

	// Clockwise rotation angle of the background fill in degrees; 0-359
	RotationAngle int64 `json:"rotation_angle"`
}

BackgroundFillGradient

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 int64 `json:"color"`
}

BackgroundFillSolid

The background is filled using the selected color.

type BackgroundType

BackgroundType

This object describes the type of a background. Currently, it can be one of

BackgroundTypeFill

BackgroundTypeWallpaper

BackgroundTypePattern

BackgroundTypeChatTheme

func (*BackgroundType) MarshalJSON

func (r *BackgroundType) MarshalJSON() ([]byte, error)

func (*BackgroundType) UnmarshalJSON

func (r *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"`
}

BackgroundTypeChatTheme

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 int64 `json:"dark_theme_dimming"`
}

BackgroundTypeFill

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 int64 `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"`
}

BackgroundTypePattern

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 int64 `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"`
}

BackgroundTypeWallpaper

The background is a wallpaper in the JPEG format.

type BanChatMemberOption

type BanChatMemberOption func(params *BanChatMemberParams) BanChatMemberOption

func WithBanChatMemberChatID

func WithBanChatMemberChatID(value string) BanChatMemberOption

Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)

func WithBanChatMemberRevokeMessages

func WithBanChatMemberRevokeMessages(value bool) BanChatMemberOption

Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.

func WithBanChatMemberUntilDate

func WithBanChatMemberUntilDate(value int64) BanChatMemberOption

Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.

func WithBanChatMemberUserID

func WithBanChatMemberUserID(value int64) BanChatMemberOption

Unique identifier of the target user

type BanChatMemberParams

type BanChatMemberParams struct {
	// Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// Date when the user will be unbanned; Unix time.
	// If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever.
	// Applied for supergroups and channels only.
	UntilDate int64 `json:"until_date,omitempty"`

	// Pass True to delete all messages from the chat for the user that is being removed.
	// If False, the user will be able to see messages in the group that were sent before the user was removed.
	// Always True for supergroups and channels.
	RevokeMessages bool `json:"revoke_messages,omitempty"`
}

func (*BanChatMemberParams) Option

func (r *BanChatMemberParams) Option(opts ...BanChatMemberOption) (previous BanChatMemberOption)

type BanChatSenderChatOption

type BanChatSenderChatOption func(params *BanChatSenderChatParams) BanChatSenderChatOption

func WithBanChatSenderChatChatID

func WithBanChatSenderChatChatID(value string) BanChatSenderChatOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithBanChatSenderChatSenderChatID

func WithBanChatSenderChatSenderChatID(value int64) BanChatSenderChatOption

Unique identifier of the target sender chat

type BanChatSenderChatParams

type BanChatSenderChatParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier of the target sender chat
	SenderChatID int64 `json:"sender_chat_id"`
}

func (*BanChatSenderChatParams) Option

type Birthdate

type Birthdate struct {
	// Day of the user's birth; 1-31
	Day int64 `json:"day"`

	// Month of the user's birth; 1-12
	Month int64 `json:"month"`

	// Optional.
	// Year of the user's birth
	Year int64 `json:"year,omitempty"`
}

Birthdate

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"`
}

BotCommand

This object represents a bot command.

type BotCommandScopeAllChatAdministrators

type BotCommandScopeAllChatAdministrators struct {
	// Scope type, must be all_chat_administrators
	Type string `json:"type"`
}

BotCommandScopeAllChatAdministrators

Represents the scope of bot commands, covering all group and supergroup chat administrators.

type BotCommandScopeAllGroupChats

type BotCommandScopeAllGroupChats struct {
	// Scope type, must be all_group_chats
	Type string `json:"type"`
}

BotCommandScopeAllGroupChats

Represents the scope of bot commands, covering all group and supergroup chats.

type BotCommandScopeAllPrivateChats

type BotCommandScopeAllPrivateChats struct {
	// Scope type, must be all_private_chats
	Type string `json:"type"`
}

BotCommandScopeAllPrivateChats

Represents the scope of bot commands, covering all private chats.

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).
	// Channel direct messages chats and channel chats aren't supported.
	ChatID string `json:"chat_id"`
}

BotCommandScopeChat

Represents the scope of bot commands, covering a specific chat.

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).
	// Channel direct messages chats and channel chats aren't supported.
	ChatID string `json:"chat_id"`
}

BotCommandScopeChatAdministrators

Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.

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).
	// Channel direct messages chats and channel chats aren't supported.
	ChatID string `json:"chat_id"`

	// Unique identifier of the target user
	UserID int64 `json:"user_id"`
}

BotCommandScopeChatMember

Represents the scope of bot commands, covering a specific member of a group or supergroup chat.

type BotCommandScopeDefault

type BotCommandScopeDefault struct {
	// Scope type, must be default
	Type string `json:"type"`
}

BotCommandScopeDefault

Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.

type BotDescription

type BotDescription struct {
	// The bot's description
	Description string `json:"description"`
}

BotDescription

This object represents the bot's description.

type BotName

type BotName struct {
	// The bot's name
	Name string `json:"name"`
}

BotName

This object represents the bot's name.

type BotShortDescription

type BotShortDescription struct {
	// The bot's short description
	ShortDescription string `json:"short_description"`
}

BotShortDescription

This object represents the bot's short description.

type BusinessBotRights

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
	CanDeleteSentMessages bool `json:"can_delete_sent_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
	CanConvertGiftsToStars bool `json:"can_convert_gifts_to_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"`
}

BusinessBotRights

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 int64 `json:"user_chat_id"`

	// Date the connection was established in Unix time
	Date int64 `json:"date"`

	// Optional.
	// Rights of the business bot
	Rights *BusinessBotRights `json:"rights,omitempty"`

	// True, if the connection is active
	IsEnabled bool `json:"is_enabled"`
}

BusinessConnection

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"`
}

BusinessIntro

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"`
}

BusinessLocation

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 []int64 `json:"message_ids"`
}

BusinessMessagesDeleted

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
	TimeZoneName string `json:"time_zone_name"`

	// List of time intervals describing business opening hours
	OpeningHours []BusinessOpeningHoursInterval `json:"opening_hours"`
}

BusinessOpeningHours

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 int64 `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 int64 `json:"closing_minute"`
}

BusinessOpeningHoursInterval

Describes an interval of time during which a business is open.

type CallbackGame

type CallbackGame struct {
}

CallbackGame

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].
	//
	// [games]: https://core.telegram.org/bots/api#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
	//
	// [Game]: https://core.telegram.org/bots/api#games
	GameShortName string `json:"game_short_name,omitempty"`
}

CallbackQuery

This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.

func (*CallbackQuery) Args

func (cq *CallbackQuery) Args() []string

func (*CallbackQuery) Payload

func (cq *CallbackQuery) Payload() string

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:"username,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)
	//
	// [topics]: https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups
	IsForum bool `json:"is_forum,omitempty"`

	// Optional.
	// True, if the chat is the direct messages chat of a channel
	IsDirectMessages bool `json:"is_direct_messages,omitempty"`
}

Chat

This object represents a chat.

func (*Chat) Identifier

func (c *Chat) Identifier() string

func (*Chat) IsChannel

func (c *Chat) IsChannel() bool

func (*Chat) IsGroup

func (c *Chat) IsGroup() bool

func (*Chat) IsPrivate

func (c *Chat) IsPrivate() bool

func (*Chat) IsSupergroup

func (c *Chat) IsSupergroup() bool

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, ignore slow mode, and send messages to the chat without paying Telegram Stars.
	// 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, approve suggested posts, 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.
	// True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only
	CanManageDirectMessages bool `json:"can_manage_direct_messages,omitempty"`
}

ChatAdministratorRights

Represents the rights of an administrator in a chat.

type ChatBackground

type ChatBackground struct {
	// Type of the background
	Type BackgroundType `json:"type"`
}

ChatBackground

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 int64 `json:"add_date"`

	// Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged
	ExpirationDate int64 `json:"expiration_date"`

	// Source of the added boost
	Source ChatBoostSource `json:"source"`
}

ChatBoost

This object contains information about a chat boost.

type ChatBoostAdded

type ChatBoostAdded struct {
	// Number of boosts added by the user
	BoostCount int64 `json:"boost_count"`
}

ChatBoostAdded

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 int64 `json:"remove_date"`

	// Source of the removed boost
	Source ChatBoostSource `json:"source"`
}

ChatBoostRemoved

This object represents a boost removed from a chat.

type ChatBoostSource

ChatBoostSource

This object describes the source of a chat boost. It can be one of

ChatBoostSourcePremium

ChatBoostSourceGiftCode

ChatBoostSourceGiveaway

func (*ChatBoostSource) MarshalJSON

func (r *ChatBoostSource) MarshalJSON() ([]byte, error)

func (*ChatBoostSource) UnmarshalJSON

func (r *ChatBoostSource) UnmarshalJSON(data []byte) error

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"`
}

ChatBoostSourceGiftCode

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 int64 `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 int64 `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"`
}

ChatBoostSourceGiveaway

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"`
}

ChatBoostSourcePremium

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"`
}

ChatBoostUpdated

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:"username,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)
	//
	// [topics]: https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups
	IsForum bool `json:"is_forum,omitempty"`

	// Optional.
	// True, if the chat is the direct messages chat of a channel
	IsDirectMessages bool `json:"is_direct_messages,omitempty"`

	// Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview.
	// See [accent colors] for more details.
	//
	// [accent colors]: https://core.telegram.org/bots/api#accent-colors
	AccentColorID int64 `json:"accent_color_id"`

	// The maximum number of reactions that can be set on a message in the chat
	MaxReactionCount int64 `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
	//
	// [active chat usernames]: https://telegram.org/blog/topics-in-groups-collectible-usernames#collectible-usernames
	ActiveUsernames []string `json:"active_usernames,omitempty"`

	// Optional.
	// For private chats, the date of birth of the user
	Birthdate *Birthdate `json:"birthdate,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.
	// Information about the corresponding channel chat; for direct messages chats only
	ParentChat *Chat `json:"parent_chat,omitempty"`

	// Optional.
	// List of available reactions allowed in the chat.
	// If omitted, then all [emoji reactions] are allowed.
	//
	// [emoji reactions]: https://core.telegram.org/bots/api#reactiontypeemoji
	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 [profile accent colors] for more details.
	//
	// [profile accent colors]: https://core.telegram.org/bots/api#profile-accent-colors
	ProfileAccentColorID int64 `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 int64 `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 int64 `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 int64 `json:"unrestrict_boost_count,omitempty"`

	// Optional.
	// The time after which all messages sent to the chat will be automatically deleted; in seconds
	MessageAutoDeleteTime int64 `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 bool `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
	HasProtectedContent bool `json:"has_protected_content,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"`

	// Optional.
	// For private chats, the rating of the user if any
	Rating *UserRating `json:"rating,omitempty"`

	// Optional.
	// For private chats, the first audio added to the profile of the user
	FirstProfileAudio *Audio `json:"first_profile_audio,omitempty"`

	// Optional.
	// The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews
	UniqueGiftColors *UniqueGiftColors `json:"unique_gift_colors,omitempty"`

	// Optional.
	// The number of Telegram Stars a general user have to pay to send a message to the chat
	PaidMessageStarCount int64 `json:"paid_message_star_count,omitempty"`
}

ChatFullInfo

This object contains full information about a chat.

func (*ChatFullInfo) Identifier

func (c *ChatFullInfo) Identifier() string
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 int64 `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 int64 `json:"member_limit,omitempty"`

	// Optional.
	// Number of pending join requests created using this link
	PendingJoinRequestCount int64 `json:"pending_join_request_count,omitempty"`

	// Optional.
	// The number of seconds the subscription will be active for before the next payment
	SubscriptionPeriod int64 `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 int64 `json:"subscription_price,omitempty"`
}

ChatInviteLink

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
	From User `json:"from"`

	// 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 int64 `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"`
}

ChatJoinRequest

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"`
}

ChatLocation

Represents a location to which a chat is connected.

type ChatMember

ChatMember

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) MarshalJSON

func (r *ChatMember) MarshalJSON() ([]byte, error)

func (*ChatMember) UnmarshalJSON

func (r *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, ignore slow mode, and send messages to the chat without paying Telegram Stars.
	// 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, approve suggested posts, 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.
	// True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only
	CanManageDirectMessages bool `json:"can_manage_direct_messages,omitempty"`

	// Optional.
	// Custom title for this user
	CustomTitle string `json:"custom_title,omitempty"`
}

ChatMemberAdministrator

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 int64 `json:"until_date"`
}

ChatMemberBanned

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"`
}

ChatMemberLeft

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 int64 `json:"until_date,omitempty"`
}

ChatMemberMember

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"`
}

ChatMemberOwner

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 and checklists
	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_web_page_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 int64 `json:"until_date"`
}

ChatMemberRestricted

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 int64 `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"`
}

ChatMemberUpdated

This object represents changes in the status of a chat member.

type ChatOwnerChanged

type ChatOwnerChanged struct {
	// The new owner of the chat
	NewOwner User `json:"new_owner"`
}

ChatOwnerChanged

Describes a service message about an ownership change in the chat.

type ChatOwnerLeft

type ChatOwnerLeft struct {
	// Optional.
	// The user which will be the new owner of the chat if the previous owner does not return to the chat
	NewOwner *User `json:"new_owner,omitempty"`
}

ChatOwnerLeft

Describes a service message about the chat owner leaving the chat.

type ChatPermissions

type ChatPermissions struct {
	// Optional.
	// 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"`

	// Optional.
	// True, if the user is allowed to send audios
	CanSendAudios bool `json:"can_send_audios,omitempty"`

	// Optional.
	// True, if the user is allowed to send documents
	CanSendDocuments bool `json:"can_send_documents,omitempty"`

	// Optional.
	// True, if the user is allowed to send photos
	CanSendPhotos bool `json:"can_send_photos,omitempty"`

	// Optional.
	// True, if the user is allowed to send videos
	CanSendVideos bool `json:"can_send_videos,omitempty"`

	// Optional.
	// True, if the user is allowed to send video notes
	CanSendVideoNotes bool `json:"can_send_video_notes,omitempty"`

	// Optional.
	// True, if the user is allowed to send voice notes
	CanSendVoiceNotes bool `json:"can_send_voice_notes,omitempty"`

	// Optional.
	// True, if the user is allowed to send polls and checklists
	CanSendPolls bool `json:"can_send_polls,omitempty"`

	// Optional.
	// True, if the user is allowed to send animations, games, stickers and use inline bots
	CanSendOtherMessages bool `json:"can_send_other_messages,omitempty"`

	// Optional.
	// True, if the user is allowed to add web page previews to their messages
	CanAddWebPagePreviews bool `json:"can_add_web_page_previews,omitempty"`

	// Optional.
	// True, if the user is allowed to change the chat title, photo and other settings.
	// Ignored in public supergroups
	CanChangeInfo bool `json:"can_change_info,omitempty"`

	// Optional.
	// True, if the user is allowed to invite new users to the chat
	CanInviteUsers bool `json:"can_invite_users,omitempty"`

	// Optional.
	// True, if the user is allowed to pin messages.
	// Ignored in public supergroups
	CanPinMessages bool `json:"can_pin_messages,omitempty"`

	// Optional.
	// True, if the user is allowed to create forum topics.
	// If omitted defaults to the value of can_pin_messages
	CanManageTopics bool `json:"can_manage_topics,omitempty"`
}

ChatPermissions

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"`
}

ChatPhoto

This object represents a chat photo.

type ChatShared

type ChatShared struct {
	// Identifier of the request
	RequestID int64 `json:"request_id"`

	// Identifier of the shared 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 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"`

	// Optional.
	// Title of the chat, if the title was requested by the bot.
	Title string `json:"title,omitempty"`

	// Optional.
	// Username of the chat, if the username was requested by the bot and available.
	Username string `json:"username,omitempty"`

	// Optional.
	// Available sizes of the chat photo, if the photo was requested by the bot
	Photo []PhotoSize `json:"photo,omitempty"`
}

ChatShared

This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.

type Checklist

type Checklist struct {
	// Title of the checklist
	Title string `json:"title"`

	// Optional.
	// Special entities that appear in the checklist title
	TitleEntities []MessageEntity `json:"title_entities,omitempty"`

	// List of tasks in the checklist
	Tasks []ChecklistTask `json:"tasks"`

	// Optional.
	// True, if users other than the creator of the list can add tasks to the list
	OthersCanAddTasks bool `json:"others_can_add_tasks,omitempty"`

	// Optional.
	// True, if users other than the creator of the list can mark tasks as done or not done
	OthersCanMarkTasksAsDone bool `json:"others_can_mark_tasks_as_done,omitempty"`
}

Checklist

Describes a checklist.

type ChecklistTask

type ChecklistTask struct {
	// Unique identifier of the task
	ID int64 `json:"id"`

	// Text of the task
	Text string `json:"text"`

	// Optional.
	// Special entities that appear in the task text
	TextEntities []MessageEntity `json:"text_entities,omitempty"`

	// Optional.
	// User that completed the task; omitted if the task wasn't completed by a user
	CompletedByUser *User `json:"completed_by_user,omitempty"`

	// Optional.
	// Chat that completed the task; omitted if the task wasn't completed by a chat
	CompletedByChat *Chat `json:"completed_by_chat,omitempty"`

	// Optional.
	// Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed
	CompletionDate int64 `json:"completion_date,omitempty"`
}

ChecklistTask

Describes a task in a checklist.

type ChecklistTasksAdded

type ChecklistTasksAdded struct {
	// Optional.
	// Message containing the checklist to which the tasks were added.
	// Note that the [Message] object in this field will not contain the reply_to_message field even if it itself is a reply.
	//
	// [Message]: https://core.telegram.org/bots/api#message
	ChecklistMessage *Message `json:"checklist_message,omitempty"`

	// List of tasks added to the checklist
	Tasks []ChecklistTask `json:"tasks"`
}

ChecklistTasksAdded

Describes a service message about tasks added to a checklist.

type ChecklistTasksDone

type ChecklistTasksDone struct {
	// Optional.
	// Message containing the checklist whose tasks were marked as done or not done.
	// Note that the [Message] object in this field will not contain the reply_to_message field even if it itself is a reply.
	//
	// [Message]: https://core.telegram.org/bots/api#message
	ChecklistMessage *Message `json:"checklist_message,omitempty"`

	// Optional.
	// Identifiers of the tasks that were marked as done
	MarkedAsDoneTaskIDs []int64 `json:"marked_as_done_task_ids,omitempty"`

	// Optional.
	// Identifiers of the tasks that were marked as not done
	MarkedAsNotDoneTaskIDs []int64 `json:"marked_as_not_done_task_ids,omitempty"`
}

ChecklistTasksDone

Describes a service message about checklist tasks marked as done or not done.

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.
	//
	// [inline keyboard]: https://core.telegram.org/bots/api#inlinekeyboardmarkup
	// [callback queries]: https://core.telegram.org/bots/api#callbackquery
	// [edit]: https://core.telegram.org/bots/api#updating-messages
	InlineMessageID string `json:"inline_message_id,omitempty"`

	// The query that was used to obtain the result
	Query string `json:"query"`
}

ChosenInlineResult

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 Client

type Client struct {
	// contains filtered or unexported fields
}

Client

https://core.telegram.org/bots/api

https://core.telegram.org/bots/webapps

func NewClient

func NewClient(token string, opts ...ClientOption) (*Client, error)

func (*Client) AddStickerToSet

func (c *Client) AddStickerToSet(params *AddStickerToSetParams) (ret bool, err error)

AddStickerToSet

Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.

func (*Client) AnswerCallbackQuery

func (c *Client) AnswerCallbackQuery(params *AnswerCallbackQueryParams) (ret bool, err error)

AnswerCallbackQuery

Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.

func (*Client) AnswerInlineQuery

func (c *Client) AnswerInlineQuery(params *AnswerInlineQueryParams) (ret bool, err error)

AnswerInlineQuery

Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed.

func (*Client) AnswerPreCheckoutQuery

func (c *Client) AnswerPreCheckoutQuery(params *AnswerPreCheckoutQueryParams) (ret bool, err error)

AnswerPreCheckoutQuery

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

func (*Client) AnswerShippingQuery

func (c *Client) AnswerShippingQuery(params *AnswerShippingQueryParams) (ret bool, err error)

AnswerShippingQuery

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

func (*Client) AnswerWebAppQuery

func (c *Client) AnswerWebAppQuery(params *AnswerWebAppQueryParams) (ret *SentWebAppMessage, err error)

AnswerWebAppQuery

Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.

func (*Client) ApproveChatJoinRequest

func (c *Client) ApproveChatJoinRequest(params *ApproveChatJoinRequestParams) (ret bool, err error)

ApproveChatJoinRequest

Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

func (*Client) ApproveSuggestedPost

func (c *Client) ApproveSuggestedPost(params *ApproveSuggestedPostParams) (ret bool, err error)

ApproveSuggestedPost

Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.

func (*Client) BanChatMember

func (c *Client) BanChatMember(params *BanChatMemberParams) (ret bool, err error)

BanChatMember

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Client) BanChatSenderChat

func (c *Client) BanChatSenderChat(params *BanChatSenderChatParams) (ret bool, err error)

BanChatSenderChat

Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Client) Close

func (c *Client) Close(params *CloseParams) (ret bool, err error)

Close

Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

func (*Client) CloseForumTopic

func (c *Client) CloseForumTopic(params *CloseForumTopicParams) (ret bool, err error)

CloseForumTopic

Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

func (*Client) CloseGeneralForumTopic

func (c *Client) CloseGeneralForumTopic(params *CloseGeneralForumTopicParams) (ret bool, err error)

CloseGeneralForumTopic

Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

func (*Client) ConvertGiftToStars

func (c *Client) ConvertGiftToStars(params *ConvertGiftToStarsParams) (ret bool, err error)

ConvertGiftToStars

Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.

func (*Client) CopyMessage

func (c *Client) CopyMessage(params *CopyMessageParams) (ret *MessageId, err error)

CopyMessage

Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.

func (*Client) CopyMessages

func (c *Client) CopyMessages(params *CopyMessagesParams) (ret *MessageId, err error)

CopyMessages

Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.

func (c *Client) CreateChatInviteLink(params *CreateChatInviteLinkParams) (ret *ChatInviteLink, err error)

CreateChatInviteLink

Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

func (c *Client) CreateChatSubscriptionInviteLink(params *CreateChatSubscriptionInviteLinkParams) (ret *ChatInviteLink, err error)

CreateChatSubscriptionInviteLink

Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.

func (*Client) CreateForumTopic

func (c *Client) CreateForumTopic(params *CreateForumTopicParams) (ret *ForumTopic, err error)

CreateForumTopic

Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.

func (c *Client) CreateInvoiceLink(params *CreateInvoiceLinkParams) (ret string, err error)

CreateInvoiceLink

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

func (*Client) CreateNewStickerSet

func (c *Client) CreateNewStickerSet(params *CreateNewStickerSetParams) (ret bool, err error)

CreateNewStickerSet

Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.

func (*Client) DeclineChatJoinRequest

func (c *Client) DeclineChatJoinRequest(params *DeclineChatJoinRequestParams) (ret bool, err error)

DeclineChatJoinRequest

Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

func (*Client) DeclineSuggestedPost

func (c *Client) DeclineSuggestedPost(params *DeclineSuggestedPostParams) (ret bool, err error)

DeclineSuggestedPost

Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.

func (*Client) DeleteBusinessMessages

func (c *Client) DeleteBusinessMessages(params *DeleteBusinessMessagesParams) (ret bool, err error)

DeleteBusinessMessages

Delete messages on behalf of a business account. Requires the can_delete_sent_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.

func (*Client) DeleteChatPhoto

func (c *Client) DeleteChatPhoto(params *DeleteChatPhotoParams) (ret bool, err error)

DeleteChatPhoto

Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Client) DeleteChatStickerSet

func (c *Client) DeleteChatStickerSet(params *DeleteChatStickerSetParams) (ret bool, err error)

DeleteChatStickerSet

Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

func (*Client) DeleteForumTopic

func (c *Client) DeleteForumTopic(params *DeleteForumTopicParams) (ret bool, err error)

DeleteForumTopic

Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

func (*Client) DeleteMessage

func (c *Client) DeleteMessage(params *DeleteMessageParams) (ret bool, err error)

DeleteMessage

Use this method to delete a message, including service messages, with the following limitations: - A message can only be deleted if it was sent less than 48 hours ago. - Service messages about a supergroup, channel, or forum topic creation can't be deleted. - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. - Bots can delete outgoing messages in private chats, groups, and supergroups. - Bots can delete incoming messages in private chats. - Bots granted can_post_messages permissions can delete outgoing messages in channels. - If the bot is an administrator of a group, it can delete any message there. - If the bot has can_delete_messages administrator right in a supergroup or a channel, it can delete any message there. - If the bot has can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct messages chat. Returns True on success.

func (*Client) DeleteMessages

func (c *Client) DeleteMessages(params *DeleteMessagesParams) (ret bool, err error)

DeleteMessages

Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success.

func (*Client) DeleteMyCommands

func (c *Client) DeleteMyCommands(params *DeleteMyCommandsParams) (ret bool, err error)

DeleteMyCommands

Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

func (*Client) DeleteStickerFromSet

func (c *Client) DeleteStickerFromSet(params *DeleteStickerFromSetParams) (ret bool, err error)

DeleteStickerFromSet

Use this method to delete a sticker from a set created by the bot. Returns True on success.

func (*Client) DeleteStickerSet

func (c *Client) DeleteStickerSet(params *DeleteStickerSetParams) (ret bool, err error)

DeleteStickerSet

Use this method to delete a sticker set that was created by the bot. Returns True on success.

func (*Client) DeleteStory

func (c *Client) DeleteStory(params *DeleteStoryParams) (ret bool, err error)

DeleteStory

Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.

func (*Client) DeleteWebhook

func (c *Client) DeleteWebhook(params *DeleteWebhookParams) (ret bool, err error)

DeleteWebhook

Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.

func (*Client) Do

func (c *Client) Do(req *http.Request) (*http.Response, error)
func (c *Client) EditChatInviteLink(params *EditChatInviteLinkParams) (ret *ChatInviteLink, err error)

EditChatInviteLink

Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.

func (c *Client) EditChatSubscriptionInviteLink(params *EditChatSubscriptionInviteLinkParams) (ret *ChatInviteLink, err error)

EditChatSubscriptionInviteLink

Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.

func (*Client) EditForumTopic

func (c *Client) EditForumTopic(params *EditForumTopicParams) (ret bool, err error)

EditForumTopic

Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

func (*Client) EditGeneralForumTopic

func (c *Client) EditGeneralForumTopic(params *EditGeneralForumTopicParams) (ret bool, err error)

EditGeneralForumTopic

Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

func (*Client) EditMessageCaption

func (c *Client) EditMessageCaption(params *EditMessageCaptionParams) (ret *Message, err error)

EditMessageCaption

Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

func (*Client) EditMessageChecklist

func (c *Client) EditMessageChecklist(params *EditMessageChecklistParams) (ret *Message, err error)

EditMessageChecklist

Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.

func (*Client) EditMessageLiveLocation

func (c *Client) EditMessageLiveLocation(params *EditMessageLiveLocationParams) (ret *Message, err error)

EditMessageLiveLocation

Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

func (*Client) EditMessageMedia

func (c *Client) EditMessageMedia(params *EditMessageMediaParams) (ret *Message, err error)

EditMessageMedia

Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

func (*Client) EditMessageReplyMarkup

func (c *Client) EditMessageReplyMarkup(params *EditMessageReplyMarkupParams) (ret *Message, err error)

EditMessageReplyMarkup

Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

func (*Client) EditMessageText

func (c *Client) EditMessageText(params *EditMessageTextParams) (ret *Message, err error)

EditMessageText

Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

func (*Client) EditStory

func (c *Client) EditStory(params *EditStoryParams) (ret *Story, err error)

EditStory

Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

func (*Client) EditUserStarSubscription

func (c *Client) EditUserStarSubscription(params *EditUserStarSubscriptionParams) (ret bool, err error)

EditUserStarSubscription

Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.

func (c *Client) ExportChatInviteLink(params *ExportChatInviteLinkParams) (ret string, err error)

ExportChatInviteLink

Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

func (*Client) ForwardMessage

func (c *Client) ForwardMessage(params *ForwardMessageParams) (ret *Message, err error)

ForwardMessage

Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned.

func (*Client) ForwardMessages

func (c *Client) ForwardMessages(params *ForwardMessagesParams) (ret *MessageId, err error)

ForwardMessages

Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.

func (*Client) GetAvailableGifts

func (c *Client) GetAvailableGifts(params *GetAvailableGiftsParams) (ret *Gifts, err error)

GetAvailableGifts

Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.

func (*Client) GetBusinessAccountGifts

func (c *Client) GetBusinessAccountGifts(params *GetBusinessAccountGiftsParams) (ret *OwnedGifts, err error)

GetBusinessAccountGifts

Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.

func (*Client) GetBusinessAccountStarBalance

func (c *Client) GetBusinessAccountStarBalance(params *GetBusinessAccountStarBalanceParams) (ret *StarAmount, err error)

GetBusinessAccountStarBalance

Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.

func (*Client) GetBusinessConnection

func (c *Client) GetBusinessConnection(params *GetBusinessConnectionParams) (ret *BusinessConnection, err error)

GetBusinessConnection

Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

func (*Client) GetChat

func (c *Client) GetChat(params *GetChatParams) (ret *ChatFullInfo, err error)

GetChat

Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.

func (*Client) GetChatAdministrators

func (c *Client) GetChatAdministrators(params *GetChatAdministratorsParams) (ret []ChatMember, err error)

GetChatAdministrators

Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.

func (*Client) GetChatGifts

func (c *Client) GetChatGifts(params *GetChatGiftsParams) (ret *OwnedGifts, err error)

GetChatGifts

Returns the gifts owned by a chat. Returns OwnedGifts on success.

func (*Client) GetChatMember

func (c *Client) GetChatMember(params *GetChatMemberParams) (ret *ChatMember, err error)

GetChatMember

Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.

func (*Client) GetChatMemberCount

func (c *Client) GetChatMemberCount(params *GetChatMemberCountParams) (ret int64, err error)

GetChatMemberCount

Use this method to get the number of members in a chat. Returns Int on success.

func (*Client) GetChatMenuButton

func (c *Client) GetChatMenuButton(params *GetChatMenuButtonParams) (ret *MenuButton, err error)

GetChatMenuButton

Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.

func (*Client) GetCustomEmojiStickers

func (c *Client) GetCustomEmojiStickers(params *GetCustomEmojiStickersParams) (ret []Sticker, err error)

GetCustomEmojiStickers

Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

func (*Client) GetFile

func (c *Client) GetFile(params *GetFileParams) (ret *File, err error)

GetFile

Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. 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 again. Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.

func (*Client) GetForumTopicIconStickers

func (c *Client) GetForumTopicIconStickers(params *GetForumTopicIconStickersParams) (ret []Sticker, err error)

GetForumTopicIconStickers

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

func (*Client) GetGameHighScores

func (c *Client) GetGameHighScores(params *GetGameHighScoresParams) (ret []GameHighScore, err error)

GetGameHighScores

Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.

func (*Client) GetMe

func (c *Client) GetMe(params *GetMeParams) (ret *User, err error)

GetMe

A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.

func (*Client) GetMyCommands

func (c *Client) GetMyCommands(params *GetMyCommandsParams) (ret []BotCommand, err error)

GetMyCommands

Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.

func (*Client) GetMyDefaultAdministratorRights

func (c *Client) GetMyDefaultAdministratorRights(params *GetMyDefaultAdministratorRightsParams) (ret *ChatAdministratorRights, err error)

GetMyDefaultAdministratorRights

Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

func (*Client) GetMyDescription

func (c *Client) GetMyDescription(params *GetMyDescriptionParams) (ret *BotDescription, err error)

GetMyDescription

Use this method to get the current bot description for the given user language. Returns BotDescription on success.

func (*Client) GetMyName

func (c *Client) GetMyName(params *GetMyNameParams) (ret *BotName, err error)

GetMyName

Use this method to get the current bot name for the given user language. Returns BotName on success.

func (*Client) GetMyShortDescription

func (c *Client) GetMyShortDescription(params *GetMyShortDescriptionParams) (ret *BotShortDescription, err error)

GetMyShortDescription

Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.

func (*Client) GetMyStarBalance

func (c *Client) GetMyStarBalance(params *GetMyStarBalanceParams) (ret *StarAmount, err error)

GetMyStarBalance

A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.

func (*Client) GetStarTransactions

func (c *Client) GetStarTransactions(params *GetStarTransactionsParams) (ret *StarTransactions, err error)

GetStarTransactions

Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.

func (*Client) GetStickerSet

func (c *Client) GetStickerSet(params *GetStickerSetParams) (ret *StickerSet, err error)

GetStickerSet

Use this method to get a sticker set. On success, a StickerSet object is returned.

func (*Client) GetUpdates

func (c *Client) GetUpdates(params *GetUpdatesParams) (ret []Update, err error)

GetUpdates

Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

func (*Client) GetUserChatBoosts

func (c *Client) GetUserChatBoosts(params *GetUserChatBoostsParams) (ret *UserChatBoosts, err error)

GetUserChatBoosts

Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.

func (*Client) GetUserGifts

func (c *Client) GetUserGifts(params *GetUserGiftsParams) (ret *OwnedGifts, err error)

GetUserGifts

Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.

func (*Client) GetUserProfileAudios

func (c *Client) GetUserProfileAudios(params *GetUserProfileAudiosParams) (ret *UserProfileAudios, err error)

GetUserProfileAudios

Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.

func (*Client) GetUserProfilePhotos

func (c *Client) GetUserProfilePhotos(params *GetUserProfilePhotosParams) (ret *UserProfilePhotos, err error)

GetUserProfilePhotos

Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

func (*Client) GetWebhookInfo

func (c *Client) GetWebhookInfo(params *GetWebhookInfoParams) (ret *WebhookInfo, err error)

GetWebhookInfo

Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.

func (*Client) GiftPremiumSubscription

func (c *Client) GiftPremiumSubscription(params *GiftPremiumSubscriptionParams) (ret bool, err error)

GiftPremiumSubscription

Gifts a Telegram Premium subscription to the given user. Returns True on success.

func (*Client) HideGeneralForumTopic

func (c *Client) HideGeneralForumTopic(params *HideGeneralForumTopicParams) (ret bool, err error)

HideGeneralForumTopic

Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

func (*Client) ID

func (c *Client) ID() int64

func (*Client) LeaveChat

func (c *Client) LeaveChat(params *LeaveChatParams) (ret bool, err error)

LeaveChat

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

func (*Client) LocalAddr

func (c *Client) LocalAddr() net.Addr

func (*Client) LogOut

func (c *Client) LogOut(params *LogOutParams) (ret bool, err error)

LogOut

Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

func (*Client) Option

func (c *Client) Option(opts ...ClientOption) (previous ClientOption)

func (*Client) PinChatMessage

func (c *Client) PinChatMessage(params *PinChatMessageParams) (ret bool, err error)

PinChatMessage

Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.

func (*Client) PostStory

func (c *Client) PostStory(params *PostStoryParams) (ret *Story, err error)

PostStory

Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

func (*Client) PromoteChatMember

func (c *Client) PromoteChatMember(params *PromoteChatMemberParams) (ret bool, err error)

PromoteChatMember

Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

func (*Client) Raw

func (c *Client) Raw(method string, reader io.Reader, contentType ...string) (json.RawMessage, error)

func (*Client) ReadBusinessMessage

func (c *Client) ReadBusinessMessage(params *ReadBusinessMessageParams) (ret bool, err error)

ReadBusinessMessage

Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.

func (*Client) RefundStarPayment

func (c *Client) RefundStarPayment(params *RefundStarPaymentParams) (ret bool, err error)

RefundStarPayment

Refunds a successful payment in Telegram Stars. Returns True on success.

func (*Client) RemoteAddr

func (c *Client) RemoteAddr() net.Addr

func (*Client) RemoveBusinessAccountProfilePhoto

func (c *Client) RemoveBusinessAccountProfilePhoto(params *RemoveBusinessAccountProfilePhotoParams) (ret bool, err error)

RemoveBusinessAccountProfilePhoto

Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

func (*Client) RemoveChatVerification

func (c *Client) RemoveChatVerification(params *RemoveChatVerificationParams) (ret bool, err error)

RemoveChatVerification

Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.

func (*Client) RemoveMyProfilePhoto

func (c *Client) RemoveMyProfilePhoto(params *RemoveMyProfilePhotoParams) (ret bool, err error)

RemoveMyProfilePhoto

Removes the profile photo of the bot. Requires no parameters. Returns True on success.

func (*Client) RemoveUserVerification

func (c *Client) RemoveUserVerification(params *RemoveUserVerificationParams) (ret bool, err error)

RemoveUserVerification

Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.

func (*Client) ReopenForumTopic

func (c *Client) ReopenForumTopic(params *ReopenForumTopicParams) (ret bool, err error)

ReopenForumTopic

Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

func (*Client) ReopenGeneralForumTopic

func (c *Client) ReopenGeneralForumTopic(params *ReopenGeneralForumTopicParams) (ret bool, err error)

ReopenGeneralForumTopic

Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.

func (*Client) ReplaceStickerInSet

func (c *Client) ReplaceStickerInSet(params *ReplaceStickerInSetParams) (ret bool, err error)

ReplaceStickerInSet

Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.

func (*Client) RepostStory

func (c *Client) RepostStory(params *RepostStoryParams) (ret *Story, err error)

RepostStory

Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the can_manage_stories business bot right for both business accounts. Returns Story on success.

func (*Client) RestrictChatMember

func (c *Client) RestrictChatMember(params *RestrictChatMemberParams) (ret bool, err error)

RestrictChatMember

Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

func (c *Client) RevokeChatInviteLink(params *RevokeChatInviteLinkParams) (ret *ChatInviteLink, err error)

RevokeChatInviteLink

Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.

func (*Client) Router

func (c *Client) Router() *Router

func (*Client) SavePreparedInlineMessage

func (c *Client) SavePreparedInlineMessage(params *SavePreparedInlineMessageParams) (ret *PreparedInlineMessage, err error)

SavePreparedInlineMessage

Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.

func (*Client) SendAnimation

func (c *Client) SendAnimation(params *SendAnimationParams) (ret *Message, err error)

SendAnimation

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

func (*Client) SendAudio

func (c *Client) SendAudio(params *SendAudioParams) (ret *Message, err error)

SendAudio

Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. For sending voice messages, use the sendVoice method instead.

func (*Client) SendChatAction

func (c *Client) SendChatAction(params *SendChatActionParams) (ret bool, err error)

SendChatAction

Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success. We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

func (*Client) SendChecklist

func (c *Client) SendChecklist(params *SendChecklistParams) (ret *Message, err error)

SendChecklist

Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.

func (*Client) SendContact

func (c *Client) SendContact(params *SendContactParams) (ret *Message, err error)

SendContact

Use this method to send phone contacts. On success, the sent Message is returned.

func (*Client) SendDice

func (c *Client) SendDice(params *SendDiceParams) (ret *Message, err error)

SendDice

Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.

func (*Client) SendDocument

func (c *Client) SendDocument(params *SendDocumentParams) (ret *Message, err error)

SendDocument

Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

func (*Client) SendGame

func (c *Client) SendGame(params *SendGameParams) (ret *Message, err error)

SendGame

Use this method to send a game. On success, the sent Message is returned.

func (*Client) SendGift

func (c *Client) SendGift(params *SendGiftParams) (ret bool, err error)

SendGift

Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.

func (*Client) SendInvoice

func (c *Client) SendInvoice(params *SendInvoiceParams) (ret *Message, err error)

SendInvoice

Use this method to send invoices. On success, the sent Message is returned.

func (*Client) SendLocation

func (c *Client) SendLocation(params *SendLocationParams) (ret *Message, err error)

SendLocation

Use this method to send point on the map. On success, the sent Message is returned.

func (*Client) SendMediaGroup

func (c *Client) SendMediaGroup(params *SendMediaGroupParams) (ret *Message, err error)

SendMediaGroup

Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Message objects that were sent is returned.

func (*Client) SendMessage

func (c *Client) SendMessage(params *SendMessageParams) (ret *Message, err error)

SendMessage

Use this method to send text messages. On success, the sent Message is returned.

func (*Client) SendMessageDraft

func (c *Client) SendMessageDraft(params *SendMessageDraftParams) (ret bool, err error)

SendMessageDraft

Use this method to stream a partial message to a user while the message is being generated; supported only for bots with forum topic mode enabled. Returns True on success.

func (*Client) SendPaidMedia

func (c *Client) SendPaidMedia(params *SendPaidMediaParams) (ret *Message, err error)

SendPaidMedia

Use this method to send paid media. On success, the sent Message is returned.

func (*Client) SendPhoto

func (c *Client) SendPhoto(params *SendPhotoParams) (ret *Message, err error)

SendPhoto

Use this method to send photos. On success, the sent Message is returned.

func (*Client) SendPoll

func (c *Client) SendPoll(params *SendPollParams) (ret *Message, err error)

SendPoll

Use this method to send a native poll. On success, the sent Message is returned.

func (*Client) SendSticker

func (c *Client) SendSticker(params *SendStickerParams) (ret *Message, err error)

SendSticker

Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.

func (*Client) SendVenue

func (c *Client) SendVenue(params *SendVenueParams) (ret *Message, err error)

SendVenue

Use this method to send information about a venue. On success, the sent Message is returned.

func (*Client) SendVideo

func (c *Client) SendVideo(params *SendVideoParams) (ret *Message, err error)

SendVideo

Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

func (*Client) SendVideoNote

func (c *Client) SendVideoNote(params *SendVideoNoteParams) (ret *Message, err error)

SendVideoNote

As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.

func (*Client) SendVoice

func (c *Client) SendVoice(params *SendVoiceParams) (ret *Message, err error)

SendVoice

Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

func (*Client) SetBusinessAccountBio

func (c *Client) SetBusinessAccountBio(params *SetBusinessAccountBioParams) (ret bool, err error)

SetBusinessAccountBio

Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.

func (*Client) SetBusinessAccountGiftSettings

func (c *Client) SetBusinessAccountGiftSettings(params *SetBusinessAccountGiftSettingsParams) (ret bool, err error)

SetBusinessAccountGiftSettings

Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.

func (*Client) SetBusinessAccountName

func (c *Client) SetBusinessAccountName(params *SetBusinessAccountNameParams) (ret bool, err error)

SetBusinessAccountName

Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.

func (*Client) SetBusinessAccountProfilePhoto

func (c *Client) SetBusinessAccountProfilePhoto(params *SetBusinessAccountProfilePhotoParams) (ret bool, err error)

SetBusinessAccountProfilePhoto

Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

func (*Client) SetBusinessAccountUsername

func (c *Client) SetBusinessAccountUsername(params *SetBusinessAccountUsernameParams) (ret bool, err error)

SetBusinessAccountUsername

Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.

func (*Client) SetChatAdministratorCustomTitle

func (c *Client) SetChatAdministratorCustomTitle(params *SetChatAdministratorCustomTitleParams) (ret bool, err error)

SetChatAdministratorCustomTitle

Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

func (*Client) SetChatDescription

func (c *Client) SetChatDescription(params *SetChatDescriptionParams) (ret bool, err error)

SetChatDescription

Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Client) SetChatMenuButton

func (c *Client) SetChatMenuButton(params *SetChatMenuButtonParams) (ret bool, err error)

SetChatMenuButton

Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.

func (*Client) SetChatPermissions

func (c *Client) SetChatPermissions(params *SetChatPermissionsParams) (ret bool, err error)

SetChatPermissions

Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.

func (*Client) SetChatPhoto

func (c *Client) SetChatPhoto(params *SetChatPhotoParams) (ret bool, err error)

SetChatPhoto

Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Client) SetChatStickerSet

func (c *Client) SetChatStickerSet(params *SetChatStickerSetParams) (ret bool, err error)

SetChatStickerSet

Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

func (*Client) SetChatTitle

func (c *Client) SetChatTitle(params *SetChatTitleParams) (ret bool, err error)

SetChatTitle

Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Client) SetCustomEmojiStickerSetThumbnail

func (c *Client) SetCustomEmojiStickerSetThumbnail(params *SetCustomEmojiStickerSetThumbnailParams) (ret bool, err error)

SetCustomEmojiStickerSetThumbnail

Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.

func (*Client) SetGameScore

func (c *Client) SetGameScore(params *SetGameScoreParams) (ret *Message, err error)

SetGameScore

Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

func (*Client) SetMessageReaction

func (c *Client) SetMessageReaction(params *SetMessageReactionParams) (ret bool, err error)

SetMessageReaction

Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.

func (*Client) SetMyCommands

func (c *Client) SetMyCommands(params *SetMyCommandsParams) (ret bool, err error)

SetMyCommands

Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.

func (*Client) SetMyDefaultAdministratorRights

func (c *Client) SetMyDefaultAdministratorRights(params *SetMyDefaultAdministratorRightsParams) (ret bool, err error)

SetMyDefaultAdministratorRights

Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.

func (*Client) SetMyDescription

func (c *Client) SetMyDescription(params *SetMyDescriptionParams) (ret bool, err error)

SetMyDescription

Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.

func (*Client) SetMyName

func (c *Client) SetMyName(params *SetMyNameParams) (ret bool, err error)

SetMyName

Use this method to change the bot's name. Returns True on success.

func (*Client) SetMyProfilePhoto

func (c *Client) SetMyProfilePhoto(params *SetMyProfilePhotoParams) (ret bool, err error)

SetMyProfilePhoto

Changes the profile photo of the bot. Returns True on success.

func (*Client) SetMyShortDescription

func (c *Client) SetMyShortDescription(params *SetMyShortDescriptionParams) (ret bool, err error)

SetMyShortDescription

Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.

func (*Client) SetPassportDataErrors

func (c *Client) SetPassportDataErrors(params *SetPassportDataErrorsParams) (ret bool, err error)

SetPassportDataErrors

Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success. Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.

func (*Client) SetRouter

func (c *Client) SetRouter(r *Router)

func (*Client) SetStickerEmojiList

func (c *Client) SetStickerEmojiList(params *SetStickerEmojiListParams) (ret bool, err error)

SetStickerEmojiList

Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

func (*Client) SetStickerKeywords

func (c *Client) SetStickerKeywords(params *SetStickerKeywordsParams) (ret bool, err error)

SetStickerKeywords

Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

func (*Client) SetStickerMaskPosition

func (c *Client) SetStickerMaskPosition(params *SetStickerMaskPositionParams) (ret bool, err error)

SetStickerMaskPosition

Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.

func (*Client) SetStickerPositionInSet

func (c *Client) SetStickerPositionInSet(params *SetStickerPositionInSetParams) (ret bool, err error)

SetStickerPositionInSet

Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

func (*Client) SetStickerSetThumbnail

func (c *Client) SetStickerSetThumbnail(params *SetStickerSetThumbnailParams) (ret bool, err error)

SetStickerSetThumbnail

Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.

func (*Client) SetStickerSetTitle

func (c *Client) SetStickerSetTitle(params *SetStickerSetTitleParams) (ret bool, err error)

SetStickerSetTitle

Use this method to set the title of a created sticker set. Returns True on success.

func (*Client) SetUserEmojiStatus

func (c *Client) SetUserEmojiStatus(params *SetUserEmojiStatusParams) (ret bool, err error)

SetUserEmojiStatus

Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns True on success.

func (*Client) SetWebhook

func (c *Client) SetWebhook(params *SetWebhookParams) (ret bool, err error)

SetWebhook

Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request (a request with response HTTP status code different from 2XY), we will repeat the request and give up after a reasonable amount of attempts. Returns True on success. If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.

func (*Client) Start

func (c *Client) Start(ctx context.Context, params *GetUpdatesParams) error

func (*Client) Stop

func (c *Client) Stop()

func (*Client) StopMessageLiveLocation

func (c *Client) StopMessageLiveLocation(params *StopMessageLiveLocationParams) (ret *Message, err error)

StopMessageLiveLocation

Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.

func (*Client) StopPoll

func (c *Client) StopPoll(params *StopPollParams) (ret *Poll, err error)

StopPoll

Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.

func (*Client) Token

func (c *Client) Token() string

func (*Client) TransferBusinessAccountStars

func (c *Client) TransferBusinessAccountStars(params *TransferBusinessAccountStarsParams) (ret bool, err error)

TransferBusinessAccountStars

Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.

func (*Client) TransferGift

func (c *Client) TransferGift(params *TransferGiftParams) (ret bool, err error)

TransferGift

Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.

func (*Client) UnbanChatMember

func (c *Client) UnbanChatMember(params *UnbanChatMemberParams) (ret bool, err error)

UnbanChatMember

Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.

func (*Client) UnbanChatSenderChat

func (c *Client) UnbanChatSenderChat(params *UnbanChatSenderChatParams) (ret bool, err error)

UnbanChatSenderChat

Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Client) UnhideGeneralForumTopic

func (c *Client) UnhideGeneralForumTopic(params *UnhideGeneralForumTopicParams) (ret bool, err error)

UnhideGeneralForumTopic

Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

func (*Client) UnpinAllChatMessages

func (c *Client) UnpinAllChatMessages(params *UnpinAllChatMessagesParams) (ret bool, err error)

UnpinAllChatMessages

Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns True on success.

func (*Client) UnpinAllForumTopicMessages

func (c *Client) UnpinAllForumTopicMessages(params *UnpinAllForumTopicMessagesParams) (ret bool, err error)

UnpinAllForumTopicMessages

Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

func (*Client) UnpinAllGeneralForumTopicMessages

func (c *Client) UnpinAllGeneralForumTopicMessages(params *UnpinAllGeneralForumTopicMessagesParams) (ret bool, err error)

UnpinAllGeneralForumTopicMessages

Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

func (*Client) UnpinChatMessage

func (c *Client) UnpinChatMessage(params *UnpinChatMessageParams) (ret bool, err error)

UnpinChatMessage

Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns True on success.

func (*Client) UpgradeGift

func (c *Client) UpgradeGift(params *UpgradeGiftParams) (ret bool, err error)

UpgradeGift

Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.

func (*Client) UploadStickerFile

func (c *Client) UploadStickerFile(params *UploadStickerFileParams) (ret *File, err error)

UploadStickerFile

Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.

func (*Client) VerifyChat

func (c *Client) VerifyChat(params *VerifyChatParams) (ret bool, err error)

VerifyChat

Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.

func (*Client) VerifyUser

func (c *Client) VerifyUser(params *VerifyUserParams) (ret bool, err error)

VerifyUser

Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.

type ClientOption

type ClientOption func(client *Client) ClientOption

func WithDefaultParseMode

func WithDefaultParseMode(parseMode string) ClientOption

func WithHTTPClient

func WithHTTPClient(client *http.Client) ClientOption

func WithHost

func WithHost(host string) ClientOption

func WithRPS

func WithRPS(rps int) ClientOption

func WithTest

func WithTest(test bool) ClientOption

func WithTimeout

func WithTimeout(timeout time.Duration) ClientOption

type CloseForumTopicOption

type CloseForumTopicOption func(params *CloseForumTopicParams) CloseForumTopicOption

func WithCloseForumTopicChatID

func WithCloseForumTopicChatID(value string) CloseForumTopicOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

func WithCloseForumTopicMessageThreadID

func WithCloseForumTopicMessageThreadID(value int64) CloseForumTopicOption

Unique identifier for the target message thread of the forum topic

type CloseForumTopicParams

type CloseForumTopicParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread of the forum topic
	MessageThreadID int64 `json:"message_thread_id"`
}

func (*CloseForumTopicParams) Option

type CloseGeneralForumTopicOption

type CloseGeneralForumTopicOption func(params *CloseGeneralForumTopicParams) CloseGeneralForumTopicOption

func WithCloseGeneralForumTopicChatID

func WithCloseGeneralForumTopicChatID(value string) CloseGeneralForumTopicOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

type CloseGeneralForumTopicParams

type CloseGeneralForumTopicParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`
}

func (*CloseGeneralForumTopicParams) Option

type CloseOption

type CloseOption func(params *CloseParams) CloseOption

type CloseParams

type CloseParams struct {
}

func (*CloseParams) Option

func (r *CloseParams) Option(opts ...CloseOption) (previous CloseOption)

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]: https://en.wikipedia.org/wiki/VCard
	Vcard string `json:"vcard,omitempty"`
}

Contact

This object represents a phone contact.

type Context

type Context struct {
	// contains filtered or unexported fields
}

func (*Context) AddStickerToSet

func (ctx *Context) AddStickerToSet(
	userID int64,
	name string,
	sticker InputSticker,
	opts ...AddStickerToSetOption,
) error

func (*Context) AnswerCallbackQuery

func (ctx *Context) AnswerCallbackQuery(
	opts ...AnswerCallbackQueryOption,
) error

func (*Context) AnswerInlineQuery

func (ctx *Context) AnswerInlineQuery(
	results []InlineQueryResult,
	opts ...AnswerInlineQueryOption,
) error

func (*Context) AnswerPreCheckoutQuery

func (ctx *Context) AnswerPreCheckoutQuery(
	ok bool,
	opts ...AnswerPreCheckoutQueryOption,
) error

func (*Context) AnswerShippingQuery

func (ctx *Context) AnswerShippingQuery(
	ok bool,
	opts ...AnswerShippingQueryOption,
) error

func (*Context) AnswerWebAppQuery

func (ctx *Context) AnswerWebAppQuery(
	webAppQueryID string,
	result InlineQueryResult,
	opts ...AnswerWebAppQueryOption,
) error

func (*Context) ApproveChatJoinRequest

func (ctx *Context) ApproveChatJoinRequest(
	userID int64,
	opts ...ApproveChatJoinRequestOption,
) error

func (*Context) ApproveSuggestedPost

func (ctx *Context) ApproveSuggestedPost(
	messageID int64,
	opts ...ApproveSuggestedPostOption,
) error

func (*Context) BanChatMember

func (ctx *Context) BanChatMember(
	userID int64,
	opts ...BanChatMemberOption,
) error

func (*Context) BanChatSenderChat

func (ctx *Context) BanChatSenderChat(
	senderChatID int64,
	opts ...BanChatSenderChatOption,
) error

func (*Context) Chat

func (ctx *Context) Chat() *Chat

func (*Context) Client

func (ctx *Context) Client() *Client

func (*Context) Close

func (ctx *Context) Close(
	opts ...CloseOption,
) error

func (*Context) CloseForumTopic

func (ctx *Context) CloseForumTopic(
	messageThreadID int64,
	opts ...CloseForumTopicOption,
) error

func (*Context) CloseGeneralForumTopic

func (ctx *Context) CloseGeneralForumTopic(
	opts ...CloseGeneralForumTopicOption,
) error

func (*Context) Context

func (ctx *Context) Context() context.Context

func (*Context) ConvertGiftToStars

func (ctx *Context) ConvertGiftToStars(
	ownedGiftID string,
	opts ...ConvertGiftToStarsOption,
) error

func (*Context) CopyMessage

func (ctx *Context) CopyMessage(
	fromChatID string,
	messageID int64,
	opts ...CopyMessageOption,
) error

func (*Context) CopyMessages

func (ctx *Context) CopyMessages(
	fromChatID string,
	messageIDs []int64,
	opts ...CopyMessagesOption,
) error
func (ctx *Context) CreateChatInviteLink(
	opts ...CreateChatInviteLinkOption,
) error
func (ctx *Context) CreateChatSubscriptionInviteLink(
	subscriptionPeriod int64,
	subscriptionPrice int64,
	opts ...CreateChatSubscriptionInviteLinkOption,
) error

func (*Context) CreateForumTopic

func (ctx *Context) CreateForumTopic(
	name string,
	opts ...CreateForumTopicOption,
) error
func (ctx *Context) CreateInvoiceLink(
	title string,
	description string,
	payload string,
	currency string,
	prices []LabeledPrice,
	opts ...CreateInvoiceLinkOption,
) error

func (*Context) CreateNewStickerSet

func (ctx *Context) CreateNewStickerSet(
	userID int64,
	name string,
	title string,
	stickers []InputSticker,
	opts ...CreateNewStickerSetOption,
) error

func (*Context) Deadline

func (ctx *Context) Deadline() (deadline time.Time, ok bool)

func (*Context) DeclineChatJoinRequest

func (ctx *Context) DeclineChatJoinRequest(
	userID int64,
	opts ...DeclineChatJoinRequestOption,
) error

func (*Context) DeclineSuggestedPost

func (ctx *Context) DeclineSuggestedPost(
	messageID int64,
	opts ...DeclineSuggestedPostOption,
) error

func (*Context) DeleteBusinessMessages

func (ctx *Context) DeleteBusinessMessages(
	messageIDs []int64,
	opts ...DeleteBusinessMessagesOption,
) error

func (*Context) DeleteChatPhoto

func (ctx *Context) DeleteChatPhoto(
	opts ...DeleteChatPhotoOption,
) error

func (*Context) DeleteChatStickerSet

func (ctx *Context) DeleteChatStickerSet(
	opts ...DeleteChatStickerSetOption,
) error

func (*Context) DeleteForumTopic

func (ctx *Context) DeleteForumTopic(
	messageThreadID int64,
	opts ...DeleteForumTopicOption,
) error

func (*Context) DeleteMessage

func (ctx *Context) DeleteMessage(
	messageID int64,
	opts ...DeleteMessageOption,
) error

func (*Context) DeleteMessages

func (ctx *Context) DeleteMessages(
	messageIDs []int64,
	opts ...DeleteMessagesOption,
) error

func (*Context) DeleteMyCommands

func (ctx *Context) DeleteMyCommands(
	opts ...DeleteMyCommandsOption,
) error

func (*Context) DeleteStickerFromSet

func (ctx *Context) DeleteStickerFromSet(
	sticker string,
	opts ...DeleteStickerFromSetOption,
) error

func (*Context) DeleteStickerSet

func (ctx *Context) DeleteStickerSet(
	name string,
	opts ...DeleteStickerSetOption,
) error

func (*Context) DeleteStory

func (ctx *Context) DeleteStory(
	storyID int64,
	opts ...DeleteStoryOption,
) error

func (*Context) DeleteWebhook

func (ctx *Context) DeleteWebhook(
	opts ...DeleteWebhookOption,
) error

func (*Context) Done

func (ctx *Context) Done() <-chan struct{}
func (ctx *Context) EditChatInviteLink(
	inviteLink string,
	opts ...EditChatInviteLinkOption,
) error
func (ctx *Context) EditChatSubscriptionInviteLink(
	inviteLink string,
	opts ...EditChatSubscriptionInviteLinkOption,
) error

func (*Context) EditForumTopic

func (ctx *Context) EditForumTopic(
	messageThreadID int64,
	opts ...EditForumTopicOption,
) error

func (*Context) EditGeneralForumTopic

func (ctx *Context) EditGeneralForumTopic(
	name string,
	opts ...EditGeneralForumTopicOption,
) error

func (*Context) EditMessageCaption

func (ctx *Context) EditMessageCaption(
	opts ...EditMessageCaptionOption,
) error

func (*Context) EditMessageChecklist

func (ctx *Context) EditMessageChecklist(
	messageID int64,
	checklist InputChecklist,
	opts ...EditMessageChecklistOption,
) error

func (*Context) EditMessageLiveLocation

func (ctx *Context) EditMessageLiveLocation(
	latitude float64,
	longitude float64,
	opts ...EditMessageLiveLocationOption,
) error

func (*Context) EditMessageMedia

func (ctx *Context) EditMessageMedia(
	media InputMedia,
	opts ...EditMessageMediaOption,
) error

func (*Context) EditMessageReplyMarkup

func (ctx *Context) EditMessageReplyMarkup(
	opts ...EditMessageReplyMarkupOption,
) error

func (*Context) EditMessageText

func (ctx *Context) EditMessageText(
	text string,
	opts ...EditMessageTextOption,
) error

func (*Context) EditStory

func (ctx *Context) EditStory(
	storyID int64,
	content InputStoryContent,
	opts ...EditStoryOption,
) error

func (*Context) EditUserStarSubscription

func (ctx *Context) EditUserStarSubscription(
	userID int64,
	telegramPaymentChargeID string,
	isCanceled bool,
	opts ...EditUserStarSubscriptionOption,
) error

func (*Context) Err

func (ctx *Context) Err() error
func (ctx *Context) ExportChatInviteLink(
	opts ...ExportChatInviteLinkOption,
) error

func (*Context) ForwardMessage

func (ctx *Context) ForwardMessage(
	fromChatID string,
	messageID int64,
	opts ...ForwardMessageOption,
) error

func (*Context) ForwardMessages

func (ctx *Context) ForwardMessages(
	fromChatID string,
	messageIDs []int64,
	opts ...ForwardMessagesOption,
) error

func (*Context) GetAvailableGifts

func (ctx *Context) GetAvailableGifts(
	opts ...GetAvailableGiftsOption,
) error

func (*Context) GetBusinessAccountGifts

func (ctx *Context) GetBusinessAccountGifts(
	opts ...GetBusinessAccountGiftsOption,
) error

func (*Context) GetBusinessAccountStarBalance

func (ctx *Context) GetBusinessAccountStarBalance(
	opts ...GetBusinessAccountStarBalanceOption,
) error

func (*Context) GetBusinessConnection

func (ctx *Context) GetBusinessConnection(
	opts ...GetBusinessConnectionOption,
) error

func (*Context) GetChat

func (ctx *Context) GetChat(
	opts ...GetChatOption,
) error

func (*Context) GetChatAdministrators

func (ctx *Context) GetChatAdministrators(
	opts ...GetChatAdministratorsOption,
) error

func (*Context) GetChatGifts

func (ctx *Context) GetChatGifts(
	opts ...GetChatGiftsOption,
) error

func (*Context) GetChatMember

func (ctx *Context) GetChatMember(
	userID int64,
	opts ...GetChatMemberOption,
) error

func (*Context) GetChatMemberCount

func (ctx *Context) GetChatMemberCount(
	opts ...GetChatMemberCountOption,
) error

func (*Context) GetChatMenuButton

func (ctx *Context) GetChatMenuButton(
	opts ...GetChatMenuButtonOption,
) error

func (*Context) GetCustomEmojiStickers

func (ctx *Context) GetCustomEmojiStickers(
	customEmojiIDs []string,
	opts ...GetCustomEmojiStickersOption,
) error

func (*Context) GetFile

func (ctx *Context) GetFile(
	fileID string,
	opts ...GetFileOption,
) error

func (*Context) GetForumTopicIconStickers

func (ctx *Context) GetForumTopicIconStickers(
	opts ...GetForumTopicIconStickersOption,
) error

func (*Context) GetGameHighScores

func (ctx *Context) GetGameHighScores(
	userID int64,
	opts ...GetGameHighScoresOption,
) error

func (*Context) GetMe

func (ctx *Context) GetMe(
	opts ...GetMeOption,
) error

func (*Context) GetMyCommands

func (ctx *Context) GetMyCommands(
	opts ...GetMyCommandsOption,
) error

func (*Context) GetMyDefaultAdministratorRights

func (ctx *Context) GetMyDefaultAdministratorRights(
	opts ...GetMyDefaultAdministratorRightsOption,
) error

func (*Context) GetMyDescription

func (ctx *Context) GetMyDescription(
	opts ...GetMyDescriptionOption,
) error

func (*Context) GetMyName

func (ctx *Context) GetMyName(
	opts ...GetMyNameOption,
) error

func (*Context) GetMyShortDescription

func (ctx *Context) GetMyShortDescription(
	opts ...GetMyShortDescriptionOption,
) error

func (*Context) GetMyStarBalance

func (ctx *Context) GetMyStarBalance(
	opts ...GetMyStarBalanceOption,
) error

func (*Context) GetStarTransactions

func (ctx *Context) GetStarTransactions(
	opts ...GetStarTransactionsOption,
) error

func (*Context) GetStickerSet

func (ctx *Context) GetStickerSet(
	name string,
	opts ...GetStickerSetOption,
) error

func (*Context) GetUpdates

func (ctx *Context) GetUpdates(
	opts ...GetUpdatesOption,
) error

func (*Context) GetUserChatBoosts

func (ctx *Context) GetUserChatBoosts(
	userID int64,
	opts ...GetUserChatBoostsOption,
) error

func (*Context) GetUserGifts

func (ctx *Context) GetUserGifts(
	userID int64,
	opts ...GetUserGiftsOption,
) error

func (*Context) GetUserProfileAudios

func (ctx *Context) GetUserProfileAudios(
	userID int64,
	opts ...GetUserProfileAudiosOption,
) error

func (*Context) GetUserProfilePhotos

func (ctx *Context) GetUserProfilePhotos(
	userID int64,
	opts ...GetUserProfilePhotosOption,
) error

func (*Context) GetWebhookInfo

func (ctx *Context) GetWebhookInfo(
	opts ...GetWebhookInfoOption,
) error

func (*Context) GiftPremiumSubscription

func (ctx *Context) GiftPremiumSubscription(
	userID int64,
	monthCount int64,
	starCount int64,
	opts ...GiftPremiumSubscriptionOption,
) error

func (*Context) HideGeneralForumTopic

func (ctx *Context) HideGeneralForumTopic(
	opts ...HideGeneralForumTopicOption,
) error

func (*Context) LeaveChat

func (ctx *Context) LeaveChat(
	opts ...LeaveChatOption,
) error

func (*Context) LogOut

func (ctx *Context) LogOut(
	opts ...LogOutOption,
) error

func (*Context) Message

func (ctx *Context) Message() *Message

func (*Context) Payload

func (ctx *Context) Payload() string

func (*Context) PinChatMessage

func (ctx *Context) PinChatMessage(
	messageID int64,
	opts ...PinChatMessageOption,
) error

func (*Context) PostStory

func (ctx *Context) PostStory(
	content InputStoryContent,
	activePeriod int64,
	opts ...PostStoryOption,
) error

func (*Context) PromoteChatMember

func (ctx *Context) PromoteChatMember(
	userID int64,
	opts ...PromoteChatMemberOption,
) error

func (*Context) ReadBusinessMessage

func (ctx *Context) ReadBusinessMessage(
	messageID int64,
	opts ...ReadBusinessMessageOption,
) error

func (*Context) RefundStarPayment

func (ctx *Context) RefundStarPayment(
	userID int64,
	telegramPaymentChargeID string,
	opts ...RefundStarPaymentOption,
) error

func (*Context) RemoveBusinessAccountProfilePhoto

func (ctx *Context) RemoveBusinessAccountProfilePhoto(
	opts ...RemoveBusinessAccountProfilePhotoOption,
) error

func (*Context) RemoveChatVerification

func (ctx *Context) RemoveChatVerification(
	opts ...RemoveChatVerificationOption,
) error

func (*Context) RemoveMyProfilePhoto

func (ctx *Context) RemoveMyProfilePhoto(
	opts ...RemoveMyProfilePhotoOption,
) error

func (*Context) RemoveUserVerification

func (ctx *Context) RemoveUserVerification(
	userID int64,
	opts ...RemoveUserVerificationOption,
) error

func (*Context) ReopenForumTopic

func (ctx *Context) ReopenForumTopic(
	messageThreadID int64,
	opts ...ReopenForumTopicOption,
) error

func (*Context) ReopenGeneralForumTopic

func (ctx *Context) ReopenGeneralForumTopic(
	opts ...ReopenGeneralForumTopicOption,
) error

func (*Context) ReplaceStickerInSet

func (ctx *Context) ReplaceStickerInSet(
	userID int64,
	name string,
	oldSticker string,
	sticker InputSticker,
	opts ...ReplaceStickerInSetOption,
) error

func (*Context) RepostStory

func (ctx *Context) RepostStory(
	fromChatID int64,
	fromStoryID int64,
	activePeriod int64,
	opts ...RepostStoryOption,
) error

func (*Context) RestrictChatMember

func (ctx *Context) RestrictChatMember(
	userID int64,
	permissions ChatPermissions,
	opts ...RestrictChatMemberOption,
) error
func (ctx *Context) RevokeChatInviteLink(
	inviteLink string,
	opts ...RevokeChatInviteLinkOption,
) error

func (*Context) SavePreparedInlineMessage

func (ctx *Context) SavePreparedInlineMessage(
	userID int64,
	result InlineQueryResult,
	opts ...SavePreparedInlineMessageOption,
) error

func (*Context) SendAnimation

func (ctx *Context) SendAnimation(
	animation InputFile,
	opts ...SendAnimationOption,
) error

func (*Context) SendAudio

func (ctx *Context) SendAudio(
	audio InputFile,
	opts ...SendAudioOption,
) error

func (*Context) SendChatAction

func (ctx *Context) SendChatAction(
	action string,
	opts ...SendChatActionOption,
) error

func (*Context) SendChecklist

func (ctx *Context) SendChecklist(
	checklist InputChecklist,
	opts ...SendChecklistOption,
) error

func (*Context) SendContact

func (ctx *Context) SendContact(
	phoneNumber string,
	firstName string,
	opts ...SendContactOption,
) error

func (*Context) SendDice

func (ctx *Context) SendDice(
	opts ...SendDiceOption,
) error

func (*Context) SendDocument

func (ctx *Context) SendDocument(
	document InputFile,
	opts ...SendDocumentOption,
) error

func (*Context) SendGame

func (ctx *Context) SendGame(
	gameShortName string,
	opts ...SendGameOption,
) error

func (*Context) SendGift

func (ctx *Context) SendGift(
	giftID string,
	opts ...SendGiftOption,
) error

func (*Context) SendInvoice

func (ctx *Context) SendInvoice(
	title string,
	description string,
	payload string,
	currency string,
	prices []LabeledPrice,
	opts ...SendInvoiceOption,
) error

func (*Context) SendLocation

func (ctx *Context) SendLocation(
	latitude float64,
	longitude float64,
	opts ...SendLocationOption,
) error

func (*Context) SendMediaGroup

func (ctx *Context) SendMediaGroup(
	media []InputMedia,
	opts ...SendMediaGroupOption,
) error

func (*Context) SendMessage

func (ctx *Context) SendMessage(
	text string,
	opts ...SendMessageOption,
) error

func (*Context) SendMessageDraft

func (ctx *Context) SendMessageDraft(
	draftID int64,
	text string,
	opts ...SendMessageDraftOption,
) error

func (*Context) SendPaidMedia

func (ctx *Context) SendPaidMedia(
	starCount int64,
	media []InputPaidMedia,
	opts ...SendPaidMediaOption,
) error

func (*Context) SendPhoto

func (ctx *Context) SendPhoto(
	photo InputFile,
	opts ...SendPhotoOption,
) error

func (*Context) SendPoll

func (ctx *Context) SendPoll(
	question string,
	options []InputPollOption,
	opts ...SendPollOption,
) error

func (*Context) SendSticker

func (ctx *Context) SendSticker(
	sticker InputFile,
	opts ...SendStickerOption,
) error

func (*Context) SendVenue

func (ctx *Context) SendVenue(
	latitude float64,
	longitude float64,
	title string,
	address string,
	opts ...SendVenueOption,
) error

func (*Context) SendVideo

func (ctx *Context) SendVideo(
	video InputFile,
	opts ...SendVideoOption,
) error

func (*Context) SendVideoNote

func (ctx *Context) SendVideoNote(
	videoNote InputFile,
	opts ...SendVideoNoteOption,
) error

func (*Context) SendVoice

func (ctx *Context) SendVoice(
	voice InputFile,
	opts ...SendVoiceOption,
) error

func (*Context) SetBusinessAccountBio

func (ctx *Context) SetBusinessAccountBio(
	opts ...SetBusinessAccountBioOption,
) error

func (*Context) SetBusinessAccountGiftSettings

func (ctx *Context) SetBusinessAccountGiftSettings(
	showGiftButton bool,
	acceptedGiftTypes AcceptedGiftTypes,
	opts ...SetBusinessAccountGiftSettingsOption,
) error

func (*Context) SetBusinessAccountName

func (ctx *Context) SetBusinessAccountName(
	firstName string,
	opts ...SetBusinessAccountNameOption,
) error

func (*Context) SetBusinessAccountProfilePhoto

func (ctx *Context) SetBusinessAccountProfilePhoto(
	photo InputProfilePhoto,
	opts ...SetBusinessAccountProfilePhotoOption,
) error

func (*Context) SetBusinessAccountUsername

func (ctx *Context) SetBusinessAccountUsername(
	opts ...SetBusinessAccountUsernameOption,
) error

func (*Context) SetChatAdministratorCustomTitle

func (ctx *Context) SetChatAdministratorCustomTitle(
	userID int64,
	customTitle string,
	opts ...SetChatAdministratorCustomTitleOption,
) error

func (*Context) SetChatDescription

func (ctx *Context) SetChatDescription(
	opts ...SetChatDescriptionOption,
) error

func (*Context) SetChatMenuButton

func (ctx *Context) SetChatMenuButton(
	opts ...SetChatMenuButtonOption,
) error

func (*Context) SetChatPermissions

func (ctx *Context) SetChatPermissions(
	permissions ChatPermissions,
	opts ...SetChatPermissionsOption,
) error

func (*Context) SetChatPhoto

func (ctx *Context) SetChatPhoto(
	photo InputFile,
	opts ...SetChatPhotoOption,
) error

func (*Context) SetChatStickerSet

func (ctx *Context) SetChatStickerSet(
	stickerSetName string,
	opts ...SetChatStickerSetOption,
) error

func (*Context) SetChatTitle

func (ctx *Context) SetChatTitle(
	title string,
	opts ...SetChatTitleOption,
) error

func (*Context) SetCustomEmojiStickerSetThumbnail

func (ctx *Context) SetCustomEmojiStickerSetThumbnail(
	name string,
	opts ...SetCustomEmojiStickerSetThumbnailOption,
) error

func (*Context) SetGameScore

func (ctx *Context) SetGameScore(
	userID int64,
	score int64,
	opts ...SetGameScoreOption,
) error

func (*Context) SetMessageReaction

func (ctx *Context) SetMessageReaction(
	messageID int64,
	opts ...SetMessageReactionOption,
) error

func (*Context) SetMyCommands

func (ctx *Context) SetMyCommands(
	commands []BotCommand,
	opts ...SetMyCommandsOption,
) error

func (*Context) SetMyDefaultAdministratorRights

func (ctx *Context) SetMyDefaultAdministratorRights(
	opts ...SetMyDefaultAdministratorRightsOption,
) error

func (*Context) SetMyDescription

func (ctx *Context) SetMyDescription(
	opts ...SetMyDescriptionOption,
) error

func (*Context) SetMyName

func (ctx *Context) SetMyName(
	opts ...SetMyNameOption,
) error

func (*Context) SetMyProfilePhoto

func (ctx *Context) SetMyProfilePhoto(
	photo InputProfilePhoto,
	opts ...SetMyProfilePhotoOption,
) error

func (*Context) SetMyShortDescription

func (ctx *Context) SetMyShortDescription(
	opts ...SetMyShortDescriptionOption,
) error

func (*Context) SetPassportDataErrors

func (ctx *Context) SetPassportDataErrors(
	userID int64,
	errors []PassportElementError,
	opts ...SetPassportDataErrorsOption,
) error

func (*Context) SetStickerEmojiList

func (ctx *Context) SetStickerEmojiList(
	sticker string,
	emojiList []string,
	opts ...SetStickerEmojiListOption,
) error

func (*Context) SetStickerKeywords

func (ctx *Context) SetStickerKeywords(
	sticker string,
	opts ...SetStickerKeywordsOption,
) error

func (*Context) SetStickerMaskPosition

func (ctx *Context) SetStickerMaskPosition(
	sticker string,
	opts ...SetStickerMaskPositionOption,
) error

func (*Context) SetStickerPositionInSet

func (ctx *Context) SetStickerPositionInSet(
	sticker string,
	position int64,
	opts ...SetStickerPositionInSetOption,
) error

func (*Context) SetStickerSetThumbnail

func (ctx *Context) SetStickerSetThumbnail(
	name string,
	userID int64,
	format string,
	opts ...SetStickerSetThumbnailOption,
) error

func (*Context) SetStickerSetTitle

func (ctx *Context) SetStickerSetTitle(
	name string,
	title string,
	opts ...SetStickerSetTitleOption,
) error

func (*Context) SetUserEmojiStatus

func (ctx *Context) SetUserEmojiStatus(
	userID int64,
	opts ...SetUserEmojiStatusOption,
) error

func (*Context) SetValue

func (ctx *Context) SetValue(key, value any)

func (*Context) SetWebhook

func (ctx *Context) SetWebhook(
	uRL string,
	opts ...SetWebhookOption,
) error

func (*Context) StopMessageLiveLocation

func (ctx *Context) StopMessageLiveLocation(
	opts ...StopMessageLiveLocationOption,
) error

func (*Context) StopPoll

func (ctx *Context) StopPoll(
	messageID int64,
	opts ...StopPollOption,
) error

func (*Context) Text

func (ctx *Context) Text() string

func (*Context) TransferBusinessAccountStars

func (ctx *Context) TransferBusinessAccountStars(
	starCount int64,
	opts ...TransferBusinessAccountStarsOption,
) error

func (*Context) TransferGift

func (ctx *Context) TransferGift(
	ownedGiftID string,
	newOwnerChatID int64,
	opts ...TransferGiftOption,
) error

func (*Context) UnbanChatMember

func (ctx *Context) UnbanChatMember(
	userID int64,
	opts ...UnbanChatMemberOption,
) error

func (*Context) UnbanChatSenderChat

func (ctx *Context) UnbanChatSenderChat(
	senderChatID int64,
	opts ...UnbanChatSenderChatOption,
) error

func (*Context) UnhideGeneralForumTopic

func (ctx *Context) UnhideGeneralForumTopic(
	opts ...UnhideGeneralForumTopicOption,
) error

func (*Context) UnpinAllChatMessages

func (ctx *Context) UnpinAllChatMessages(
	opts ...UnpinAllChatMessagesOption,
) error

func (*Context) UnpinAllForumTopicMessages

func (ctx *Context) UnpinAllForumTopicMessages(
	messageThreadID int64,
	opts ...UnpinAllForumTopicMessagesOption,
) error

func (*Context) UnpinAllGeneralForumTopicMessages

func (ctx *Context) UnpinAllGeneralForumTopicMessages(
	opts ...UnpinAllGeneralForumTopicMessagesOption,
) error

func (*Context) UnpinChatMessage

func (ctx *Context) UnpinChatMessage(
	opts ...UnpinChatMessageOption,
) error

func (*Context) Update

func (ctx *Context) Update() *Update

func (*Context) UpgradeGift

func (ctx *Context) UpgradeGift(
	ownedGiftID string,
	opts ...UpgradeGiftOption,
) error

func (*Context) UploadStickerFile

func (ctx *Context) UploadStickerFile(
	userID int64,
	sticker InputFile,
	stickerFormat string,
	opts ...UploadStickerFileOption,
) error

func (*Context) User

func (ctx *Context) User() *User

func (*Context) Value

func (ctx *Context) Value(key any) any

func (*Context) VerifyChat

func (ctx *Context) VerifyChat(
	opts ...VerifyChatOption,
) error

func (*Context) VerifyUser

func (ctx *Context) VerifyUser(
	userID int64,
	opts ...VerifyUserOption,
) error

type ConvertGiftToStarsOption

type ConvertGiftToStarsOption func(params *ConvertGiftToStarsParams) ConvertGiftToStarsOption

func WithConvertGiftToStarsBusinessConnectionID

func WithConvertGiftToStarsBusinessConnectionID(value string) ConvertGiftToStarsOption

Unique identifier of the business connection

func WithConvertGiftToStarsOwnedGiftID

func WithConvertGiftToStarsOwnedGiftID(value string) ConvertGiftToStarsOption

Unique identifier of the regular gift that should be converted to Telegram Stars

type ConvertGiftToStarsParams

type ConvertGiftToStarsParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Unique identifier of the regular gift that should be converted to Telegram Stars
	OwnedGiftID string `json:"owned_gift_id"`
}

func (*ConvertGiftToStarsParams) Option

type CopyMessageOption

type CopyMessageOption func(params *CopyMessageParams) CopyMessageOption

func WithCopyMessageAllowPaidBroadcast

func WithCopyMessageAllowPaidBroadcast(value bool) CopyMessageOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithCopyMessageCaption

func WithCopyMessageCaption(value string) CopyMessageOption

New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept

func WithCopyMessageCaptionEntities

func WithCopyMessageCaptionEntities(value []MessageEntity) CopyMessageOption

A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode

func WithCopyMessageChatID

func WithCopyMessageChatID(value string) CopyMessageOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithCopyMessageDirectMessagesTopicID

func WithCopyMessageDirectMessagesTopicID(value int64) CopyMessageOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithCopyMessageDisableNotification

func WithCopyMessageDisableNotification(value bool) CopyMessageOption

Sends the message silently. Users will receive a notification with no sound.

func WithCopyMessageFromChatID

func WithCopyMessageFromChatID(value string) CopyMessageOption

Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)

func WithCopyMessageMessageEffectID

func WithCopyMessageMessageEffectID(value string) CopyMessageOption

Unique identifier of the message effect to be added to the message; only available when copying to private chats

func WithCopyMessageMessageID

func WithCopyMessageMessageID(value int64) CopyMessageOption

Message identifier in the chat specified in from_chat_id

func WithCopyMessageMessageThreadID

func WithCopyMessageMessageThreadID(value int64) CopyMessageOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithCopyMessageParseMode

func WithCopyMessageParseMode(value string) CopyMessageOption

Mode for parsing entities in the new caption. See formatting options for more details.

func WithCopyMessageProtectContent

func WithCopyMessageProtectContent(value bool) CopyMessageOption

Protects the contents of the sent message from forwarding and saving

func WithCopyMessageReplyMarkup

func WithCopyMessageReplyMarkup(value *ReplyMarkup) CopyMessageOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithCopyMessageReplyParameters

func WithCopyMessageReplyParameters(value *ReplyParameters) CopyMessageOption

Description of the message to reply to

func WithCopyMessageShowCaptionAboveMedia

func WithCopyMessageShowCaptionAboveMedia(value bool) CopyMessageOption

Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified.

func WithCopyMessageSuggestedPostParameters

func WithCopyMessageSuggestedPostParameters(value *SuggestedPostParameters) CopyMessageOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

func WithCopyMessageVideoStartTimestamp

func WithCopyMessageVideoStartTimestamp(value int64) CopyMessageOption

New start timestamp for the copied video in the message

type CopyMessageParams

type CopyMessageParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
	FromChatID string `json:"from_chat_id"`

	// Message identifier in the chat specified in from_chat_id
	MessageID int64 `json:"message_id"`

	// New start timestamp for the copied video in the message
	VideoStartTimestamp int64 `json:"video_start_timestamp,omitempty"`

	// New caption for media, 0-1024 characters after entities parsing.
	// If not specified, the original caption is kept
	Caption string `json:"caption,omitempty"`

	// Mode for parsing entities in the new caption.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized list of special entities that appear in the new 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.
	// Ignored if a new caption isn't specified.
	ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; only available when copying to private chats
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*CopyMessageParams) Option

func (r *CopyMessageParams) Option(opts ...CopyMessageOption) (previous CopyMessageOption)

type CopyMessagesOption

type CopyMessagesOption func(params *CopyMessagesParams) CopyMessagesOption

func WithCopyMessagesChatID

func WithCopyMessagesChatID(value string) CopyMessagesOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithCopyMessagesDirectMessagesTopicID

func WithCopyMessagesDirectMessagesTopicID(value int64) CopyMessagesOption

Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat

func WithCopyMessagesDisableNotification

func WithCopyMessagesDisableNotification(value bool) CopyMessagesOption

Sends the messages silently. Users will receive a notification with no sound.

func WithCopyMessagesFromChatID

func WithCopyMessagesFromChatID(value string) CopyMessagesOption

Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)

func WithCopyMessagesMessageIDs

func WithCopyMessagesMessageIDs(value []int64) CopyMessagesOption

A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.

func WithCopyMessagesMessageThreadID

func WithCopyMessagesMessageThreadID(value int64) CopyMessagesOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithCopyMessagesProtectContent

func WithCopyMessagesProtectContent(value bool) CopyMessagesOption

Protects the contents of the sent messages from forwarding and saving

func WithCopyMessagesRemoveCaption

func WithCopyMessagesRemoveCaption(value bool) CopyMessagesOption

Pass True to copy the messages without their captions

type CopyMessagesParams

type CopyMessagesParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)
	FromChatID string `json:"from_chat_id"`

	// A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy.
	// The identifiers must be specified in a strictly increasing order.
	MessageIDs []int64 `json:"message_ids"`

	// Sends the messages [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent messages from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to copy the messages without their captions
	RemoveCaption bool `json:"remove_caption,omitempty"`
}

func (*CopyMessagesParams) Option

func (r *CopyMessagesParams) Option(opts ...CopyMessagesOption) (previous CopyMessagesOption)

type CopyTextButton

type CopyTextButton struct {
	// The text to be copied to the clipboard; 1-256 characters
	Text string `json:"text"`
}

CopyTextButton

This object represents an inline keyboard button that copies specified text to the clipboard.

type CreateChatInviteLinkOption

type CreateChatInviteLinkOption func(params *CreateChatInviteLinkParams) CreateChatInviteLinkOption

func WithCreateChatInviteLinkChatID

func WithCreateChatInviteLinkChatID(value string) CreateChatInviteLinkOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithCreateChatInviteLinkCreatesJoinRequest

func WithCreateChatInviteLinkCreatesJoinRequest(value bool) CreateChatInviteLinkOption

True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified

func WithCreateChatInviteLinkExpireDate

func WithCreateChatInviteLinkExpireDate(value int64) CreateChatInviteLinkOption

Point in time (Unix timestamp) when the link will expire

func WithCreateChatInviteLinkMemberLimit

func WithCreateChatInviteLinkMemberLimit(value int64) CreateChatInviteLinkOption

The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999

func WithCreateChatInviteLinkName

func WithCreateChatInviteLinkName(value string) CreateChatInviteLinkOption

Invite link name; 0-32 characters

type CreateChatInviteLinkParams

type CreateChatInviteLinkParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Invite link name; 0-32 characters
	Name string `json:"name,omitempty"`

	// Point in time (Unix timestamp) when the link will expire
	ExpireDate int64 `json:"expire_date,omitempty"`

	// The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
	MemberLimit int64 `json:"member_limit,omitempty"`

	// True, if users joining the chat via the link need to be approved by chat administrators.
	// If True, member_limit can't be specified
	CreatesJoinRequest bool `json:"creates_join_request,omitempty"`
}

func (*CreateChatInviteLinkParams) Option

type CreateChatSubscriptionInviteLinkOption

type CreateChatSubscriptionInviteLinkOption func(params *CreateChatSubscriptionInviteLinkParams) CreateChatSubscriptionInviteLinkOption

func WithCreateChatSubscriptionInviteLinkChatID

func WithCreateChatSubscriptionInviteLinkChatID(value string) CreateChatSubscriptionInviteLinkOption

Unique identifier for the target channel chat or username of the target channel (in the format @channelusername)

func WithCreateChatSubscriptionInviteLinkName

func WithCreateChatSubscriptionInviteLinkName(value string) CreateChatSubscriptionInviteLinkOption

Invite link name; 0-32 characters

func WithCreateChatSubscriptionInviteLinkSubscriptionPeriod

func WithCreateChatSubscriptionInviteLinkSubscriptionPeriod(value int64) CreateChatSubscriptionInviteLinkOption

The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).

func WithCreateChatSubscriptionInviteLinkSubscriptionPrice

func WithCreateChatSubscriptionInviteLinkSubscriptionPrice(value int64) CreateChatSubscriptionInviteLinkOption

The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000

type CreateChatSubscriptionInviteLinkParams

type CreateChatSubscriptionInviteLinkParams struct {
	// Unique identifier for the target channel chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Invite link name; 0-32 characters
	Name string `json:"name,omitempty"`

	// The number of seconds the subscription will be active for before the next payment.
	// Currently, it must always be 2592000 (30 days).
	SubscriptionPeriod int64 `json:"subscription_period"`

	// The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000
	SubscriptionPrice int64 `json:"subscription_price"`
}

func (*CreateChatSubscriptionInviteLinkParams) Option

type CreateForumTopicOption

type CreateForumTopicOption func(params *CreateForumTopicParams) CreateForumTopicOption

func WithCreateForumTopicChatID

func WithCreateForumTopicChatID(value string) CreateForumTopicOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

func WithCreateForumTopicIconColor

func WithCreateForumTopicIconColor(value int64) CreateForumTopicOption

Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F)

func WithCreateForumTopicIconCustomEmojiID

func WithCreateForumTopicIconCustomEmojiID(value string) CreateForumTopicOption

Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.

func WithCreateForumTopicName

func WithCreateForumTopicName(value string) CreateForumTopicOption

Topic name, 1-128 characters

type CreateForumTopicParams

type CreateForumTopicParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`

	// Topic name, 1-128 characters
	Name string `json:"name"`

	// Color of the topic icon in RGB format.
	// Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F)
	IconColor int64 `json:"icon_color,omitempty"`

	// Unique identifier of the custom emoji shown as the topic icon.
	// Use [getForumTopicIconStickers] to get all allowed custom emoji identifiers.
	//
	// [getForumTopicIconStickers]: https://core.telegram.org/bots/api#getforumtopiciconstickers
	IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
}

func (*CreateForumTopicParams) Option

type CreateInvoiceLinkOption

type CreateInvoiceLinkOption func(params *CreateInvoiceLinkParams) CreateInvoiceLinkOption

func WithCreateInvoiceLinkBusinessConnectionID

func WithCreateInvoiceLinkBusinessConnectionID(value string) CreateInvoiceLinkOption

Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.

func WithCreateInvoiceLinkCurrency

func WithCreateInvoiceLinkCurrency(value string) CreateInvoiceLinkOption

Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.

func WithCreateInvoiceLinkDescription

func WithCreateInvoiceLinkDescription(value string) CreateInvoiceLinkOption

Product description, 1-255 characters

func WithCreateInvoiceLinkIsFlexible

func WithCreateInvoiceLinkIsFlexible(value bool) CreateInvoiceLinkOption

Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.

func WithCreateInvoiceLinkMaxTipAmount

func WithCreateInvoiceLinkMaxTipAmount(value int64) CreateInvoiceLinkOption

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 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.

func WithCreateInvoiceLinkNeedEmail

func WithCreateInvoiceLinkNeedEmail(value bool) CreateInvoiceLinkOption

Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.

func WithCreateInvoiceLinkNeedName

func WithCreateInvoiceLinkNeedName(value bool) CreateInvoiceLinkOption

Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.

func WithCreateInvoiceLinkNeedPhoneNumber

func WithCreateInvoiceLinkNeedPhoneNumber(value bool) CreateInvoiceLinkOption

Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.

func WithCreateInvoiceLinkNeedShippingAddress

func WithCreateInvoiceLinkNeedShippingAddress(value bool) CreateInvoiceLinkOption

Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.

func WithCreateInvoiceLinkPayload

func WithCreateInvoiceLinkPayload(value string) CreateInvoiceLinkOption

Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.

func WithCreateInvoiceLinkPhotoHeight

func WithCreateInvoiceLinkPhotoHeight(value int64) CreateInvoiceLinkOption

Photo height

func WithCreateInvoiceLinkPhotoSize

func WithCreateInvoiceLinkPhotoSize(value int64) CreateInvoiceLinkOption

Photo size in bytes

func WithCreateInvoiceLinkPhotoUrl

func WithCreateInvoiceLinkPhotoUrl(value string) CreateInvoiceLinkOption

URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.

func WithCreateInvoiceLinkPhotoWidth

func WithCreateInvoiceLinkPhotoWidth(value int64) CreateInvoiceLinkOption

Photo width

func WithCreateInvoiceLinkPrices

func WithCreateInvoiceLinkPrices(value []LabeledPrice) CreateInvoiceLinkOption

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.

func WithCreateInvoiceLinkProviderData

func WithCreateInvoiceLinkProviderData(value string) CreateInvoiceLinkOption

JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.

func WithCreateInvoiceLinkProviderToken

func WithCreateInvoiceLinkProviderToken(value string) CreateInvoiceLinkOption

Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.

func WithCreateInvoiceLinkSendEmailToProvider

func WithCreateInvoiceLinkSendEmailToProvider(value bool) CreateInvoiceLinkOption

Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.

func WithCreateInvoiceLinkSendPhoneNumberToProvider

func WithCreateInvoiceLinkSendPhoneNumberToProvider(value bool) CreateInvoiceLinkOption

Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.

func WithCreateInvoiceLinkSubscriptionPeriod

func WithCreateInvoiceLinkSubscriptionPeriod(value int64) CreateInvoiceLinkOption

The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.

func WithCreateInvoiceLinkSuggestedTipAmounts

func WithCreateInvoiceLinkSuggestedTipAmounts(value []int64) CreateInvoiceLinkOption

A JSON-serialized array of suggested amounts of tips 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.

func WithCreateInvoiceLinkTitle

func WithCreateInvoiceLinkTitle(value string) CreateInvoiceLinkOption

Product name, 1-32 characters

type CreateInvoiceLinkParams

type CreateInvoiceLinkParams struct {
	// Unique identifier of the business connection on behalf of which the link will be created.
	// For payments in [Telegram Stars] only.
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// 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"`

	// Payment provider token, obtained via [@BotFather].
	// Pass an empty string for payments in [Telegram Stars].
	//
	// [@BotFather]: https://t.me/botfather
	// [Telegram Stars]: https://t.me/BotNews/90
	ProviderToken string `json:"provider_token,omitempty"`

	// Three-letter ISO 4217 currency code, see [more on currencies].
	// Pass “XTR” for payments in [Telegram Stars].
	//
	// [more on currencies]: https://core.telegram.org/bots/payments#supported-currencies
	// [Telegram Stars]: https://t.me/BotNews/90
	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].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	Prices []LabeledPrice `json:"prices"`

	// The number of seconds the subscription will be active for before the next payment.
	// The currency must be set to “XTR” (Telegram Stars) if the parameter is used.
	// Currently, it must always be 2592000 (30 days) if specified.
	// Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user.
	// Subscription price must no exceed 10000 Telegram Stars.
	SubscriptionPeriod int64 `json:"subscription_period,omitempty"`

	// 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 [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].
	//
	// [currencies.json]: https://core.telegram.org/bots/payments/currencies.json
	// [Telegram Stars]: https://t.me/BotNews/90
	MaxTipAmount int64 `json:"max_tip_amount,omitempty"`

	// A JSON-serialized array of suggested amounts of tips 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 []int64 `json:"suggested_tip_amounts,omitempty"`

	// JSON-serialized data about the invoice, which will be shared with the payment provider.
	// A detailed description of required fields should be provided by the payment provider.
	ProviderData string `json:"provider_data,omitempty"`

	// 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"`

	// Photo size in bytes
	PhotoSize int64 `json:"photo_size,omitempty"`

	// Photo width
	PhotoWidth int64 `json:"photo_width,omitempty"`

	// Photo height
	PhotoHeight int64 `json:"photo_height,omitempty"`

	// Pass True if you require the user's full name to complete the order.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	NeedName bool `json:"need_name,omitempty"`

	// Pass True if you require the user's phone number to complete the order.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	NeedPhoneNumber bool `json:"need_phone_number,omitempty"`

	// Pass True if you require the user's email address to complete the order.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	NeedEmail bool `json:"need_email,omitempty"`

	// Pass True if you require the user's shipping address to complete the order.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	NeedShippingAddress bool `json:"need_shipping_address,omitempty"`

	// Pass True if the user's phone number should be sent to the provider.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	SendPhoneNumberToProvider bool `json:"send_phone_number_to_provider,omitempty"`

	// Pass True if the user's email address should be sent to the provider.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	SendEmailToProvider bool `json:"send_email_to_provider,omitempty"`

	// Pass True if the final price depends on the shipping method.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	IsFlexible bool `json:"is_flexible,omitempty"`
}

func (*CreateInvoiceLinkParams) Option

type CreateNewStickerSetOption

type CreateNewStickerSetOption func(params *CreateNewStickerSetParams) CreateNewStickerSetOption

func WithCreateNewStickerSetName

func WithCreateNewStickerSetName(value string) CreateNewStickerSetOption

Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "_by_<bot_username>". <bot_username> is case insensitive. 1-64 characters.

func WithCreateNewStickerSetNeedsRepainting

func WithCreateNewStickerSetNeedsRepainting(value bool) CreateNewStickerSetOption

Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only

func WithCreateNewStickerSetStickerType

func WithCreateNewStickerSetStickerType(value string) CreateNewStickerSetOption

Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created.

func WithCreateNewStickerSetStickers

func WithCreateNewStickerSetStickers(value []InputSticker) CreateNewStickerSetOption

A JSON-serialized list of 1-50 initial stickers to be added to the sticker set

func WithCreateNewStickerSetTitle

func WithCreateNewStickerSetTitle(value string) CreateNewStickerSetOption

Sticker set title, 1-64 characters

func WithCreateNewStickerSetUserID

func WithCreateNewStickerSetUserID(value int64) CreateNewStickerSetOption

User identifier of created sticker set owner

type CreateNewStickerSetParams

type CreateNewStickerSetParams struct {
	// User identifier of created sticker set owner
	UserID int64 `json:"user_id"`

	// Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals).
	// Can contain only English letters, digits and underscores.
	// Must begin with a letter, can't contain consecutive underscores and must end in "_by_<bot_username>".
	// <bot_username> is case insensitive.
	// 1-64 characters.
	Name string `json:"name"`

	// Sticker set title, 1-64 characters
	Title string `json:"title"`

	// A JSON-serialized list of 1-50 initial stickers to be added to the sticker set
	Stickers []InputSticker `json:"stickers"`

	// Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”.
	// By default, a regular sticker set is created.
	StickerType string `json:"sticker_type,omitempty"`

	// Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only
	NeedsRepainting bool `json:"needs_repainting,omitempty"`
}

func (*CreateNewStickerSetParams) Option

type DeclineChatJoinRequestOption

type DeclineChatJoinRequestOption func(params *DeclineChatJoinRequestParams) DeclineChatJoinRequestOption

func WithDeclineChatJoinRequestChatID

func WithDeclineChatJoinRequestChatID(value string) DeclineChatJoinRequestOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithDeclineChatJoinRequestUserID

func WithDeclineChatJoinRequestUserID(value int64) DeclineChatJoinRequestOption

Unique identifier of the target user

type DeclineChatJoinRequestParams

type DeclineChatJoinRequestParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier of the target user
	UserID int64 `json:"user_id"`
}

func (*DeclineChatJoinRequestParams) Option

type DeclineSuggestedPostOption

type DeclineSuggestedPostOption func(params *DeclineSuggestedPostParams) DeclineSuggestedPostOption

func WithDeclineSuggestedPostChatID

func WithDeclineSuggestedPostChatID(value int64) DeclineSuggestedPostOption

Unique identifier for the target direct messages chat

func WithDeclineSuggestedPostComment

func WithDeclineSuggestedPostComment(value string) DeclineSuggestedPostOption

Comment for the creator of the suggested post; 0-128 characters

func WithDeclineSuggestedPostMessageID

func WithDeclineSuggestedPostMessageID(value int64) DeclineSuggestedPostOption

Identifier of a suggested post message to decline

type DeclineSuggestedPostParams

type DeclineSuggestedPostParams struct {
	// Unique identifier for the target direct messages chat
	ChatID int64 `json:"chat_id"`

	// Identifier of a suggested post message to decline
	MessageID int64 `json:"message_id"`

	// Comment for the creator of the suggested post; 0-128 characters
	Comment string `json:"comment,omitempty"`
}

func (*DeclineSuggestedPostParams) Option

type DeleteBusinessMessagesOption

type DeleteBusinessMessagesOption func(params *DeleteBusinessMessagesParams) DeleteBusinessMessagesOption

func WithDeleteBusinessMessagesBusinessConnectionID

func WithDeleteBusinessMessagesBusinessConnectionID(value string) DeleteBusinessMessagesOption

Unique identifier of the business connection on behalf of which to delete the messages

func WithDeleteBusinessMessagesMessageIDs

func WithDeleteBusinessMessagesMessageIDs(value []int64) DeleteBusinessMessagesOption

A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See deleteMessage for limitations on which messages can be deleted

type DeleteBusinessMessagesParams

type DeleteBusinessMessagesParams struct {
	// Unique identifier of the business connection on behalf of which to delete the messages
	BusinessConnectionID string `json:"business_connection_id"`

	// A JSON-serialized list of 1-100 identifiers of messages to delete.
	// All messages must be from the same chat.
	// See [deleteMessage] for limitations on which messages can be deleted
	//
	// [deleteMessage]: https://core.telegram.org/bots/api#deletemessage
	MessageIDs []int64 `json:"message_ids"`
}

func (*DeleteBusinessMessagesParams) Option

type DeleteChatPhotoOption

type DeleteChatPhotoOption func(params *DeleteChatPhotoParams) DeleteChatPhotoOption

func WithDeleteChatPhotoChatID

func WithDeleteChatPhotoChatID(value string) DeleteChatPhotoOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

type DeleteChatPhotoParams

type DeleteChatPhotoParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`
}

func (*DeleteChatPhotoParams) Option

type DeleteChatStickerSetOption

type DeleteChatStickerSetOption func(params *DeleteChatStickerSetParams) DeleteChatStickerSetOption

func WithDeleteChatStickerSetChatID

func WithDeleteChatStickerSetChatID(value string) DeleteChatStickerSetOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

type DeleteChatStickerSetParams

type DeleteChatStickerSetParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`
}

func (*DeleteChatStickerSetParams) Option

type DeleteForumTopicOption

type DeleteForumTopicOption func(params *DeleteForumTopicParams) DeleteForumTopicOption

func WithDeleteForumTopicChatID

func WithDeleteForumTopicChatID(value string) DeleteForumTopicOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

func WithDeleteForumTopicMessageThreadID

func WithDeleteForumTopicMessageThreadID(value int64) DeleteForumTopicOption

Unique identifier for the target message thread of the forum topic

type DeleteForumTopicParams

type DeleteForumTopicParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread of the forum topic
	MessageThreadID int64 `json:"message_thread_id"`
}

func (*DeleteForumTopicParams) Option

type DeleteMessageOption

type DeleteMessageOption func(params *DeleteMessageParams) DeleteMessageOption

func WithDeleteMessageChatID

func WithDeleteMessageChatID(value string) DeleteMessageOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithDeleteMessageMessageID

func WithDeleteMessageMessageID(value int64) DeleteMessageOption

Identifier of the message to delete

type DeleteMessageParams

type DeleteMessageParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Identifier of the message to delete
	MessageID int64 `json:"message_id"`
}

func (*DeleteMessageParams) Option

func (r *DeleteMessageParams) Option(opts ...DeleteMessageOption) (previous DeleteMessageOption)

type DeleteMessagesOption

type DeleteMessagesOption func(params *DeleteMessagesParams) DeleteMessagesOption

func WithDeleteMessagesChatID

func WithDeleteMessagesChatID(value string) DeleteMessagesOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithDeleteMessagesMessageIDs

func WithDeleteMessagesMessageIDs(value []int64) DeleteMessagesOption

A JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted

type DeleteMessagesParams

type DeleteMessagesParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// A JSON-serialized list of 1-100 identifiers of messages to delete.
	// See [deleteMessage] for limitations on which messages can be deleted
	//
	// [deleteMessage]: https://core.telegram.org/bots/api#deletemessage
	MessageIDs []int64 `json:"message_ids"`
}

func (*DeleteMessagesParams) Option

func (r *DeleteMessagesParams) Option(opts ...DeleteMessagesOption) (previous DeleteMessagesOption)

type DeleteMyCommandsOption

type DeleteMyCommandsOption func(params *DeleteMyCommandsParams) DeleteMyCommandsOption

func WithDeleteMyCommandsLanguageCode

func WithDeleteMyCommandsLanguageCode(value string) DeleteMyCommandsOption

A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands

func WithDeleteMyCommandsScope

func WithDeleteMyCommandsScope(value *BotCommandScope) DeleteMyCommandsOption

A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.

type DeleteMyCommandsParams

type DeleteMyCommandsParams struct {
	// A JSON-serialized object, describing scope of users for which the commands are relevant.
	// Defaults to [BotCommandScopeDefault].
	//
	// [BotCommandScopeDefault]: https://core.telegram.org/bots/api#botcommandscopedefault
	Scope *BotCommandScope `json:"scope,omitempty"`

	// A two-letter ISO 639-1 language code.
	// If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands
	LanguageCode string `json:"language_code,omitempty"`
}

func (*DeleteMyCommandsParams) Option

type DeleteStickerFromSetOption

type DeleteStickerFromSetOption func(params *DeleteStickerFromSetParams) DeleteStickerFromSetOption

func WithDeleteStickerFromSetSticker

func WithDeleteStickerFromSetSticker(value string) DeleteStickerFromSetOption

File identifier of the sticker

type DeleteStickerFromSetParams

type DeleteStickerFromSetParams struct {
	// File identifier of the sticker
	Sticker string `json:"sticker"`
}

func (*DeleteStickerFromSetParams) Option

type DeleteStickerSetOption

type DeleteStickerSetOption func(params *DeleteStickerSetParams) DeleteStickerSetOption

func WithDeleteStickerSetName

func WithDeleteStickerSetName(value string) DeleteStickerSetOption

Sticker set name

type DeleteStickerSetParams

type DeleteStickerSetParams struct {
	// Sticker set name
	Name string `json:"name"`
}

func (*DeleteStickerSetParams) Option

type DeleteStoryOption

type DeleteStoryOption func(params *DeleteStoryParams) DeleteStoryOption

func WithDeleteStoryBusinessConnectionID

func WithDeleteStoryBusinessConnectionID(value string) DeleteStoryOption

Unique identifier of the business connection

func WithDeleteStoryStoryID

func WithDeleteStoryStoryID(value int64) DeleteStoryOption

Unique identifier of the story to delete

type DeleteStoryParams

type DeleteStoryParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Unique identifier of the story to delete
	StoryID int64 `json:"story_id"`
}

func (*DeleteStoryParams) Option

func (r *DeleteStoryParams) Option(opts ...DeleteStoryOption) (previous DeleteStoryOption)

type DeleteWebhookOption

type DeleteWebhookOption func(params *DeleteWebhookParams) DeleteWebhookOption

func WithDeleteWebhookDropPendingUpdates

func WithDeleteWebhookDropPendingUpdates(value bool) DeleteWebhookOption

Pass True to drop all pending updates

type DeleteWebhookParams

type DeleteWebhookParams struct {
	// Pass True to drop all pending updates
	DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
}

func (*DeleteWebhookParams) Option

func (r *DeleteWebhookParams) Option(opts ...DeleteWebhookOption) (previous DeleteWebhookOption)

type Dice

type Dice struct {
	// Emoji on which the dice throw animation is based
	Emoji string `json:"emoji"`

	// Value of the dice, 1-6 for “”, “” and “” base emoji, 1-5 for “” and “” base emoji, 1-64 for “” base emoji
	Value int64 `json:"value"`
}

Dice

This object represents an animated emoji that displays a random value.

type DirectMessagePriceChanged

type DirectMessagePriceChanged struct {
	// True, if direct messages are enabled for the channel chat; false otherwise
	AreDirectMessagesEnabled bool `json:"are_direct_messages_enabled"`

	// Optional.
	// The new number of Telegram Stars that must be paid by users for each direct message sent to the channel.
	// Does not apply to users who have been exempted by administrators.
	// Defaults to 0.
	DirectMessageStarCount int64 `json:"direct_message_star_count,omitempty"`
}

DirectMessagePriceChanged

Describes a service message about a change in the price of direct messages sent to a channel chat.

type DirectMessagesTopic

type DirectMessagesTopic struct {
	// Unique identifier of the topic.
	// 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.
	TopicID int64 `json:"topic_id"`

	// Optional.
	// Information about the user that created the topic.
	// Currently, it is always present
	User *User `json:"user,omitempty"`
}

DirectMessagesTopic

Describes a topic of a direct messages chat.

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"`
}

Document

This object represents a general file (as opposed to photos, voice messages and audio files).

type EditChatInviteLinkOption

type EditChatInviteLinkOption func(params *EditChatInviteLinkParams) EditChatInviteLinkOption

func WithEditChatInviteLinkChatID

func WithEditChatInviteLinkChatID(value string) EditChatInviteLinkOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithEditChatInviteLinkCreatesJoinRequest

func WithEditChatInviteLinkCreatesJoinRequest(value bool) EditChatInviteLinkOption

True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified

func WithEditChatInviteLinkExpireDate

func WithEditChatInviteLinkExpireDate(value int64) EditChatInviteLinkOption

Point in time (Unix timestamp) when the link will expire

func WithEditChatInviteLinkInviteLink(value string) EditChatInviteLinkOption

The invite link to edit

func WithEditChatInviteLinkMemberLimit

func WithEditChatInviteLinkMemberLimit(value int64) EditChatInviteLinkOption

The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999

func WithEditChatInviteLinkName

func WithEditChatInviteLinkName(value string) EditChatInviteLinkOption

Invite link name; 0-32 characters

type EditChatInviteLinkParams

type EditChatInviteLinkParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// The invite link to edit
	InviteLink string `json:"invite_link"`

	// Invite link name; 0-32 characters
	Name string `json:"name,omitempty"`

	// Point in time (Unix timestamp) when the link will expire
	ExpireDate int64 `json:"expire_date,omitempty"`

	// The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
	MemberLimit int64 `json:"member_limit,omitempty"`

	// True, if users joining the chat via the link need to be approved by chat administrators.
	// If True, member_limit can't be specified
	CreatesJoinRequest bool `json:"creates_join_request,omitempty"`
}

func (*EditChatInviteLinkParams) Option

type EditChatSubscriptionInviteLinkOption

type EditChatSubscriptionInviteLinkOption func(params *EditChatSubscriptionInviteLinkParams) EditChatSubscriptionInviteLinkOption

func WithEditChatSubscriptionInviteLinkChatID

func WithEditChatSubscriptionInviteLinkChatID(value string) EditChatSubscriptionInviteLinkOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithEditChatSubscriptionInviteLinkInviteLink(value string) EditChatSubscriptionInviteLinkOption

The invite link to edit

func WithEditChatSubscriptionInviteLinkName

func WithEditChatSubscriptionInviteLinkName(value string) EditChatSubscriptionInviteLinkOption

Invite link name; 0-32 characters

type EditChatSubscriptionInviteLinkParams

type EditChatSubscriptionInviteLinkParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// The invite link to edit
	InviteLink string `json:"invite_link"`

	// Invite link name; 0-32 characters
	Name string `json:"name,omitempty"`
}

func (*EditChatSubscriptionInviteLinkParams) Option

type EditForumTopicOption

type EditForumTopicOption func(params *EditForumTopicParams) EditForumTopicOption

func WithEditForumTopicChatID

func WithEditForumTopicChatID(value string) EditForumTopicOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

func WithEditForumTopicIconCustomEmojiID

func WithEditForumTopicIconCustomEmojiID(value string) EditForumTopicOption

New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept

func WithEditForumTopicMessageThreadID

func WithEditForumTopicMessageThreadID(value int64) EditForumTopicOption

Unique identifier for the target message thread of the forum topic

func WithEditForumTopicName

func WithEditForumTopicName(value string) EditForumTopicOption

New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept

type EditForumTopicParams

type EditForumTopicParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread of the forum topic
	MessageThreadID int64 `json:"message_thread_id"`

	// New topic name, 0-128 characters.
	// If not specified or empty, the current name of the topic will be kept
	Name string `json:"name,omitempty"`

	// New unique identifier of the custom emoji shown as the topic icon.
	// Use [getForumTopicIconStickers] to get all allowed custom emoji identifiers.
	// Pass an empty string to remove the icon.
	// If not specified, the current icon will be kept
	//
	// [getForumTopicIconStickers]: https://core.telegram.org/bots/api#getforumtopiciconstickers
	IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
}

func (*EditForumTopicParams) Option

func (r *EditForumTopicParams) Option(opts ...EditForumTopicOption) (previous EditForumTopicOption)

type EditGeneralForumTopicOption

type EditGeneralForumTopicOption func(params *EditGeneralForumTopicParams) EditGeneralForumTopicOption

func WithEditGeneralForumTopicChatID

func WithEditGeneralForumTopicChatID(value string) EditGeneralForumTopicOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

func WithEditGeneralForumTopicName

func WithEditGeneralForumTopicName(value string) EditGeneralForumTopicOption

New topic name, 1-128 characters

type EditGeneralForumTopicParams

type EditGeneralForumTopicParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`

	// New topic name, 1-128 characters
	Name string `json:"name"`
}

func (*EditGeneralForumTopicParams) Option

type EditMessageCaptionOption

type EditMessageCaptionOption func(params *EditMessageCaptionParams) EditMessageCaptionOption

func WithEditMessageCaptionBusinessConnectionID

func WithEditMessageCaptionBusinessConnectionID(value string) EditMessageCaptionOption

Unique identifier of the business connection on behalf of which the message to be edited was sent

func WithEditMessageCaptionCaption

func WithEditMessageCaptionCaption(value string) EditMessageCaptionOption

New caption of the message, 0-1024 characters after entities parsing

func WithEditMessageCaptionCaptionEntities

func WithEditMessageCaptionCaptionEntities(value []MessageEntity) EditMessageCaptionOption

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

func WithEditMessageCaptionChatID

func WithEditMessageCaptionChatID(value string) EditMessageCaptionOption

Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithEditMessageCaptionInlineMessageID

func WithEditMessageCaptionInlineMessageID(value string) EditMessageCaptionOption

Required if chat_id and message_id are not specified. Identifier of the inline message

func WithEditMessageCaptionMessageID

func WithEditMessageCaptionMessageID(value int64) EditMessageCaptionOption

Required if inline_message_id is not specified. Identifier of the message to edit

func WithEditMessageCaptionParseMode

func WithEditMessageCaptionParseMode(value string) EditMessageCaptionOption

Mode for parsing entities in the message caption. See formatting options for more details.

func WithEditMessageCaptionReplyMarkup

func WithEditMessageCaptionReplyMarkup(value *InlineKeyboardMarkup) EditMessageCaptionOption

A JSON-serialized object for an inline keyboard.

func WithEditMessageCaptionShowCaptionAboveMedia

func WithEditMessageCaptionShowCaptionAboveMedia(value bool) EditMessageCaptionOption

Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.

type EditMessageCaptionParams

type EditMessageCaptionParams struct {
	// Unique identifier of the business connection on behalf of which the message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Identifier of the message to edit
	MessageID int64 `json:"message_id,omitempty"`

	// Required if chat_id and message_id are not specified.
	// Identifier of the inline message
	InlineMessageID string `json:"inline_message_id,omitempty"`

	// New caption of the message, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// Mode for parsing entities in the message caption.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized 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.
	// Supported only for animation, photo and video messages.
	ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`

	// A JSON-serialized object for an [inline keyboard].
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func (*EditMessageCaptionParams) Option

type EditMessageChecklistOption

type EditMessageChecklistOption func(params *EditMessageChecklistParams) EditMessageChecklistOption

func WithEditMessageChecklistBusinessConnectionID

func WithEditMessageChecklistBusinessConnectionID(value string) EditMessageChecklistOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithEditMessageChecklistChatID

func WithEditMessageChecklistChatID(value int64) EditMessageChecklistOption

Unique identifier for the target chat

func WithEditMessageChecklistChecklist

func WithEditMessageChecklistChecklist(value InputChecklist) EditMessageChecklistOption

A JSON-serialized object for the new checklist

func WithEditMessageChecklistMessageID

func WithEditMessageChecklistMessageID(value int64) EditMessageChecklistOption

Unique identifier for the target message

func WithEditMessageChecklistReplyMarkup

func WithEditMessageChecklistReplyMarkup(value *InlineKeyboardMarkup) EditMessageChecklistOption

A JSON-serialized object for the new inline keyboard for the message

type EditMessageChecklistParams

type EditMessageChecklistParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id"`

	// Unique identifier for the target chat
	ChatID int64 `json:"chat_id"`

	// Unique identifier for the target message
	MessageID int64 `json:"message_id"`

	// A JSON-serialized object for the new checklist
	Checklist InputChecklist `json:"checklist"`

	// A JSON-serialized object for the new [inline keyboard] for the message
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func (*EditMessageChecklistParams) Option

type EditMessageLiveLocationOption

type EditMessageLiveLocationOption func(params *EditMessageLiveLocationParams) EditMessageLiveLocationOption

func WithEditMessageLiveLocationBusinessConnectionID

func WithEditMessageLiveLocationBusinessConnectionID(value string) EditMessageLiveLocationOption

Unique identifier of the business connection on behalf of which the message to be edited was sent

func WithEditMessageLiveLocationChatID

func WithEditMessageLiveLocationChatID(value string) EditMessageLiveLocationOption

Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithEditMessageLiveLocationHeading

func WithEditMessageLiveLocationHeading(value int64) EditMessageLiveLocationOption

Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

func WithEditMessageLiveLocationHorizontalAccuracy

func WithEditMessageLiveLocationHorizontalAccuracy(value float64) EditMessageLiveLocationOption

The radius of uncertainty for the location, measured in meters; 0-1500

func WithEditMessageLiveLocationInlineMessageID

func WithEditMessageLiveLocationInlineMessageID(value string) EditMessageLiveLocationOption

Required if chat_id and message_id are not specified. Identifier of the inline message

func WithEditMessageLiveLocationLatitude

func WithEditMessageLiveLocationLatitude(value float64) EditMessageLiveLocationOption

Latitude of new location

func WithEditMessageLiveLocationLivePeriod

func WithEditMessageLiveLocationLivePeriod(value int64) EditMessageLiveLocationOption

New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged

func WithEditMessageLiveLocationLongitude

func WithEditMessageLiveLocationLongitude(value float64) EditMessageLiveLocationOption

Longitude of new location

func WithEditMessageLiveLocationMessageID

func WithEditMessageLiveLocationMessageID(value int64) EditMessageLiveLocationOption

Required if inline_message_id is not specified. Identifier of the message to edit

func WithEditMessageLiveLocationProximityAlertRadius

func WithEditMessageLiveLocationProximityAlertRadius(value int64) EditMessageLiveLocationOption

The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

func WithEditMessageLiveLocationReplyMarkup

func WithEditMessageLiveLocationReplyMarkup(value *InlineKeyboardMarkup) EditMessageLiveLocationOption

A JSON-serialized object for a new inline keyboard.

type EditMessageLiveLocationParams

type EditMessageLiveLocationParams struct {
	// Unique identifier of the business connection on behalf of which the message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Identifier of the message to edit
	MessageID int64 `json:"message_id,omitempty"`

	// Required if chat_id and message_id are not specified.
	// Identifier of the inline message
	InlineMessageID string `json:"inline_message_id,omitempty"`

	// Latitude of new location
	Latitude float64 `json:"latitude"`

	// Longitude of new location
	Longitude float64 `json:"longitude"`

	// New period in seconds during which the location can be updated, starting from the message send date.
	// If 0x7FFFFFFF is specified, then the location can be updated forever.
	// Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days.
	// If not specified, then live_period remains unchanged
	LivePeriod int64 `json:"live_period,omitempty"`

	// The radius of uncertainty for the location, measured in meters; 0-1500
	HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`

	// Direction in which the user is moving, in degrees.
	// Must be between 1 and 360 if specified.
	Heading int64 `json:"heading,omitempty"`

	// The maximum distance for proximity alerts about approaching another chat member, in meters.
	// Must be between 1 and 100000 if specified.
	ProximityAlertRadius int64 `json:"proximity_alert_radius,omitempty"`

	// A JSON-serialized object for a new [inline keyboard].
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func (*EditMessageLiveLocationParams) Option

type EditMessageMediaOption

type EditMessageMediaOption func(params *EditMessageMediaParams) EditMessageMediaOption

func WithEditMessageMediaBusinessConnectionID

func WithEditMessageMediaBusinessConnectionID(value string) EditMessageMediaOption

Unique identifier of the business connection on behalf of which the message to be edited was sent

func WithEditMessageMediaChatID

func WithEditMessageMediaChatID(value string) EditMessageMediaOption

Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithEditMessageMediaInlineMessageID

func WithEditMessageMediaInlineMessageID(value string) EditMessageMediaOption

Required if chat_id and message_id are not specified. Identifier of the inline message

func WithEditMessageMediaMedia

func WithEditMessageMediaMedia(value InputMedia) EditMessageMediaOption

A JSON-serialized object for a new media content of the message

func WithEditMessageMediaMessageID

func WithEditMessageMediaMessageID(value int64) EditMessageMediaOption

Required if inline_message_id is not specified. Identifier of the message to edit

func WithEditMessageMediaReplyMarkup

func WithEditMessageMediaReplyMarkup(value *InlineKeyboardMarkup) EditMessageMediaOption

A JSON-serialized object for a new inline keyboard.

type EditMessageMediaParams

type EditMessageMediaParams struct {
	// Unique identifier of the business connection on behalf of which the message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Identifier of the message to edit
	MessageID int64 `json:"message_id,omitempty"`

	// Required if chat_id and message_id are not specified.
	// Identifier of the inline message
	InlineMessageID string `json:"inline_message_id,omitempty"`

	// A JSON-serialized object for a new media content of the message
	Media InputMedia `json:"media"`

	// A JSON-serialized object for a new [inline keyboard].
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func (*EditMessageMediaParams) Option

type EditMessageReplyMarkupOption

type EditMessageReplyMarkupOption func(params *EditMessageReplyMarkupParams) EditMessageReplyMarkupOption

func WithEditMessageReplyMarkupBusinessConnectionID

func WithEditMessageReplyMarkupBusinessConnectionID(value string) EditMessageReplyMarkupOption

Unique identifier of the business connection on behalf of which the message to be edited was sent

func WithEditMessageReplyMarkupChatID

func WithEditMessageReplyMarkupChatID(value string) EditMessageReplyMarkupOption

Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithEditMessageReplyMarkupInlineMessageID

func WithEditMessageReplyMarkupInlineMessageID(value string) EditMessageReplyMarkupOption

Required if chat_id and message_id are not specified. Identifier of the inline message

func WithEditMessageReplyMarkupMessageID

func WithEditMessageReplyMarkupMessageID(value int64) EditMessageReplyMarkupOption

Required if inline_message_id is not specified. Identifier of the message to edit

func WithEditMessageReplyMarkupReplyMarkup

func WithEditMessageReplyMarkupReplyMarkup(value *InlineKeyboardMarkup) EditMessageReplyMarkupOption

A JSON-serialized object for an inline keyboard.

type EditMessageReplyMarkupParams

type EditMessageReplyMarkupParams struct {
	// Unique identifier of the business connection on behalf of which the message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Identifier of the message to edit
	MessageID int64 `json:"message_id,omitempty"`

	// Required if chat_id and message_id are not specified.
	// Identifier of the inline message
	InlineMessageID string `json:"inline_message_id,omitempty"`

	// A JSON-serialized object for an [inline keyboard].
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func (*EditMessageReplyMarkupParams) Option

type EditMessageTextOption

type EditMessageTextOption func(params *EditMessageTextParams) EditMessageTextOption

func WithEditMessageTextBusinessConnectionID

func WithEditMessageTextBusinessConnectionID(value string) EditMessageTextOption

Unique identifier of the business connection on behalf of which the message to be edited was sent

func WithEditMessageTextChatID

func WithEditMessageTextChatID(value string) EditMessageTextOption

Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithEditMessageTextEntities

func WithEditMessageTextEntities(value []MessageEntity) EditMessageTextOption

A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode

func WithEditMessageTextInlineButtons

func WithEditMessageTextInlineButtons(buttons ...InlineKeyboardButton) EditMessageTextOption

func WithEditMessageTextInlineKeyboard

func WithEditMessageTextInlineKeyboard(keyboard [][]InlineKeyboardButton) EditMessageTextOption

func WithEditMessageTextInlineMessageID

func WithEditMessageTextInlineMessageID(value string) EditMessageTextOption

Required if chat_id and message_id are not specified. Identifier of the inline message

func WithEditMessageTextLinkPreviewOptions

func WithEditMessageTextLinkPreviewOptions(value *LinkPreviewOptions) EditMessageTextOption

Link preview generation options for the message

func WithEditMessageTextMessageID

func WithEditMessageTextMessageID(value int64) EditMessageTextOption

Required if inline_message_id is not specified. Identifier of the message to edit

func WithEditMessageTextParseMode

func WithEditMessageTextParseMode(value string) EditMessageTextOption

Mode for parsing entities in the message text. See formatting options for more details.

func WithEditMessageTextReplyMarkup

func WithEditMessageTextReplyMarkup(value *InlineKeyboardMarkup) EditMessageTextOption

A JSON-serialized object for an inline keyboard.

func WithEditMessageTextText

func WithEditMessageTextText(value string) EditMessageTextOption

New text of the message, 1-4096 characters after entities parsing

type EditMessageTextParams

type EditMessageTextParams struct {
	// Unique identifier of the business connection on behalf of which the message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Identifier of the message to edit
	MessageID int64 `json:"message_id,omitempty"`

	// Required if chat_id and message_id are not specified.
	// Identifier of the inline message
	InlineMessageID string `json:"inline_message_id,omitempty"`

	// New text of the message, 1-4096 characters after entities parsing
	Text string `json:"text"`

	// Mode for parsing entities in the message text.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
	Entities []MessageEntity `json:"entities,omitempty"`

	// Link preview generation options for the message
	LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`

	// A JSON-serialized object for an [inline keyboard].
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func (*EditMessageTextParams) Option

type EditStoryOption

type EditStoryOption func(params *EditStoryParams) EditStoryOption

func WithEditStoryAreas

func WithEditStoryAreas(value []StoryArea) EditStoryOption

A JSON-serialized list of clickable areas to be shown on the story

func WithEditStoryBusinessConnectionID

func WithEditStoryBusinessConnectionID(value string) EditStoryOption

Unique identifier of the business connection

func WithEditStoryCaption

func WithEditStoryCaption(value string) EditStoryOption

Caption of the story, 0-2048 characters after entities parsing

func WithEditStoryCaptionEntities

func WithEditStoryCaptionEntities(value []MessageEntity) EditStoryOption

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

func WithEditStoryContent

func WithEditStoryContent(value InputStoryContent) EditStoryOption

Content of the story

func WithEditStoryParseMode

func WithEditStoryParseMode(value string) EditStoryOption

Mode for parsing entities in the story caption. See formatting options for more details.

func WithEditStoryStoryID

func WithEditStoryStoryID(value int64) EditStoryOption

Unique identifier of the story to edit

type EditStoryParams

type EditStoryParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Unique identifier of the story to edit
	StoryID int64 `json:"story_id"`

	// Content of the story
	Content InputStoryContent `json:"content"`

	// Caption of the story, 0-2048 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// Mode for parsing entities in the story caption.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
	CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`

	// A JSON-serialized list of clickable areas to be shown on the story
	Areas []StoryArea `json:"areas,omitempty"`
}

func (*EditStoryParams) Option

func (r *EditStoryParams) Option(opts ...EditStoryOption) (previous EditStoryOption)

type EditUserStarSubscriptionOption

type EditUserStarSubscriptionOption func(params *EditUserStarSubscriptionParams) EditUserStarSubscriptionOption

func WithEditUserStarSubscriptionIsCanceled

func WithEditUserStarSubscriptionIsCanceled(value bool) EditUserStarSubscriptionOption

Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot.

func WithEditUserStarSubscriptionTelegramPaymentChargeID

func WithEditUserStarSubscriptionTelegramPaymentChargeID(value string) EditUserStarSubscriptionOption

Telegram payment identifier for the subscription

func WithEditUserStarSubscriptionUserID

func WithEditUserStarSubscriptionUserID(value int64) EditUserStarSubscriptionOption

Identifier of the user whose subscription will be edited

type EditUserStarSubscriptionParams

type EditUserStarSubscriptionParams struct {
	// Identifier of the user whose subscription will be edited
	UserID int64 `json:"user_id"`

	// Telegram payment identifier for the subscription
	TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`

	// Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period.
	// Pass False to allow the user to re-enable a subscription that was previously canceled by the bot.
	IsCanceled bool `json:"is_canceled"`
}

func (*EditUserStarSubscriptionParams) Option

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
	//
	// [EncryptedPassportElement]: https://core.telegram.org/bots/api#encryptedpassportelement
	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"`
}

EncryptedCredentials

Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation 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].
	//
	// [EncryptedCredentials]: https://core.telegram.org/bots/api#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].
	//
	// [EncryptedCredentials]: https://core.telegram.org/bots/api#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].
	//
	// [EncryptedCredentials]: https://core.telegram.org/bots/api#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].
	//
	// [EncryptedCredentials]: https://core.telegram.org/bots/api#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].
	//
	// [EncryptedCredentials]: https://core.telegram.org/bots/api#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].
	//
	// [EncryptedCredentials]: https://core.telegram.org/bots/api#encryptedcredentials
	Translation []PassportFile `json:"translation,omitempty"`

	// Base64-encoded element hash for using in [PassportElementErrorUnspecified]
	//
	// [PassportElementErrorUnspecified]: https://core.telegram.org/bots/api#passportelementerrorunspecified
	Hash string `json:"hash"`
}

EncryptedPassportElement

Describes documents or other Telegram Passport elements shared with the bot by the user.

type Error

type Error struct {
	Code int
	Text string
}

func (*Error) Error

func (e *Error) Error() string

type ExportChatInviteLinkOption

type ExportChatInviteLinkOption func(params *ExportChatInviteLinkParams) ExportChatInviteLinkOption

func WithExportChatInviteLinkChatID

func WithExportChatInviteLinkChatID(value string) ExportChatInviteLinkOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

type ExportChatInviteLinkParams

type ExportChatInviteLinkParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`
}

func (*ExportChatInviteLinkParams) Option

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 int64 `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
	//
	// [video note]: https://telegram.org/blog/video-messages-and-telescope
	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 checklist
	Checklist *Checklist `json:"checklist,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 »]
	//
	// [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 »]
	//
	// [payment]: https://core.telegram.org/bots/api#payments
	// [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,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
	Venue *Venue `json:"venue,omitempty"`
}

ExternalReplyInfo

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://api.telegram.org/file/bot<token>/<file_path> to get the file.
	FilePath string `json:"file_path,omitempty"`
}

File

This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.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 Filter

type Filter func(ctx *Context) bool

func FilterCommand

func FilterCommand(s string) Filter

func FilterMessageContact

func FilterMessageContact() Filter

func FilterMessageDocument

func FilterMessageDocument() Filter

func FilterMessageVideo

func FilterMessageVideo() Filter

func FilterRegexp

func FilterRegexp(pattern string) Filter

func FilterText

func FilterText(s string) Filter

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.
	//
	// [Message]: https://core.telegram.org/bots/api#message
	Selective bool `json:"selective,omitempty"`
}

ForceReply

Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account.

type ForumTopic

type ForumTopic struct {
	// Unique identifier of the forum topic
	MessageThreadID int64 `json:"message_thread_id"`

	// Name of the topic
	Name string `json:"name"`

	// Color of the topic icon in RGB format
	IconColor int64 `json:"icon_color"`

	// Optional.
	// Unique identifier of the custom emoji shown as the topic icon
	IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`

	// Optional.
	// True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot
	IsNameImplicit bool `json:"is_name_implicit,omitempty"`
}

ForumTopic

This object represents a forum topic.

type ForumTopicClosed

type ForumTopicClosed struct {
}

ForumTopicClosed

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 int64 `json:"icon_color"`

	// Optional.
	// Unique identifier of the custom emoji shown as the topic icon
	IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`

	// Optional.
	// True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot
	IsNameImplicit bool `json:"is_name_implicit,omitempty"`
}

ForumTopicCreated

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"`
}

ForumTopicEdited

This object represents a service message about an edited forum topic.

type ForumTopicReopened

type ForumTopicReopened struct {
}

ForumTopicReopened

This object represents a service message about a forum topic reopened in the chat. Currently holds no information.

type ForwardMessageOption

type ForwardMessageOption func(params *ForwardMessageParams) ForwardMessageOption

func WithForwardMessageChatID

func WithForwardMessageChatID(value string) ForwardMessageOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithForwardMessageDirectMessagesTopicID

func WithForwardMessageDirectMessagesTopicID(value int64) ForwardMessageOption

Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat

func WithForwardMessageDisableNotification

func WithForwardMessageDisableNotification(value bool) ForwardMessageOption

Sends the message silently. Users will receive a notification with no sound.

func WithForwardMessageFromChatID

func WithForwardMessageFromChatID(value string) ForwardMessageOption

Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)

func WithForwardMessageMessageEffectID

func WithForwardMessageMessageEffectID(value string) ForwardMessageOption

Unique identifier of the message effect to be added to the message; only available when forwarding to private chats

func WithForwardMessageMessageID

func WithForwardMessageMessageID(value int64) ForwardMessageOption

Message identifier in the chat specified in from_chat_id

func WithForwardMessageMessageThreadID

func WithForwardMessageMessageThreadID(value int64) ForwardMessageOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithForwardMessageProtectContent

func WithForwardMessageProtectContent(value bool) ForwardMessageOption

Protects the contents of the forwarded message from forwarding and saving

func WithForwardMessageSuggestedPostParameters

func WithForwardMessageSuggestedPostParameters(value *SuggestedPostParameters) ForwardMessageOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only

func WithForwardMessageVideoStartTimestamp

func WithForwardMessageVideoStartTimestamp(value int64) ForwardMessageOption

New start timestamp for the forwarded video in the message

type ForwardMessageParams

type ForwardMessageParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
	FromChatID string `json:"from_chat_id"`

	// New start timestamp for the forwarded video in the message
	VideoStartTimestamp int64 `json:"video_start_timestamp,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the forwarded message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Unique identifier of the message effect to be added to the message; only available when forwarding to private chats
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Message identifier in the chat specified in from_chat_id
	MessageID int64 `json:"message_id"`
}

func (*ForwardMessageParams) Option

func (r *ForwardMessageParams) Option(opts ...ForwardMessageOption) (previous ForwardMessageOption)

type ForwardMessagesOption

type ForwardMessagesOption func(params *ForwardMessagesParams) ForwardMessagesOption

func WithForwardMessagesChatID

func WithForwardMessagesChatID(value string) ForwardMessagesOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithForwardMessagesDirectMessagesTopicID

func WithForwardMessagesDirectMessagesTopicID(value int64) ForwardMessagesOption

Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat

func WithForwardMessagesDisableNotification

func WithForwardMessagesDisableNotification(value bool) ForwardMessagesOption

Sends the messages silently. Users will receive a notification with no sound.

func WithForwardMessagesFromChatID

func WithForwardMessagesFromChatID(value string) ForwardMessagesOption

Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)

func WithForwardMessagesMessageIDs

func WithForwardMessagesMessageIDs(value []int64) ForwardMessagesOption

A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.

func WithForwardMessagesMessageThreadID

func WithForwardMessagesMessageThreadID(value int64) ForwardMessagesOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithForwardMessagesProtectContent

func WithForwardMessagesProtectContent(value bool) ForwardMessagesOption

Protects the contents of the forwarded messages from forwarding and saving

type ForwardMessagesParams

type ForwardMessagesParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)
	FromChatID string `json:"from_chat_id"`

	// A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward.
	// The identifiers must be specified in a strictly increasing order.
	MessageIDs []int64 `json:"message_ids"`

	// Sends the messages [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the forwarded messages from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`
}

func (*ForwardMessagesParams) Option

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.
	//
	// [setGameScore]: https://core.telegram.org/bots/api#setgamescore
	// [editMessageText]: https://core.telegram.org/bots/api#editmessagetext
	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]
	//
	// [BotFather]: https://t.me/botfather
	Animation *Animation `json:"animation,omitempty"`
}

Game

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 int64 `json:"position"`

	// User
	User User `json:"user"`

	// Score
	Score int64 `json:"score"`
}

GameHighScore

This object represents one row of the high scores table for a game.

type GeneralForumTopicHidden

type GeneralForumTopicHidden struct {
}

GeneralForumTopicHidden

This object represents a service message about General forum topic hidden in the chat. Currently holds no information.

type GeneralForumTopicUnhidden

type GeneralForumTopicUnhidden struct {
}

GeneralForumTopicUnhidden

This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.

type GetAvailableGiftsOption

type GetAvailableGiftsOption func(params *GetAvailableGiftsParams) GetAvailableGiftsOption

type GetAvailableGiftsParams

type GetAvailableGiftsParams struct {
}

func (*GetAvailableGiftsParams) Option

type GetBusinessAccountGiftsOption

type GetBusinessAccountGiftsOption func(params *GetBusinessAccountGiftsParams) GetBusinessAccountGiftsOption

func WithGetBusinessAccountGiftsBusinessConnectionID

func WithGetBusinessAccountGiftsBusinessConnectionID(value string) GetBusinessAccountGiftsOption

Unique identifier of the business connection

func WithGetBusinessAccountGiftsExcludeFromBlockchain

func WithGetBusinessAccountGiftsExcludeFromBlockchain(value bool) GetBusinessAccountGiftsOption

Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram

func WithGetBusinessAccountGiftsExcludeLimitedNonUpgradable

func WithGetBusinessAccountGiftsExcludeLimitedNonUpgradable(value bool) GetBusinessAccountGiftsOption

Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique

func WithGetBusinessAccountGiftsExcludeLimitedUpgradable

func WithGetBusinessAccountGiftsExcludeLimitedUpgradable(value bool) GetBusinessAccountGiftsOption

Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique

func WithGetBusinessAccountGiftsExcludeSaved

func WithGetBusinessAccountGiftsExcludeSaved(value bool) GetBusinessAccountGiftsOption

Pass True to exclude gifts that are saved to the account's profile page

func WithGetBusinessAccountGiftsExcludeUnique

func WithGetBusinessAccountGiftsExcludeUnique(value bool) GetBusinessAccountGiftsOption

Pass True to exclude unique gifts

func WithGetBusinessAccountGiftsExcludeUnlimited

func WithGetBusinessAccountGiftsExcludeUnlimited(value bool) GetBusinessAccountGiftsOption

Pass True to exclude gifts that can be purchased an unlimited number of times

func WithGetBusinessAccountGiftsExcludeUnsaved

func WithGetBusinessAccountGiftsExcludeUnsaved(value bool) GetBusinessAccountGiftsOption

Pass True to exclude gifts that aren't saved to the account's profile page

func WithGetBusinessAccountGiftsLimit

func WithGetBusinessAccountGiftsLimit(value int64) GetBusinessAccountGiftsOption

The maximum number of gifts to be returned; 1-100. Defaults to 100

func WithGetBusinessAccountGiftsOffset

func WithGetBusinessAccountGiftsOffset(value string) GetBusinessAccountGiftsOption

Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results

func WithGetBusinessAccountGiftsSortByPrice

func WithGetBusinessAccountGiftsSortByPrice(value bool) GetBusinessAccountGiftsOption

Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.

type GetBusinessAccountGiftsParams

type GetBusinessAccountGiftsParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Pass True to exclude gifts that aren't saved to the account's profile page
	ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`

	// Pass True to exclude gifts that are saved to the account's profile page
	ExcludeSaved bool `json:"exclude_saved,omitempty"`

	// Pass True to exclude gifts that can be purchased an unlimited number of times
	ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`

	// Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
	ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`

	// Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
	ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`

	// Pass True to exclude unique gifts
	ExcludeUnique bool `json:"exclude_unique,omitempty"`

	// Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
	ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`

	// Pass True to sort results by gift price instead of send date.
	// Sorting is applied before pagination.
	SortByPrice bool `json:"sort_by_price,omitempty"`

	// Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results
	Offset string `json:"offset,omitempty"`

	// The maximum number of gifts to be returned; 1-100.
	// Defaults to 100
	Limit int64 `json:"limit,omitempty"`
}

func (*GetBusinessAccountGiftsParams) Option

type GetBusinessAccountStarBalanceOption

type GetBusinessAccountStarBalanceOption func(params *GetBusinessAccountStarBalanceParams) GetBusinessAccountStarBalanceOption

func WithGetBusinessAccountStarBalanceBusinessConnectionID

func WithGetBusinessAccountStarBalanceBusinessConnectionID(value string) GetBusinessAccountStarBalanceOption

Unique identifier of the business connection

type GetBusinessAccountStarBalanceParams

type GetBusinessAccountStarBalanceParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`
}

func (*GetBusinessAccountStarBalanceParams) Option

type GetBusinessConnectionOption

type GetBusinessConnectionOption func(params *GetBusinessConnectionParams) GetBusinessConnectionOption

func WithGetBusinessConnectionBusinessConnectionID

func WithGetBusinessConnectionBusinessConnectionID(value string) GetBusinessConnectionOption

Unique identifier of the business connection

type GetBusinessConnectionParams

type GetBusinessConnectionParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`
}

func (*GetBusinessConnectionParams) Option

type GetChatAdministratorsOption

type GetChatAdministratorsOption func(params *GetChatAdministratorsParams) GetChatAdministratorsOption

func WithGetChatAdministratorsChatID

func WithGetChatAdministratorsChatID(value string) GetChatAdministratorsOption

Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

type GetChatAdministratorsParams

type GetChatAdministratorsParams struct {
	// Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
	ChatID string `json:"chat_id"`
}

func (*GetChatAdministratorsParams) Option

type GetChatGiftsOption

type GetChatGiftsOption func(params *GetChatGiftsParams) GetChatGiftsOption

func WithGetChatGiftsChatID

func WithGetChatGiftsChatID(value string) GetChatGiftsOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithGetChatGiftsExcludeFromBlockchain

func WithGetChatGiftsExcludeFromBlockchain(value bool) GetChatGiftsOption

Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram

func WithGetChatGiftsExcludeLimitedNonUpgradable

func WithGetChatGiftsExcludeLimitedNonUpgradable(value bool) GetChatGiftsOption

Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique

func WithGetChatGiftsExcludeLimitedUpgradable

func WithGetChatGiftsExcludeLimitedUpgradable(value bool) GetChatGiftsOption

Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique

func WithGetChatGiftsExcludeSaved

func WithGetChatGiftsExcludeSaved(value bool) GetChatGiftsOption

Pass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel.

func WithGetChatGiftsExcludeUnique

func WithGetChatGiftsExcludeUnique(value bool) GetChatGiftsOption

Pass True to exclude unique gifts

func WithGetChatGiftsExcludeUnlimited

func WithGetChatGiftsExcludeUnlimited(value bool) GetChatGiftsOption

Pass True to exclude gifts that can be purchased an unlimited number of times

func WithGetChatGiftsExcludeUnsaved

func WithGetChatGiftsExcludeUnsaved(value bool) GetChatGiftsOption

Pass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel.

func WithGetChatGiftsLimit

func WithGetChatGiftsLimit(value int64) GetChatGiftsOption

The maximum number of gifts to be returned; 1-100. Defaults to 100

func WithGetChatGiftsOffset

func WithGetChatGiftsOffset(value string) GetChatGiftsOption

Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results

func WithGetChatGiftsSortByPrice

func WithGetChatGiftsSortByPrice(value bool) GetChatGiftsOption

Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.

type GetChatGiftsParams

type GetChatGiftsParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Pass True to exclude gifts that aren't saved to the chat's profile page.
	// Always True, unless the bot has the can_post_messages administrator right in the channel.
	ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`

	// Pass True to exclude gifts that are saved to the chat's profile page.
	// Always False, unless the bot has the can_post_messages administrator right in the channel.
	ExcludeSaved bool `json:"exclude_saved,omitempty"`

	// Pass True to exclude gifts that can be purchased an unlimited number of times
	ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`

	// Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
	ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`

	// Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
	ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`

	// Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
	ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`

	// Pass True to exclude unique gifts
	ExcludeUnique bool `json:"exclude_unique,omitempty"`

	// Pass True to sort results by gift price instead of send date.
	// Sorting is applied before pagination.
	SortByPrice bool `json:"sort_by_price,omitempty"`

	// Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results
	Offset string `json:"offset,omitempty"`

	// The maximum number of gifts to be returned; 1-100.
	// Defaults to 100
	Limit int64 `json:"limit,omitempty"`
}

func (*GetChatGiftsParams) Option

func (r *GetChatGiftsParams) Option(opts ...GetChatGiftsOption) (previous GetChatGiftsOption)

type GetChatMemberCountOption

type GetChatMemberCountOption func(params *GetChatMemberCountParams) GetChatMemberCountOption

func WithGetChatMemberCountChatID

func WithGetChatMemberCountChatID(value string) GetChatMemberCountOption

Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

type GetChatMemberCountParams

type GetChatMemberCountParams struct {
	// Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
	ChatID string `json:"chat_id"`
}

func (*GetChatMemberCountParams) Option

type GetChatMemberOption

type GetChatMemberOption func(params *GetChatMemberParams) GetChatMemberOption

func WithGetChatMemberChatID

func WithGetChatMemberChatID(value string) GetChatMemberOption

Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

func WithGetChatMemberUserID

func WithGetChatMemberUserID(value int64) GetChatMemberOption

Unique identifier of the target user

type GetChatMemberParams

type GetChatMemberParams struct {
	// Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier of the target user
	UserID int64 `json:"user_id"`
}

func (*GetChatMemberParams) Option

func (r *GetChatMemberParams) Option(opts ...GetChatMemberOption) (previous GetChatMemberOption)

type GetChatMenuButtonOption

type GetChatMenuButtonOption func(params *GetChatMenuButtonParams) GetChatMenuButtonOption

func WithGetChatMenuButtonChatID

func WithGetChatMenuButtonChatID(value int64) GetChatMenuButtonOption

Unique identifier for the target private chat. If not specified, default bot's menu button will be returned

type GetChatMenuButtonParams

type GetChatMenuButtonParams struct {
	// Unique identifier for the target private chat.
	// If not specified, default bot's menu button will be returned
	ChatID int64 `json:"chat_id,omitempty"`
}

func (*GetChatMenuButtonParams) Option

type GetChatOption

type GetChatOption func(params *GetChatParams) GetChatOption

func WithGetChatChatID

func WithGetChatChatID(value string) GetChatOption

Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

type GetChatParams

type GetChatParams struct {
	// Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
	ChatID string `json:"chat_id"`
}

func (*GetChatParams) Option

func (r *GetChatParams) Option(opts ...GetChatOption) (previous GetChatOption)

type GetCustomEmojiStickersOption

type GetCustomEmojiStickersOption func(params *GetCustomEmojiStickersParams) GetCustomEmojiStickersOption

func WithGetCustomEmojiStickersCustomEmojiIDs

func WithGetCustomEmojiStickersCustomEmojiIDs(value []string) GetCustomEmojiStickersOption

A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.

type GetCustomEmojiStickersParams

type GetCustomEmojiStickersParams struct {
	// A JSON-serialized list of custom emoji identifiers.
	// At most 200 custom emoji identifiers can be specified.
	CustomEmojiIDs []string `json:"custom_emoji_ids"`
}

func (*GetCustomEmojiStickersParams) Option

type GetFileOption

type GetFileOption func(params *GetFileParams) GetFileOption

func WithGetFileFileID

func WithGetFileFileID(value string) GetFileOption

File identifier to get information about

type GetFileParams

type GetFileParams struct {
	// File identifier to get information about
	FileID string `json:"file_id"`
}

func (*GetFileParams) Option

func (r *GetFileParams) Option(opts ...GetFileOption) (previous GetFileOption)

type GetForumTopicIconStickersParams

type GetForumTopicIconStickersParams struct {
}

func (*GetForumTopicIconStickersParams) Option

type GetGameHighScoresOption

type GetGameHighScoresOption func(params *GetGameHighScoresParams) GetGameHighScoresOption

func WithGetGameHighScoresChatID

func WithGetGameHighScoresChatID(value int64) GetGameHighScoresOption

Required if inline_message_id is not specified. Unique identifier for the target chat

func WithGetGameHighScoresInlineMessageID

func WithGetGameHighScoresInlineMessageID(value string) GetGameHighScoresOption

Required if chat_id and message_id are not specified. Identifier of the inline message

func WithGetGameHighScoresMessageID

func WithGetGameHighScoresMessageID(value int64) GetGameHighScoresOption

Required if inline_message_id is not specified. Identifier of the sent message

func WithGetGameHighScoresUserID

func WithGetGameHighScoresUserID(value int64) GetGameHighScoresOption

Target user id

type GetGameHighScoresParams

type GetGameHighScoresParams struct {
	// Target user id
	UserID int64 `json:"user_id"`

	// Required if inline_message_id is not specified.
	// Unique identifier for the target chat
	ChatID int64 `json:"chat_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Identifier of the sent message
	MessageID int64 `json:"message_id,omitempty"`

	// Required if chat_id and message_id are not specified.
	// Identifier of the inline message
	InlineMessageID string `json:"inline_message_id,omitempty"`
}

func (*GetGameHighScoresParams) Option

type GetMeOption

type GetMeOption func(params *GetMeParams) GetMeOption

type GetMeParams

type GetMeParams struct {
}

func (*GetMeParams) Option

func (r *GetMeParams) Option(opts ...GetMeOption) (previous GetMeOption)

type GetMyCommandsOption

type GetMyCommandsOption func(params *GetMyCommandsParams) GetMyCommandsOption

func WithGetMyCommandsLanguageCode

func WithGetMyCommandsLanguageCode(value string) GetMyCommandsOption

A two-letter ISO 639-1 language code or an empty string

func WithGetMyCommandsScope

func WithGetMyCommandsScope(value *BotCommandScope) GetMyCommandsOption

A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault.

type GetMyCommandsParams

type GetMyCommandsParams struct {
	// A JSON-serialized object, describing scope of users.
	// Defaults to [BotCommandScopeDefault].
	//
	// [BotCommandScopeDefault]: https://core.telegram.org/bots/api#botcommandscopedefault
	Scope *BotCommandScope `json:"scope,omitempty"`

	// A two-letter ISO 639-1 language code or an empty string
	LanguageCode string `json:"language_code,omitempty"`
}

func (*GetMyCommandsParams) Option

func (r *GetMyCommandsParams) Option(opts ...GetMyCommandsOption) (previous GetMyCommandsOption)

type GetMyDefaultAdministratorRightsOption

type GetMyDefaultAdministratorRightsOption func(params *GetMyDefaultAdministratorRightsParams) GetMyDefaultAdministratorRightsOption

func WithGetMyDefaultAdministratorRightsForChannels

func WithGetMyDefaultAdministratorRightsForChannels(value bool) GetMyDefaultAdministratorRightsOption

Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.

type GetMyDefaultAdministratorRightsParams

type GetMyDefaultAdministratorRightsParams struct {
	// Pass True to get default administrator rights of the bot in channels.
	// Otherwise, default administrator rights of the bot for groups and supergroups will be returned.
	ForChannels bool `json:"for_channels,omitempty"`
}

func (*GetMyDefaultAdministratorRightsParams) Option

type GetMyDescriptionOption

type GetMyDescriptionOption func(params *GetMyDescriptionParams) GetMyDescriptionOption

func WithGetMyDescriptionLanguageCode

func WithGetMyDescriptionLanguageCode(value string) GetMyDescriptionOption

A two-letter ISO 639-1 language code or an empty string

type GetMyDescriptionParams

type GetMyDescriptionParams struct {
	// A two-letter ISO 639-1 language code or an empty string
	LanguageCode string `json:"language_code,omitempty"`
}

func (*GetMyDescriptionParams) Option

type GetMyNameOption

type GetMyNameOption func(params *GetMyNameParams) GetMyNameOption

func WithGetMyNameLanguageCode

func WithGetMyNameLanguageCode(value string) GetMyNameOption

A two-letter ISO 639-1 language code or an empty string

type GetMyNameParams

type GetMyNameParams struct {
	// A two-letter ISO 639-1 language code or an empty string
	LanguageCode string `json:"language_code,omitempty"`
}

func (*GetMyNameParams) Option

func (r *GetMyNameParams) Option(opts ...GetMyNameOption) (previous GetMyNameOption)

type GetMyShortDescriptionOption

type GetMyShortDescriptionOption func(params *GetMyShortDescriptionParams) GetMyShortDescriptionOption

func WithGetMyShortDescriptionLanguageCode

func WithGetMyShortDescriptionLanguageCode(value string) GetMyShortDescriptionOption

A two-letter ISO 639-1 language code or an empty string

type GetMyShortDescriptionParams

type GetMyShortDescriptionParams struct {
	// A two-letter ISO 639-1 language code or an empty string
	LanguageCode string `json:"language_code,omitempty"`
}

func (*GetMyShortDescriptionParams) Option

type GetMyStarBalanceOption

type GetMyStarBalanceOption func(params *GetMyStarBalanceParams) GetMyStarBalanceOption

type GetMyStarBalanceParams

type GetMyStarBalanceParams struct {
}

func (*GetMyStarBalanceParams) Option

type GetStarTransactionsOption

type GetStarTransactionsOption func(params *GetStarTransactionsParams) GetStarTransactionsOption

func WithGetStarTransactionsLimit

func WithGetStarTransactionsLimit(value int64) GetStarTransactionsOption

The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100.

func WithGetStarTransactionsOffset

func WithGetStarTransactionsOffset(value int64) GetStarTransactionsOption

Number of transactions to skip in the response

type GetStarTransactionsParams

type GetStarTransactionsParams struct {
	// Number of transactions to skip in the response
	Offset int64 `json:"offset,omitempty"`

	// The maximum number of transactions to be retrieved.
	// Values between 1-100 are accepted.
	// Defaults to 100.
	Limit int64 `json:"limit,omitempty"`
}

func (*GetStarTransactionsParams) Option

type GetStickerSetOption

type GetStickerSetOption func(params *GetStickerSetParams) GetStickerSetOption

func WithGetStickerSetName

func WithGetStickerSetName(value string) GetStickerSetOption

Name of the sticker set

type GetStickerSetParams

type GetStickerSetParams struct {
	// Name of the sticker set
	Name string `json:"name"`
}

func (*GetStickerSetParams) Option

func (r *GetStickerSetParams) Option(opts ...GetStickerSetOption) (previous GetStickerSetOption)

type GetUpdatesOption

type GetUpdatesOption func(params *GetUpdatesParams) GetUpdatesOption

func WithGetUpdatesAllowedUpdates

func WithGetUpdatesAllowedUpdates(value []string) GetUpdatesOption

A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.

Please note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time.

func WithGetUpdatesLimit

func WithGetUpdatesLimit(value int64) GetUpdatesOption

Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.

func WithGetUpdatesOffset

func WithGetUpdatesOffset(value int64) GetUpdatesOption

Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten.

func WithGetUpdatesTimeout

func WithGetUpdatesTimeout(value int64) GetUpdatesOption

Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.

type GetUpdatesParams

type GetUpdatesParams struct {
	// Identifier of the first update to be returned.
	// Must be greater by one than the highest among the identifiers of previously received updates.
	// By default, updates starting with the earliest unconfirmed update are returned.
	// An update is considered confirmed as soon as [getUpdates] is called with an offset higher than its update_id.
	// The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue.
	// All previous updates will be forgotten.
	//
	// [getUpdates]: https://core.telegram.org/bots/api#getupdates
	Offset int64 `json:"offset,omitempty"`

	// Limits the number of updates to be retrieved.
	// Values between 1-100 are accepted.
	// Defaults to 100.
	Limit int64 `json:"limit,omitempty"`

	// Timeout in seconds for long polling.
	// Defaults to 0, i.e.
	// usual short polling.
	// Should be positive, short polling should be used for testing purposes only.
	Timeout int64 `json:"timeout,omitempty"`

	// A JSON-serialized list of the update types you want your bot to receive.
	// For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types.
	// See [Update] for a complete list of available update types.
	// Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default).
	// If not specified, the previous setting will be used.
	//
	// Please note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time.
	//
	// [Update]: https://core.telegram.org/bots/api#update
	AllowedUpdates []string `json:"allowed_updates,omitempty"`
}

func (*GetUpdatesParams) Option

func (r *GetUpdatesParams) Option(opts ...GetUpdatesOption) (previous GetUpdatesOption)

type GetUserChatBoostsOption

type GetUserChatBoostsOption func(params *GetUserChatBoostsParams) GetUserChatBoostsOption

func WithGetUserChatBoostsChatID

func WithGetUserChatBoostsChatID(value string) GetUserChatBoostsOption

Unique identifier for the chat or username of the channel (in the format @channelusername)

func WithGetUserChatBoostsUserID

func WithGetUserChatBoostsUserID(value int64) GetUserChatBoostsOption

Unique identifier of the target user

type GetUserChatBoostsParams

type GetUserChatBoostsParams struct {
	// Unique identifier for the chat or username of the channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier of the target user
	UserID int64 `json:"user_id"`
}

func (*GetUserChatBoostsParams) Option

type GetUserGiftsOption

type GetUserGiftsOption func(params *GetUserGiftsParams) GetUserGiftsOption

func WithGetUserGiftsExcludeFromBlockchain

func WithGetUserGiftsExcludeFromBlockchain(value bool) GetUserGiftsOption

Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram

func WithGetUserGiftsExcludeLimitedNonUpgradable

func WithGetUserGiftsExcludeLimitedNonUpgradable(value bool) GetUserGiftsOption

Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique

func WithGetUserGiftsExcludeLimitedUpgradable

func WithGetUserGiftsExcludeLimitedUpgradable(value bool) GetUserGiftsOption

Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique

func WithGetUserGiftsExcludeUnique

func WithGetUserGiftsExcludeUnique(value bool) GetUserGiftsOption

Pass True to exclude unique gifts

func WithGetUserGiftsExcludeUnlimited

func WithGetUserGiftsExcludeUnlimited(value bool) GetUserGiftsOption

Pass True to exclude gifts that can be purchased an unlimited number of times

func WithGetUserGiftsLimit

func WithGetUserGiftsLimit(value int64) GetUserGiftsOption

The maximum number of gifts to be returned; 1-100. Defaults to 100

func WithGetUserGiftsOffset

func WithGetUserGiftsOffset(value string) GetUserGiftsOption

Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results

func WithGetUserGiftsSortByPrice

func WithGetUserGiftsSortByPrice(value bool) GetUserGiftsOption

Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.

func WithGetUserGiftsUserID

func WithGetUserGiftsUserID(value int64) GetUserGiftsOption

Unique identifier of the user

type GetUserGiftsParams

type GetUserGiftsParams struct {
	// Unique identifier of the user
	UserID int64 `json:"user_id"`

	// Pass True to exclude gifts that can be purchased an unlimited number of times
	ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`

	// Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
	ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`

	// Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
	ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`

	// Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
	ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`

	// Pass True to exclude unique gifts
	ExcludeUnique bool `json:"exclude_unique,omitempty"`

	// Pass True to sort results by gift price instead of send date.
	// Sorting is applied before pagination.
	SortByPrice bool `json:"sort_by_price,omitempty"`

	// Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results
	Offset string `json:"offset,omitempty"`

	// The maximum number of gifts to be returned; 1-100.
	// Defaults to 100
	Limit int64 `json:"limit,omitempty"`
}

func (*GetUserGiftsParams) Option

func (r *GetUserGiftsParams) Option(opts ...GetUserGiftsOption) (previous GetUserGiftsOption)

type GetUserProfileAudiosOption

type GetUserProfileAudiosOption func(params *GetUserProfileAudiosParams) GetUserProfileAudiosOption

func WithGetUserProfileAudiosLimit

func WithGetUserProfileAudiosLimit(value int64) GetUserProfileAudiosOption

Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.

func WithGetUserProfileAudiosOffset

func WithGetUserProfileAudiosOffset(value int64) GetUserProfileAudiosOption

Sequential number of the first audio to be returned. By default, all audios are returned.

func WithGetUserProfileAudiosUserID

func WithGetUserProfileAudiosUserID(value int64) GetUserProfileAudiosOption

Unique identifier of the target user

type GetUserProfileAudiosParams

type GetUserProfileAudiosParams struct {
	// Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// Sequential number of the first audio to be returned.
	// By default, all audios are returned.
	Offset int64 `json:"offset,omitempty"`

	// Limits the number of audios to be retrieved.
	// Values between 1-100 are accepted.
	// Defaults to 100.
	Limit int64 `json:"limit,omitempty"`
}

func (*GetUserProfileAudiosParams) Option

type GetUserProfilePhotosOption

type GetUserProfilePhotosOption func(params *GetUserProfilePhotosParams) GetUserProfilePhotosOption

func WithGetUserProfilePhotosLimit

func WithGetUserProfilePhotosLimit(value int64) GetUserProfilePhotosOption

Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.

func WithGetUserProfilePhotosOffset

func WithGetUserProfilePhotosOffset(value int64) GetUserProfilePhotosOption

Sequential number of the first photo to be returned. By default, all photos are returned.

func WithGetUserProfilePhotosUserID

func WithGetUserProfilePhotosUserID(value int64) GetUserProfilePhotosOption

Unique identifier of the target user

type GetUserProfilePhotosParams

type GetUserProfilePhotosParams struct {
	// Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// Sequential number of the first photo to be returned.
	// By default, all photos are returned.
	Offset int64 `json:"offset,omitempty"`

	// Limits the number of photos to be retrieved.
	// Values between 1-100 are accepted.
	// Defaults to 100.
	Limit int64 `json:"limit,omitempty"`
}

func (*GetUserProfilePhotosParams) Option

type GetWebhookInfoOption

type GetWebhookInfoOption func(params *GetWebhookInfoParams) GetWebhookInfoOption

type GetWebhookInfoParams

type GetWebhookInfoParams struct {
}

func (*GetWebhookInfoParams) Option

func (r *GetWebhookInfoParams) Option(opts ...GetWebhookInfoOption) (previous GetWebhookInfoOption)

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 int64 `json:"star_count"`

	// Optional.
	// The number of Telegram Stars that must be paid to upgrade the gift to a unique one
	UpgradeStarCount int64 `json:"upgrade_star_count,omitempty"`

	// Optional.
	// True, if the gift can only be purchased by Telegram Premium subscribers
	IsPremium bool `json:"is_premium,omitempty"`

	// Optional.
	// True, if the gift can be used (after being upgraded) to customize a user's appearance
	HasColors bool `json:"has_colors,omitempty"`

	// Optional.
	// The total number of gifts of this type that can be sent by all users; for limited gifts only
	TotalCount int64 `json:"total_count,omitempty"`

	// Optional.
	// The number of remaining gifts of this type that can be sent by all users; for limited gifts only
	RemainingCount int64 `json:"remaining_count,omitempty"`

	// Optional.
	// The total number of gifts of this type that can be sent by the bot; for limited gifts only
	PersonalTotalCount int64 `json:"personal_total_count,omitempty"`

	// Optional.
	// The number of remaining gifts of this type that can be sent by the bot; for limited gifts only
	PersonalRemainingCount int64 `json:"personal_remaining_count,omitempty"`

	// Optional.
	// Background of the gift
	Background *GiftBackground `json:"background,omitempty"`

	// Optional.
	// The total number of different unique gifts that can be obtained by upgrading the gift
	UniqueGiftVariantCount int64 `json:"unique_gift_variant_count,omitempty"`

	// Optional.
	// Information about the chat that published the gift
	PublisherChat *Chat `json:"publisher_chat,omitempty"`
}

Gift

This object represents a gift that can be sent by the bot.

type GiftBackground

type GiftBackground struct {
	// Center color of the background in RGB format
	CenterColor int64 `json:"center_color"`

	// Edge color of the background in RGB format
	EdgeColor int64 `json:"edge_color"`

	// Text color of the background in RGB format
	TextColor int64 `json:"text_color"`
}

GiftBackground

This object describes the background of a gift.

type GiftInfo

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 int64 `json:"convert_star_count,omitempty"`

	// Optional.
	// Number of Telegram Stars that were prepaid for the ability to upgrade the gift
	PrepaidUpgradeStarCount int64 `json:"prepaid_upgrade_star_count,omitempty"`

	// Optional.
	// True, if the gift's upgrade was purchased after the gift was sent
	IsUpgradeSeparate bool `json:"is_upgrade_separate,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"`

	// Optional.
	// Unique number reserved for this gift when upgraded.
	// See the number field in [UniqueGift]
	//
	// [UniqueGift]: https://core.telegram.org/bots/api#uniquegift
	UniqueGiftNumber int64 `json:"unique_gift_number,omitempty"`
}

GiftInfo

Describes a service message about a regular gift that was sent or received.

type GiftPremiumSubscriptionOption

type GiftPremiumSubscriptionOption func(params *GiftPremiumSubscriptionParams) GiftPremiumSubscriptionOption

func WithGiftPremiumSubscriptionMonthCount

func WithGiftPremiumSubscriptionMonthCount(value int64) GiftPremiumSubscriptionOption

Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12

func WithGiftPremiumSubscriptionStarCount

func WithGiftPremiumSubscriptionStarCount(value int64) GiftPremiumSubscriptionOption

Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months

func WithGiftPremiumSubscriptionText

func WithGiftPremiumSubscriptionText(value string) GiftPremiumSubscriptionOption

Text that will be shown along with the service message about the subscription; 0-128 characters

func WithGiftPremiumSubscriptionTextEntities

func WithGiftPremiumSubscriptionTextEntities(value []MessageEntity) GiftPremiumSubscriptionOption

A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.

func WithGiftPremiumSubscriptionTextParseMode

func WithGiftPremiumSubscriptionTextParseMode(value string) GiftPremiumSubscriptionOption

Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.

func WithGiftPremiumSubscriptionUserID

func WithGiftPremiumSubscriptionUserID(value int64) GiftPremiumSubscriptionOption

Unique identifier of the target user who will receive a Telegram Premium subscription

type GiftPremiumSubscriptionParams

type GiftPremiumSubscriptionParams struct {
	// Unique identifier of the target user who will receive a Telegram Premium subscription
	UserID int64 `json:"user_id"`

	// Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12
	MonthCount int64 `json:"month_count"`

	// Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months
	StarCount int64 `json:"star_count"`

	// Text that will be shown along with the service message about the subscription; 0-128 characters
	Text string `json:"text,omitempty"`

	// Mode for parsing entities in the text.
	// See [formatting options] for more details.
	// Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	TextParseMode string `json:"text_parse_mode,omitempty"`

	// A JSON-serialized list of special entities that appear in the gift text.
	// It can be specified instead of text_parse_mode.
	// Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.
	TextEntities []MessageEntity `json:"text_entities,omitempty"`
}

func (*GiftPremiumSubscriptionParams) Option

type Gifts

type Gifts struct {
	// The list of gifts
	Gifts []Gift `json:"gifts"`
}

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
	WinnersSelectionDate int64 `json:"winners_selection_date"`

	// The number of users which are supposed to be selected as winners of the giveaway
	WinnerCount int64 `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.
	//
	// [ISO 3166-1 alpha-2]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
	CountryCodes []string `json:"country_codes,omitempty"`

	// Optional.
	// The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only
	PrizeStarCount int64 `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 int64 `json:"premium_subscription_month_count,omitempty"`
}

Giveaway

This object represents a message about a scheduled giveaway.

type GiveawayCompleted

type GiveawayCompleted struct {
	// Number of winners in the giveaway
	WinnerCount int64 `json:"winner_count"`

	// Optional.
	// Number of undistributed prizes
	UnclaimedPrizeCount int64 `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"`
}

GiveawayCompleted

This object represents a service message about the completion of a giveaway without public winners.

type GiveawayCreated

type GiveawayCreated struct {
	// Optional.
	// The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only
	PrizeStarCount int64 `json:"prize_star_count,omitempty"`
}

GiveawayCreated

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 int64 `json:"giveaway_message_id"`

	// Point in time (Unix timestamp) when winners of the giveaway were selected
	WinnersSelectionDate int64 `json:"winners_selection_date"`

	// Total number of winners in the giveaway
	WinnerCount int64 `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 int64 `json:"additional_chat_count,omitempty"`

	// Optional.
	// The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only
	PrizeStarCount int64 `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 int64 `json:"premium_subscription_month_count,omitempty"`

	// Optional.
	// Number of undistributed prizes
	UnclaimedPrizeCount int64 `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"`
}

GiveawayWinners

This object represents a message about the completion of a giveaway with public winners.

type HandlerFunc

type HandlerFunc func(ctx *Context) error

type HandlerFuncErr

type HandlerFuncErr func(ctx *Context, err error)

type HandlerFuncPanic

type HandlerFuncPanic func(ctx *Context, v any)

type HideGeneralForumTopicOption

type HideGeneralForumTopicOption func(params *HideGeneralForumTopicParams) HideGeneralForumTopicOption

func WithHideGeneralForumTopicChatID

func WithHideGeneralForumTopicChatID(value string) HideGeneralForumTopicOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

type HideGeneralForumTopicParams

type HideGeneralForumTopicParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`
}

func (*HideGeneralForumTopicParams) Option

type Identifier

type Identifier interface {
	Identifier() string
}

type InaccessibleMessage

type InaccessibleMessage struct {
	// Chat the message belonged to
	Chat Chat `json:"chat"`

	// Unique message identifier inside the chat
	MessageID int64 `json:"message_id"`

	// Always 0.
	// The field can be used to differentiate regular and inaccessible messages.
	Date int64 `json:"date"`
}

InaccessibleMessage

This object describes a message that was deleted or is otherwise inaccessible to the bot.

type InlineKeyboard

type InlineKeyboard = []InlineKeyboardRow

type InlineKeyboardBuilder

type InlineKeyboardBuilder struct {
	// contains filtered or unexported fields
}

func NewInlineKeyboard

func NewInlineKeyboard() *InlineKeyboardBuilder

func (*InlineKeyboardBuilder) AddButton

func (b *InlineKeyboardBuilder) AddButton(text, data string) *InlineKeyboardBuilder

func (*InlineKeyboardBuilder) AddURL

func (b *InlineKeyboardBuilder) AddURL(text, url string) *InlineKeyboardBuilder

func (*InlineKeyboardBuilder) Build

func (*InlineKeyboardBuilder) Paginate

func (b *InlineKeyboardBuilder) Paginate(
	items []PaginationItem,
	page int,
	limit int,
	navPrefix string,
) *InlineKeyboardBuilder

func (*InlineKeyboardBuilder) Row

type InlineKeyboardButton

type InlineKeyboardButton struct {
	// Label text on the button
	Text string `json:"text"`

	// Optional.
	// Unique identifier of the custom emoji shown before the text of the button.
	// Can only be used by bots that purchased additional usernames on [Fragment] or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.
	//
	// [Fragment]: https://fragment.com
	IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`

	// Optional.
	// Style of the button.
	// Must be one of “danger” (red), “success” (green) or “primary” (blue).
	// If omitted, then an app-specific style is used.
	Style string `json:"style,omitempty"`

	// 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
	//
	// [callback query]: https://core.telegram.org/bots/api#callbackquery
	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.
	//
	// [Web App]: https://core.telegram.org/bots/webapps
	// [answerWebAppQuery]: https://core.telegram.org/bots/api#answerwebappquery
	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].
	//
	// [Telegram Login Widget]: https://core.telegram.org/widgets/login
	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 in channel direct messages chats and 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 in channel direct messages chats and 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 in channel direct messages chats and 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.
	//
	// NOTE: 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.
	//
	// NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.
	//
	// [Pay button]: https://core.telegram.org/bots/api#payments
	Pay bool `json:"pay,omitempty"`
}

InlineKeyboardButton

This object represents one button of an inline keyboard. Exactly one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button.

func (*InlineKeyboardButton) SetText

func (*InlineKeyboardButton) WithArgs

func (b *InlineKeyboardButton) WithArgs(args ...string) InlineKeyboardButton

WithArgs return copy of button with CallbackData looks like 'callback_data args[0] args[1] ... args[N-1] args[N]'.

func (*InlineKeyboardButton) WithPayload

func (b *InlineKeyboardButton) WithPayload(payload string) InlineKeyboardButton

WithPayload return copy of button with CallbackData looks like 'callback_data payload'.

type InlineKeyboardMarkup

type InlineKeyboardMarkup struct {
	// Array of button rows, each represented by an Array of [InlineKeyboardButton] objects
	//
	// [InlineKeyboardButton]: https://core.telegram.org/bots/api#inlinekeyboardbutton
	InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"`
}

InlineKeyboardMarkup

This object represents an inline keyboard that appears right next to the message it belongs to.

type InlineKeyboardRow

type InlineKeyboardRow = []InlineKeyboardButton

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"`
}

InlineQuery

This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.

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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// Optional.
	// URL of the result
	URL string `json:"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 int64 `json:"thumbnail_width,omitempty"`

	// Optional.
	// Thumbnail height
	ThumbnailHeight int64 `json:"thumbnail_height,omitempty"`
}

InlineQueryResultArticle

Represents a link to an article or web page.

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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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 int64 `json:"audio_duration,omitempty"`

	// Optional.
	// [Inline keyboard] attached to the message
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultAudio

Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultCachedAudio

Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultCachedDocument

Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.

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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultCachedGif

Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.

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:"mpeg4_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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultCachedMpeg4Gif

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultCachedPhoto

Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultCachedSticker

Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.

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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultCachedVideo

Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultCachedVoice

Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.

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]: https://en.wikipedia.org/wiki/VCard
	Vcard string `json:"vcard,omitempty"`

	// Optional.
	// [Inline keyboard] attached to the message
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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 int64 `json:"thumbnail_width,omitempty"`

	// Optional.
	// Thumbnail height
	ThumbnailHeight int64 `json:"thumbnail_height,omitempty"`
}

InlineQueryResultContact

Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.

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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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 int64 `json:"thumbnail_width,omitempty"`

	// Optional.
	// Thumbnail height
	ThumbnailHeight int64 `json:"thumbnail_height,omitempty"`
}

InlineQueryResultDocument

Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.

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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

InlineQueryResultGame

Represents a Game.

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
	GifUrl string `json:"gif_url"`

	// Optional.
	// Width of the GIF
	GifWidth int64 `json:"gif_width,omitempty"`

	// Optional.
	// Height of the GIF
	GifHeight int64 `json:"gif_height,omitempty"`

	// Optional.
	// Duration of the GIF in seconds
	GifDuration int64 `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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultGif

Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

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 float64 `json:"latitude"`

	// Location longitude in degrees
	Longitude float64 `json:"longitude"`

	// Location title
	Title string `json:"title"`

	// 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 int64 `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 int64 `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 int64 `json:"proximity_alert_radius,omitempty"`

	// Optional.
	// [Inline keyboard] attached to the message
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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 int64 `json:"thumbnail_width,omitempty"`

	// Optional.
	// Thumbnail height
	ThumbnailHeight int64 `json:"thumbnail_height,omitempty"`
}

InlineQueryResultLocation

Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.

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
	Mpeg4Url string `json:"mpeg4_url"`

	// Optional.
	// Video width
	Mpeg4Width int64 `json:"mpeg4_width,omitempty"`

	// Optional.
	// Video height
	Mpeg4Height int64 `json:"mpeg4_height,omitempty"`

	// Optional.
	// Video duration in seconds
	Mpeg4Duration int64 `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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultMpeg4Gif

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

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 int64 `json:"photo_width,omitempty"`

	// Optional.
	// Height of the photo
	PhotoHeight int64 `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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultPhoto

Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

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 float64 `json:"latitude"`

	// Longitude of the venue location in degrees
	Longitude float64 `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:"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 [supported types].)
	//
	// [supported types]: https://developers.google.com/places/web-service/supported_types
	GooglePlaceType string `json:"google_place_type,omitempty"`

	// Optional.
	// [Inline keyboard] attached to the message
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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 int64 `json:"thumbnail_width,omitempty"`

	// Optional.
	// Thumbnail height
	ThumbnailHeight int64 `json:"thumbnail_height,omitempty"`
}

InlineQueryResultVenue

Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.

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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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 int64 `json:"video_width,omitempty"`

	// Optional.
	// Video height
	VideoHeight int64 `json:"video_height,omitempty"`

	// Optional.
	// Video duration in seconds
	VideoDuration int64 `json:"video_duration,omitempty"`

	// Optional.
	// Short description of the result
	Description string `json:"description,omitempty"`

	// Optional.
	// [Inline keyboard] attached to the message
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultVideo

Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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 int64 `json:"voice_duration,omitempty"`

	// Optional.
	// [Inline keyboard] attached to the message
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	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"`
}

InlineQueryResultVoice

Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.

type InlineQueryResultsButton

type InlineQueryResultsButton struct {
	// Label text on the button
	Text string `json:"text"`

	// 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.
	//
	// [Web App]: https://core.telegram.org/bots/webapps
	// [switchInlineQuery]: https://core.telegram.org/bots/webapps#initializing-mini-apps
	WebApp *WebAppInfo `json:"web_app,omitempty"`

	// 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.
	//
	// [Deep-linking]: https://core.telegram.org/bots/features#deep-linking
	// [switch_inline]: https://core.telegram.org/bots/api#inlinekeyboardmarkup
	StartParameter string `json:"start_parameter,omitempty"`
}

InlineQueryResultsButton

This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.

type InputChecklist

type InputChecklist struct {
	// Title of the checklist; 1-255 characters after entities parsing
	Title string `json:"title"`

	// Optional.
	// Mode for parsing entities in the title.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// Optional.
	// List of special entities that appear in the title, which can be specified instead of parse_mode.
	// Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed.
	TitleEntities []MessageEntity `json:"title_entities,omitempty"`

	// List of 1-30 tasks in the checklist
	Tasks []InputChecklistTask `json:"tasks"`

	// Optional.
	// Pass True if other users can add tasks to the checklist
	OthersCanAddTasks bool `json:"others_can_add_tasks,omitempty"`

	// Optional.
	// Pass True if other users can mark tasks as done or not done in the checklist
	OthersCanMarkTasksAsDone bool `json:"others_can_mark_tasks_as_done,omitempty"`
}

InputChecklist

Describes a checklist to create.

type InputChecklistTask

type InputChecklistTask struct {
	// Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist
	ID int64 `json:"id"`

	// Text of the task; 1-100 characters after entities parsing
	Text string `json:"text"`

	// Optional.
	// Mode for parsing entities in the text.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// Optional.
	// List of special entities that appear in the text, which can be specified instead of parse_mode.
	// Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed.
	TextEntities []MessageEntity `json:"text_entities,omitempty"`
}

InputChecklistTask

Describes a task to add to a checklist.

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,omitempty"`

	// Optional.
	// Additional data about the contact in the form of a [vCard], 0-2048 bytes
	//
	// [vCard]: https://en.wikipedia.org/wiki/VCard
	Vcard string `json:"vcard,omitempty"`
}

InputContactMessageContent

Represents the content of a contact message to be sent as the result of an inline query.

type InputFile

type InputFile struct {
	FileID   string
	FileURL  string
	File     io.Reader
	FileName string
	// contains filtered or unexported fields
}

InputFile represents a file upload or an existing file reference.

func (*InputFile) AppendText

func (r *InputFile) AppendText(buf []byte) ([]byte, error)

func (*InputFile) MarshalText

func (r *InputFile) MarshalText() ([]byte, error)

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].
	//
	// [@BotFather]: https://t.me/botfather
	// [Telegram Stars]: https://t.me/BotNews/90
	ProviderToken string `json:"provider_token,omitempty"`

	// Three-letter ISO 4217 currency code, see [more on currencies].
	// Pass “XTR” for payments in [Telegram Stars].
	//
	// [more on currencies]: https://core.telegram.org/bots/payments#supported-currencies
	// [Telegram Stars]: https://t.me/BotNews/90
	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].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	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 [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].
	//
	// [currencies.json]: https://core.telegram.org/bots/payments/currencies.json
	// [Telegram Stars]: https://t.me/BotNews/90
	MaxTipAmount int64 `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 []int64 `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 int64 `json:"photo_size,omitempty"`

	// Optional.
	// Photo width
	PhotoWidth int64 `json:"photo_width,omitempty"`

	// Optional.
	// Photo height
	PhotoHeight int64 `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].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	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].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	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].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	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].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	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].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	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].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	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].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	IsFlexible bool `json:"is_flexible,omitempty"`
}

InputInvoiceMessageContent

Represents the content of an invoice message to be sent as the result of an inline query.

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 int64 `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 int64 `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 int64 `json:"proximity_alert_radius,omitempty"`
}

InputLocationMessageContent

Represents the content of a location message to be sent as the result of an inline query.

type InputMedia

InputMedia

This object represents the content of a media message to be sent. It should be one of

InputMediaAnimation

InputMediaDocument

InputMediaAudio

InputMediaPhoto

InputMediaVideo

func (*InputMedia) MarshalJSON

func (r *InputMedia) MarshalJSON() ([]byte, error)

func (*InputMedia) UnmarshalJSON

func (r *InputMedia) UnmarshalJSON(data []byte) error

type InputMediaAnimation

type InputMediaAnimation struct {
	// Type of the result, must be animation
	Type string `json:"type"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Media InputFile `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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Thumbnail *InputFile `json:"thumbnail,omitempty"`

	// Optional.
	// Caption of the animation to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// Optional.
	// Mode for parsing entities in the animation caption.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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.
	// Animation width
	Width int64 `json:"width,omitempty"`

	// Optional.
	// Animation height
	Height int64 `json:"height,omitempty"`

	// Optional.
	// Animation duration in seconds
	Duration int64 `json:"duration,omitempty"`

	// Optional.
	// Pass True if the animation needs to be covered with a spoiler animation
	HasSpoiler bool `json:"has_spoiler,omitempty"`
}

InputMediaAnimation

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

type InputMediaAudio

type InputMediaAudio struct {
	// Type of the result, must be audio
	Type string `json:"type"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Media InputFile `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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Thumbnail *InputFile `json:"thumbnail,omitempty"`

	// Optional.
	// Caption of the audio to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// Optional.
	// Mode for parsing entities in the audio caption.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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.
	// Duration of the audio in seconds
	Duration int64 `json:"duration,omitempty"`

	// Optional.
	// Performer of the audio
	Performer string `json:"performer,omitempty"`

	// Optional.
	// Title of the audio
	Title string `json:"title,omitempty"`
}

InputMediaAudio

Represents an audio file to be treated as music to be sent.

type InputMediaDocument

type InputMediaDocument struct {
	// Type of the result, must be document
	Type string `json:"type"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Media InputFile `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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Thumbnail *InputFile `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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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"`
}

InputMediaDocument

Represents a general file to be sent.

type InputMediaPhoto

type InputMediaPhoto struct {
	// Type of the result, must be photo
	Type string `json:"type"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Media InputFile `json:"media"`

	// 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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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.
	// Pass True if the photo needs to be covered with a spoiler animation
	HasSpoiler bool `json:"has_spoiler,omitempty"`
}

InputMediaPhoto

Represents a photo to be sent.

type InputMediaVideo

type InputMediaVideo struct {
	// Type of the result, must be video
	Type string `json:"type"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Media InputFile `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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Thumbnail *InputFile `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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Cover *InputFile `json:"cover,omitempty"`

	// Optional.
	// Start timestamp for the video in the message
	StartTimestamp int64 `json:"start_timestamp,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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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
	Width int64 `json:"width,omitempty"`

	// Optional.
	// Video height
	Height int64 `json:"height,omitempty"`

	// Optional.
	// Video duration in seconds
	Duration int64 `json:"duration,omitempty"`

	// Optional.
	// Pass True if the uploaded video is suitable for streaming
	SupportsStreaming bool `json:"supports_streaming,omitempty"`

	// Optional.
	// Pass True if the video needs to be covered with a spoiler animation
	HasSpoiler bool `json:"has_spoiler,omitempty"`
}

InputMediaVideo

Represents a video to be sent.

type InputMessageContent

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

func (*InputMessageContent) MarshalJSON

func (r *InputMessageContent) MarshalJSON() ([]byte, error)

type InputPaidMedia

type InputPaidMedia struct {
	*InputPaidMediaPhoto
	*InputPaidMediaVideo
}

InputPaidMedia

This object describes the paid media to be sent. Currently, it can be one of

InputPaidMediaPhoto

InputPaidMediaVideo

func (*InputPaidMedia) MarshalJSON

func (r *InputPaidMedia) MarshalJSON() ([]byte, error)

func (*InputPaidMedia) UnmarshalJSON

func (r *InputPaidMedia) UnmarshalJSON(data []byte) error

type InputPaidMediaPhoto

type InputPaidMediaPhoto struct {
	// Type of the media, must be photo
	Type string `json:"type"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Media InputFile `json:"media"`
}

InputPaidMediaPhoto

The paid media to send is a photo.

type InputPaidMediaVideo

type InputPaidMediaVideo struct {
	// Type of the media, must be video
	Type string `json:"type"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Media InputFile `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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Thumbnail *InputFile `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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Cover *InputFile `json:"cover,omitempty"`

	// Optional.
	// Start timestamp for the video in the message
	StartTimestamp int64 `json:"start_timestamp,omitempty"`

	// Optional.
	// Video width
	Width int64 `json:"width,omitempty"`

	// Optional.
	// Video height
	Height int64 `json:"height,omitempty"`

	// Optional.
	// Video duration in seconds
	Duration int64 `json:"duration,omitempty"`

	// Optional.
	// Pass True if the uploaded video is suitable for streaming
	SupportsStreaming bool `json:"supports_streaming,omitempty"`
}

InputPaidMediaVideo

The paid media to send is a video.

type InputPollOption

type InputPollOption struct {
	// Option text, 1-100 characters
	Text string `json:"text"`

	// Optional.
	// Mode for parsing entities in the text.
	// See [formatting options] for more details.
	// Currently, only custom emoji entities are allowed
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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"`
}

InputPollOption

This object contains information about one answer option in a poll to be sent.

type InputProfilePhoto

type InputProfilePhoto struct {
	*InputProfilePhotoStatic
	*InputProfilePhotoAnimated
}

InputProfilePhoto

This object describes a profile photo to set. Currently, it can be one of

InputProfilePhotoStatic

InputProfilePhotoAnimated

func (*InputProfilePhoto) MarshalJSON

func (r *InputProfilePhoto) MarshalJSON() ([]byte, error)

func (*InputProfilePhoto) UnmarshalJSON

func (r *InputProfilePhoto) UnmarshalJSON(data []byte) error

type InputProfilePhotoAnimated

type InputProfilePhotoAnimated struct {
	// Type of the profile photo, must be animated
	Type string `json:"type"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Animation InputFile `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_timestamp,omitempty"`
}

InputProfilePhotoAnimated

An animated profile photo in the MPEG4 format.

type InputProfilePhotoStatic

type InputProfilePhotoStatic struct {
	// Type of the profile photo, must be static
	Type string `json:"type"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Photo InputFile `json:"photo"`
}

InputProfilePhotoStatic

A static profile photo in the .JPG format.

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, or pass “attach://<file_attach_name>” to upload a new file 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 »]
	//
	// [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"`
}

InputSticker

This object describes a sticker to be added to a sticker set.

type InputStoryContent

type InputStoryContent struct {
	*InputStoryContentPhoto
	*InputStoryContentVideo
}

InputStoryContent

This object describes the content of a story to post. Currently, it can be one of

InputStoryContentPhoto

InputStoryContentVideo

func (*InputStoryContent) MarshalJSON

func (r *InputStoryContent) MarshalJSON() ([]byte, error)

func (*InputStoryContent) UnmarshalJSON

func (r *InputStoryContent) UnmarshalJSON(data []byte) error

type InputStoryContentPhoto

type InputStoryContentPhoto struct {
	// Type of the content, must be photo
	Type string `json:"type"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Photo InputFile `json:"photo"`
}

InputStoryContentPhoto

Describes a photo to post as a story.

type InputStoryContentVideo

type InputStoryContentVideo struct {
	// Type of the content, must be video
	Type string `json:"type"`

	// 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 video was uploaded using multipart/form-data under <file_attach_name>.
	// [More information on Sending Files »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Video InputFile `json:"video"`

	// 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"`
}

InputStoryContentVideo

Describes a video to post as a story.

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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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"`
}

InputTextMessageContent

Represents the content of a text message to be sent as the result of an inline query.

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 [supported types].)
	//
	// [supported types]: https://developers.google.com/places/web-service/supported_types
	GooglePlaceType string `json:"google_place_type,omitempty"`
}

InputVenueMessageContent

Represents the content of a venue message to be sent as the result of an inline query.

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]: https://core.telegram.org/bots/payments#supported-currencies
	// [Telegram Stars]: https://t.me/BotNews/90
	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 [currencies.json], it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
	//
	// [currencies.json]: https://core.telegram.org/bots/payments/currencies.json
	TotalAmount int64 `json:"total_amount"`
}

Invoice

This object contains basic information about an invoice.

type KeyboardButton

type KeyboardButton struct {
	// Text of the button.
	// If none of the fields other than text, icon_custom_emoji_id, and style are used, it will be sent as a message when the button is pressed
	Text string `json:"text"`

	// Optional.
	// Unique identifier of the custom emoji shown before the text of the button.
	// Can only be used by bots that purchased additional usernames on [Fragment] or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.
	//
	// [Fragment]: https://fragment.com
	IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`

	// Optional.
	// Style of the button.
	// Must be one of “danger” (red), “success” (green) or “primary” (blue).
	// If omitted, then an app-specific style is used.
	Style string `json:"style,omitempty"`

	// 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.
	//
	// [Web App]: https://core.telegram.org/bots/webapps
	WebApp *WebAppInfo `json:"web_app,omitempty"`
}

KeyboardButton

This object represents one button of the reply keyboard. At most one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button. For simple text buttons, String can be used instead of this object to specify the button text.

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"`
}

KeyboardButtonPollType

This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

type KeyboardButtonRequestChat

type KeyboardButtonRequestChat struct {
	// Signed 32-bit identifier of the request, which will be received back in the [ChatShared] object.
	// Must be unique within the message
	//
	// [ChatShared]: https://core.telegram.org/bots/api#chatshared
	RequestID int64 `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"`
}

KeyboardButtonRequestChat

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 ».

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
	//
	// [UsersShared]: https://core.telegram.org/bots/api#usersshared
	RequestID int64 `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 int64 `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"`
}

KeyboardButtonRequestUsers

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 »

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 [currencies.json], it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
	//
	// [currency]: https://core.telegram.org/bots/payments#supported-currencies
	// [currencies.json]: https://core.telegram.org/bots/payments/currencies.json
	Amount int64 `json:"amount"`
}

LabeledPrice

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

type LeaveChatOption

type LeaveChatOption func(params *LeaveChatParams) LeaveChatOption

func WithLeaveChatChatID

func WithLeaveChatChatID(value string) LeaveChatOption

Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername). Channel direct messages chats aren't supported; leave the corresponding channel instead.

type LeaveChatParams

type LeaveChatParams struct {
	// Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername).
	// Channel direct messages chats aren't supported; leave the corresponding channel instead.
	ChatID string `json:"chat_id"`
}

func (*LeaveChatParams) Option

func (r *LeaveChatParams) Option(opts ...LeaveChatOption) (previous LeaveChatOption)

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
	URL string `json:"url,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"`
}

LinkPreviewOptions

Describes the options used for link preview generation.

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 int64 `json:"live_period,omitempty"`

	// Optional.
	// The direction in which user is moving, in degrees; 1-360.
	// For active live locations only.
	Heading int64 `json:"heading,omitempty"`

	// Optional.
	// The maximum distance for proximity alerts about approaching another chat member, in meters.
	// For sent live locations only.
	ProximityAlertRadius int64 `json:"proximity_alert_radius,omitempty"`
}

Location

This object represents a point on the map.

type LocationAddress

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"`
}

LocationAddress

Describes the physical address of a location.

type LogOutOption

type LogOutOption func(params *LogOutParams) LogOutOption

type LogOutParams

type LogOutParams struct {
}

func (*LogOutParams) Option

func (r *LogOutParams) Option(opts ...LogOutOption) (previous LogOutOption)

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].
	//
	// NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in [Checking authorization].
	//
	// [Receiving authorization data]: https://core.telegram.org/widgets/login#receiving-authorization-data
	// [Checking authorization]: 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.
	//
	// [Setting up a bot]: https://core.telegram.org/widgets/login#setting-up-a-bot
	// [Linking your domain to the bot]: https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot
	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"`
}

LoginUrl

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 float64 `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 float64 `json:"y_shift"`

	// Mask scaling coefficient.
	// For example, 2.0 means double size.
	Scale float64 `json:"scale"`
}

MaskPosition

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

type MaybeInaccessibleMessage

type MaybeInaccessibleMessage struct {
	*Message
	*InaccessibleMessage
}

MaybeInaccessibleMessage

This object describes a message that can be inaccessible to the bot. It can be one of

Message

InaccessibleMessage

func (*MaybeInaccessibleMessage) Chat

func (r *MaybeInaccessibleMessage) Chat() *Chat

func (*MaybeInaccessibleMessage) MarshalJSON

func (r *MaybeInaccessibleMessage) MarshalJSON() ([]byte, error)

func (*MaybeInaccessibleMessage) MessageID

func (r *MaybeInaccessibleMessage) MessageID() int64

func (*MaybeInaccessibleMessage) UnmarshalJSON

func (r *MaybeInaccessibleMessage) UnmarshalJSON(bs []byte) error
type MenuButton struct {
	*MenuButtonCommands
	*MenuButtonWebApp
	*MenuButtonDefault
}

MenuButton

This object describes the bot's menu button in a private chat. It should be one of

MenuButtonCommands

MenuButtonWebApp

MenuButtonDefault

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.

func (r *MenuButton) MarshalJSON() ([]byte, error)
func (r *MenuButton) UnmarshalJSON(data []byte) error
type MenuButtonCommands struct {
	// Type of the button, must be commands
	Type string `json:"type"`
}

MenuButtonCommands

Represents a menu button, which opens the bot's list of commands.

type MenuButtonDefault struct {
	// Type of the button, must be default
	Type string `json:"type"`
}

MenuButtonDefault

Describes that no specific value for the menu button was set.

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.
	//
	// [answerWebAppQuery]: https://core.telegram.org/bots/api#answerwebappquery
	WebApp WebAppInfo `json:"web_app"`
}

MenuButtonWebApp

Represents a menu button, which launches a Web App.

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 int64 `json:"message_id"`

	// Optional.
	// Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and private chats only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Optional.
	// Information about the direct messages chat topic that contains the message
	DirectMessagesTopic *DirectMessagesTopic `json:"direct_messages_topic,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 int64 `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 int64 `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 topic in a forum supergroup or a private chat with the bot
	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.
	//
	// [Message]: https://core.telegram.org/bots/api#message
	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.
	// Identifier of the specific checklist task that is being replied to
	ReplyToChecklistTaskID int64 `json:"reply_to_checklist_task_id,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 int64 `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.
	// True, if the message is a paid post.
	// Note that such posts must not be deleted for 24 hours to receive the payment and can't be edited.
	IsPaidPost bool `json:"is_paid_post,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 int64 `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.
	// Information about suggested post parameters if the message is a suggested post in a channel direct messages chat.
	// If the message is an approved or declined suggested post, then it can't be edited.
	SuggestedPostInfo *SuggestedPostInfo `json:"suggested_post_info,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
	//
	// [video note]: https://telegram.org/blog/video-messages-and-telescope
	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 checklist
	Checklist *Checklist `json:"checklist,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 »]
	//
	// [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.
	// Service message: chat owner has left
	ChatOwnerLeft *ChatOwnerLeft `json:"chat_owner_left,omitempty"`

	// Optional.
	// Service message: chat owner has changed
	ChatOwnerChanged *ChatOwnerChanged `json:"chat_owner_changed,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.
	SupergroupChatCreated bool `json:"supergroup_chat_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,omitempty"`

	// 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.
	//
	// [Message]: https://core.telegram.org/bots/api#message
	PinnedMessage *MaybeInaccessibleMessage `json:"pinned_message,omitempty"`

	// Optional.
	// Message is an invoice for a [payment], information about the invoice.
	// [More about payments »]
	//
	// [payment]: https://core.telegram.org/bots/api#payments
	// [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 »]
	//
	// [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 »]
	//
	// [More about payments »]: https://core.telegram.org/bots/api#payments
	RefundedPayment *RefundedPayment `json:"refunded_payment,omitempty"`

	// Optional.
	// Service message: users were shared with the bot
	UsersShared *UsersShared `json:"users_shared,omitempty"`

	// Optional.
	// Service message: a chat was shared with the bot
	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.
	// Service message: upgrade of a gift was purchased after the gift was sent
	GiftUpgradeSent *GiftInfo `json:"gift_upgrade_sent,omitempty"`

	// Optional.
	// The domain name of the website on which the user has logged in.
	// [More about Telegram Login »]
	//
	// [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]
	//
	// [requestWriteAccess]: https://core.telegram.org/bots/webapps#initializing-mini-apps
	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: some tasks in a checklist were marked as done or not done
	ChecklistTasksDone *ChecklistTasksDone `json:"checklist_tasks_done,omitempty"`

	// Optional.
	// Service message: tasks were added to a checklist
	ChecklistTasksAdded *ChecklistTasksAdded `json:"checklist_tasks_added,omitempty"`

	// Optional.
	// Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed
	DirectMessagePriceChanged *DirectMessagePriceChanged `json:"direct_message_price_changed,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"`

	// Optional.
	// Service message: the 'General' forum topic unhidden
	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: a suggested post was approved
	SuggestedPostApproved *SuggestedPostApproved `json:"suggested_post_approved,omitempty"`

	// Optional.
	// Service message: approval of a suggested post has failed
	SuggestedPostApprovalFailed *SuggestedPostApprovalFailed `json:"suggested_post_approval_failed,omitempty"`

	// Optional.
	// Service message: a suggested post was declined
	SuggestedPostDeclined *SuggestedPostDeclined `json:"suggested_post_declined,omitempty"`

	// Optional.
	// Service message: payment for a suggested post was received
	SuggestedPostPaid *SuggestedPostPaid `json:"suggested_post_paid,omitempty"`

	// Optional.
	// Service message: payment for a suggested post was refunded
	SuggestedPostRefunded *SuggestedPostRefunded `json:"suggested_post_refunded,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.
	//
	// [Inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

Message

This object represents a message.

func (*Message) Args

func (m *Message) Args() []string

func (*Message) Payload

func (m *Message) Payload() string

func (*Message) Time

func (m *Message) Time() time.Time

type MessageAutoDeleteTimerChanged

type MessageAutoDeleteTimerChanged struct {
	// New auto-delete time for messages in the chat; in seconds
	MessageAutoDeleteTime int64 `json:"message_auto_delete_time"`
}

MessageAutoDeleteTimerChanged

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” (do-not-reply@telegram.org), “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)
	//
	// [without usernames]: https://telegram.org/blog/edit#new-mentions
	Type string `json:"type"`

	// Offset in [UTF-16 code units] to the start of the entity
	//
	// [UTF-16 code units]: https://core.telegram.org/api/entities#entity-length
	Offset int64 `json:"offset"`

	// Length of the entity in [UTF-16 code units]
	//
	// [UTF-16 code units]: https://core.telegram.org/api/entities#entity-length
	Length int64 `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 [getCustomEmojiStickers] to get full information about the sticker
	//
	// [getCustomEmojiStickers]: https://core.telegram.org/bots/api#getcustomemojistickers
	CustomEmojiID string `json:"custom_emoji_id,omitempty"`
}

MessageEntity

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

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 int64 `json:"message_id"`
}

MessageId

This object represents a unique message identifier.

type MessageOrigin

MessageOrigin

This object describes the origin of a message. It can be one of

MessageOriginUser

MessageOriginHiddenUser

MessageOriginChat

MessageOriginChannel

func (*MessageOrigin) MarshalJSON

func (r *MessageOrigin) MarshalJSON() ([]byte, error)

func (*MessageOrigin) UnmarshalJSON

func (r *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 int64 `json:"date"`

	// Channel chat to which the message was originally sent
	Chat Chat `json:"chat"`

	// Unique message identifier inside the chat
	MessageID int64 `json:"message_id"`

	// Optional.
	// Signature of the original post author
	AuthorSignature string `json:"author_signature,omitempty"`
}

MessageOriginChannel

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 int64 `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"`
}

MessageOriginChat

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 int64 `json:"date"`

	// Name of the user that sent the message originally
	SenderUserName string `json:"sender_user_name"`
}

MessageOriginHiddenUser

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 int64 `json:"date"`

	// User that sent the message originally
	SenderUser User `json:"sender_user"`
}

MessageOriginUser

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 int64 `json:"message_id"`

	// Date of the change in Unix time
	Date int64 `json:"date"`

	// List of reactions that are present on the message
	Reactions []ReactionCount `json:"reactions"`
}

MessageReactionCountUpdated

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 int64 `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 int64 `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"`
}

MessageReactionUpdated

This object represents a change of a reaction on a message performed by a user.

type MiddlewareFunc

type MiddlewareFunc func(next HandlerFunc) HandlerFunc

type MigrateError

type MigrateError struct {
	Err             error
	MigrateToChatID int64
}

MigrateError means the group has been migrated to a supergroup with the specified identifier.

func (*MigrateError) Error

func (e *MigrateError) Error() string

func (*MigrateError) Unwrap

func (e *MigrateError) Unwrap() error

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"`
}

OrderInfo

This object represents information about an order.

type OwnedGift

type OwnedGift struct {
	*OwnedGiftRegular
	*OwnedGiftUnique
}

OwnedGift

This object describes a gift received and owned by a user or a chat. Currently, it can be one of

OwnedGiftRegular

OwnedGiftUnique

func (*OwnedGift) MarshalJSON

func (r *OwnedGift) MarshalJSON() ([]byte, error)

func (*OwnedGift) UnmarshalJSON

func (r *OwnedGift) UnmarshalJSON(data []byte) error

type OwnedGiftRegular

type OwnedGiftRegular struct {
	// Type of the gift, always “regular”
	Type string `json:"type"`

	// Information about the regular gift
	Gift Gift `json:"gift"`

	// 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"`

	// Date the gift was sent in Unix time
	SendDate int64 `json:"send_date"`

	// 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; for gifts received on behalf of business accounts only
	ConvertStarCount int64 `json:"convert_star_count,omitempty"`

	// Optional.
	// Number of Telegram Stars that were paid for the ability to upgrade the gift
	PrepaidUpgradeStarCount int64 `json:"prepaid_upgrade_star_count,omitempty"`

	// Optional.
	// True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only
	IsUpgradeSeparate bool `json:"is_upgrade_separate,omitempty"`

	// Optional.
	// Unique number reserved for this gift when upgraded.
	// See the number field in [UniqueGift]
	//
	// [UniqueGift]: https://core.telegram.org/bots/api#uniquegift
	UniqueGiftNumber int64 `json:"unique_gift_number,omitempty"`
}

OwnedGiftRegular

Describes a regular gift owned by a user or a chat.

type OwnedGiftUnique

type OwnedGiftUnique struct {
	// Type of the gift, always “unique”
	Type string `json:"type"`

	// Information about the unique gift
	Gift UniqueGift `json:"gift"`

	// 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"`

	// Date the gift was sent in Unix time
	SendDate int64 `json:"send_date"`

	// 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 int64 `json:"transfer_star_count,omitempty"`

	// Optional.
	// Point in time (Unix timestamp) when the gift can be transferred.
	// If it is in the past, then the gift can be transferred now
	NextTransferDate int64 `json:"next_transfer_date,omitempty"`
}

OwnedGiftUnique

Describes a unique gift received and owned by a user or a chat.

type OwnedGifts

type OwnedGifts struct {
	// The total number of gifts owned by the user or the chat
	TotalCount int64 `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"`
}

OwnedGifts

Contains the list of gifts received and owned by a user or a chat.

type PaginationItem

type PaginationItem struct {
	Text         string
	CallbackData string
}

type PaidMedia

type PaidMedia struct {
	*PaidMediaPreview
	*PaidMediaPhoto
	*PaidMediaVideo
}

PaidMedia

This object describes paid media. Currently, it can be one of

PaidMediaPreview

PaidMediaPhoto

PaidMediaVideo

func (*PaidMedia) MarshalJSON

func (r *PaidMedia) MarshalJSON() ([]byte, error)

func (*PaidMedia) UnmarshalJSON

func (r *PaidMedia) UnmarshalJSON(data []byte) error

type PaidMediaInfo

type PaidMediaInfo struct {
	// The number of Telegram Stars that must be paid to buy access to the media
	StarCount int64 `json:"star_count"`

	// Information about the paid media
	PaidMedia []PaidMedia `json:"paid_media"`
}

PaidMediaInfo

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"`
}

PaidMediaPhoto

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 int64 `json:"width,omitempty"`

	// Optional.
	// Media height as defined by the sender
	Height int64 `json:"height,omitempty"`

	// Optional.
	// Duration of the media in seconds as defined by the sender
	Duration int64 `json:"duration,omitempty"`
}

PaidMediaPreview

The paid media isn't available before the payment.

type PaidMediaPurchased

type PaidMediaPurchased struct {
	// User who purchased the media
	From User `json:"from"`

	// Bot-specified paid media payload
	PaidMediaPayload string `json:"paid_media_payload"`
}

PaidMediaPurchased

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"`
}

PaidMediaVideo

The paid media is a video.

type PaidMessagePriceChanged

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 int64 `json:"paid_message_star_count"`
}

PaidMessagePriceChanged

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"`
}

PassportData

Describes Telegram Passport data shared with the bot by the user.

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"`
}

PassportElementErrorDataField

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.

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"`
}

PassportElementErrorFile

Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.

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"`
}

PassportElementErrorFiles

Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.

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"`
}

PassportElementErrorFrontSide

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.

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"`
}

PassportElementErrorReverseSide

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.

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"`
}

PassportElementErrorSelfie

Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.

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"`
}

PassportElementErrorTranslationFile

Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.

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"`
}

PassportElementErrorTranslationFiles

Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.

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"`
}

PassportElementErrorUnspecified

Represents an issue in an unspecified place. The error is considered resolved when new data is added.

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 int64 `json:"file_size"`

	// Unix time when the file was uploaded
	FileDate int64 `json:"file_date"`
}

PassportFile

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 int64 `json:"width"`

	// Photo height
	Height int64 `json:"height"`

	// Optional.
	// File size in bytes
	FileSize int64 `json:"file_size,omitempty"`
}

PhotoSize

This object represents one size of a photo or a file / sticker thumbnail.

func PhotoBiggest

func PhotoBiggest(list []PhotoSize) PhotoSize

type PinChatMessageOption

type PinChatMessageOption func(params *PinChatMessageParams) PinChatMessageOption

func WithPinChatMessageBusinessConnectionID

func WithPinChatMessageBusinessConnectionID(value string) PinChatMessageOption

Unique identifier of the business connection on behalf of which the message will be pinned

func WithPinChatMessageChatID

func WithPinChatMessageChatID(value string) PinChatMessageOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithPinChatMessageDisableNotification

func WithPinChatMessageDisableNotification(value bool) PinChatMessageOption

Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.

func WithPinChatMessageMessageID

func WithPinChatMessageMessageID(value int64) PinChatMessageOption

Identifier of a message to pin

type PinChatMessageParams

type PinChatMessageParams struct {
	// Unique identifier of the business connection on behalf of which the message will be pinned
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Identifier of a message to pin
	MessageID int64 `json:"message_id"`

	// Pass True if it is not necessary to send a notification to all chat members about the new pinned message.
	// Notifications are always disabled in channels and private chats.
	DisableNotification bool `json:"disable_notification,omitempty"`
}

func (*PinChatMessageParams) Option

func (r *PinChatMessageParams) Option(opts ...PinChatMessageOption) (previous PinChatMessageOption)

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,omitempty"`

	// List of poll options
	Options []PollOption `json:"options"`

	// Total number of users that voted in the poll
	TotalVoterCount int64 `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 int64 `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 int64 `json:"open_period,omitempty"`

	// Optional.
	// Point in time (Unix timestamp) when the poll will be automatically closed
	CloseDate int64 `json:"close_date,omitempty"`
}

Poll

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,omitempty"`

	// Optional.
	// The user that changed the answer to the poll, if the voter isn't anonymous
	User *User `json:"user,omitempty"`

	// 0-based identifiers of chosen answer options.
	// May be empty if the vote was retracted.
	OptionIDs []int64 `json:"option_ids"`
}

PollAnswer

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
	TextEntities []MessageEntity `json:"text_entities,omitempty"`

	// Number of users that voted for this option
	VoterCount int64 `json:"voter_count"`
}

PollOption

This object contains information about one answer option in a poll.

type PostStoryOption

type PostStoryOption func(params *PostStoryParams) PostStoryOption

func WithPostStoryActivePeriod

func WithPostStoryActivePeriod(value int64) PostStoryOption

Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400

func WithPostStoryAreas

func WithPostStoryAreas(value []StoryArea) PostStoryOption

A JSON-serialized list of clickable areas to be shown on the story

func WithPostStoryBusinessConnectionID

func WithPostStoryBusinessConnectionID(value string) PostStoryOption

Unique identifier of the business connection

func WithPostStoryCaption

func WithPostStoryCaption(value string) PostStoryOption

Caption of the story, 0-2048 characters after entities parsing

func WithPostStoryCaptionEntities

func WithPostStoryCaptionEntities(value []MessageEntity) PostStoryOption

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

func WithPostStoryContent

func WithPostStoryContent(value InputStoryContent) PostStoryOption

Content of the story

func WithPostStoryParseMode

func WithPostStoryParseMode(value string) PostStoryOption

Mode for parsing entities in the story caption. See formatting options for more details.

func WithPostStoryPostToChatPage

func WithPostStoryPostToChatPage(value bool) PostStoryOption

Pass True to keep the story accessible after it expires

func WithPostStoryProtectContent

func WithPostStoryProtectContent(value bool) PostStoryOption

Pass True if the content of the story must be protected from forwarding and screenshotting

type PostStoryParams

type PostStoryParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Content of the story
	Content InputStoryContent `json:"content"`

	// Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400
	ActivePeriod int64 `json:"active_period"`

	// Caption of the story, 0-2048 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// Mode for parsing entities in the story caption.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
	CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`

	// A JSON-serialized list of clickable areas to be shown on the story
	Areas []StoryArea `json:"areas,omitempty"`

	// Pass True to keep the story accessible after it expires
	PostToChatPage bool `json:"post_to_chat_page,omitempty"`

	// Pass True if the content of the story must be protected from forwarding and screenshotting
	ProtectContent bool `json:"protect_content,omitempty"`
}

func (*PostStoryParams) Option

func (r *PostStoryParams) Option(opts ...PostStoryOption) (previous PostStoryOption)

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]: https://core.telegram.org/bots/payments#supported-currencies
	// [Telegram Stars]: https://t.me/BotNews/90
	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 [currencies.json], it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
	//
	// [currencies.json]: https://core.telegram.org/bots/payments/currencies.json
	TotalAmount int64 `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"`
}

PreCheckoutQuery

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

type PreparedInlineMessage

type PreparedInlineMessage struct {
	// Unique identifier of the prepared message
	ID string `json:"id"`

	// Expiration date of the prepared message, in Unix time.
	// Expired prepared messages can no longer be used
	ExpirationDate int64 `json:"expiration_date"`
}

PreparedInlineMessage

Describes an inline message to be sent by a user of a Mini App.

type PromoteChatMemberOption

type PromoteChatMemberOption func(params *PromoteChatMemberParams) PromoteChatMemberOption

func WithPromoteChatMemberCanChangeInfo

func WithPromoteChatMemberCanChangeInfo(value bool) PromoteChatMemberOption

Pass True if the administrator can change chat title, photo and other settings

func WithPromoteChatMemberCanDeleteMessages

func WithPromoteChatMemberCanDeleteMessages(value bool) PromoteChatMemberOption

Pass True if the administrator can delete messages of other users

func WithPromoteChatMemberCanDeleteStories

func WithPromoteChatMemberCanDeleteStories(value bool) PromoteChatMemberOption

Pass True if the administrator can delete stories posted by other users

func WithPromoteChatMemberCanEditMessages

func WithPromoteChatMemberCanEditMessages(value bool) PromoteChatMemberOption

Pass True if the administrator can edit messages of other users and can pin messages; for channels only

func WithPromoteChatMemberCanEditStories

func WithPromoteChatMemberCanEditStories(value bool) PromoteChatMemberOption

Pass 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

func WithPromoteChatMemberCanInviteUsers

func WithPromoteChatMemberCanInviteUsers(value bool) PromoteChatMemberOption

Pass True if the administrator can invite new users to the chat

func WithPromoteChatMemberCanManageChat

func WithPromoteChatMemberCanManageChat(value bool) PromoteChatMemberOption

Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.

func WithPromoteChatMemberCanManageDirectMessages

func WithPromoteChatMemberCanManageDirectMessages(value bool) PromoteChatMemberOption

Pass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only

func WithPromoteChatMemberCanManageTopics

func WithPromoteChatMemberCanManageTopics(value bool) PromoteChatMemberOption

Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only

func WithPromoteChatMemberCanManageVideoChats

func WithPromoteChatMemberCanManageVideoChats(value bool) PromoteChatMemberOption

Pass True if the administrator can manage video chats

func WithPromoteChatMemberCanPinMessages

func WithPromoteChatMemberCanPinMessages(value bool) PromoteChatMemberOption

Pass True if the administrator can pin messages; for supergroups only

func WithPromoteChatMemberCanPostMessages

func WithPromoteChatMemberCanPostMessages(value bool) PromoteChatMemberOption

Pass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only

func WithPromoteChatMemberCanPostStories

func WithPromoteChatMemberCanPostStories(value bool) PromoteChatMemberOption

Pass True if the administrator can post stories to the chat

func WithPromoteChatMemberCanPromoteMembers

func WithPromoteChatMemberCanPromoteMembers(value bool) PromoteChatMemberOption

Pass 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 him)

func WithPromoteChatMemberCanRestrictMembers

func WithPromoteChatMemberCanRestrictMembers(value bool) PromoteChatMemberOption

Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to True for promotions of channel administrators

func WithPromoteChatMemberChatID

func WithPromoteChatMemberChatID(value string) PromoteChatMemberOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithPromoteChatMemberIsAnonymous

func WithPromoteChatMemberIsAnonymous(value bool) PromoteChatMemberOption

Pass True if the administrator's presence in the chat is hidden

func WithPromoteChatMemberUserID

func WithPromoteChatMemberUserID(value int64) PromoteChatMemberOption

Unique identifier of the target user

type PromoteChatMemberParams

type PromoteChatMemberParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// Pass True if the administrator's presence in the chat is hidden
	IsAnonymous bool `json:"is_anonymous,omitempty"`

	// Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars.
	// Implied by any other administrator privilege.
	CanManageChat bool `json:"can_manage_chat,omitempty"`

	// Pass True if the administrator can delete messages of other users
	CanDeleteMessages bool `json:"can_delete_messages,omitempty"`

	// Pass True if the administrator can manage video chats
	CanManageVideoChats bool `json:"can_manage_video_chats,omitempty"`

	// Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics.
	// For backward compatibility, defaults to True for promotions of channel administrators
	CanRestrictMembers bool `json:"can_restrict_members,omitempty"`

	// Pass 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 him)
	CanPromoteMembers bool `json:"can_promote_members,omitempty"`

	// Pass True if the administrator can change chat title, photo and other settings
	CanChangeInfo bool `json:"can_change_info,omitempty"`

	// Pass True if the administrator can invite new users to the chat
	CanInviteUsers bool `json:"can_invite_users,omitempty"`

	// Pass True if the administrator can post stories to the chat
	CanPostStories bool `json:"can_post_stories,omitempty"`

	// Pass 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,omitempty"`

	// Pass True if the administrator can delete stories posted by other users
	CanDeleteStories bool `json:"can_delete_stories,omitempty"`

	// Pass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only
	CanPostMessages bool `json:"can_post_messages,omitempty"`

	// Pass True if the administrator can edit messages of other users and can pin messages; for channels only
	CanEditMessages bool `json:"can_edit_messages,omitempty"`

	// Pass True if the administrator can pin messages; for supergroups only
	CanPinMessages bool `json:"can_pin_messages,omitempty"`

	// Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
	CanManageTopics bool `json:"can_manage_topics,omitempty"`

	// Pass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only
	CanManageDirectMessages bool `json:"can_manage_direct_messages,omitempty"`
}

func (*PromoteChatMemberParams) Option

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 int64 `json:"distance"`
}

ProximityAlertTriggered

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 int64 `json:"total_count"`
}

ReactionCount

Represents a reaction added to a message along with the number of times it was added.

type ReactionType

ReactionType

This object describes the type of a reaction. Currently, it can be one of

ReactionTypeEmoji

ReactionTypeCustomEmoji

ReactionTypePaid

func (*ReactionType) MarshalJSON

func (r *ReactionType) MarshalJSON() ([]byte, error)

func (*ReactionType) UnmarshalJSON

func (r *ReactionType) UnmarshalJSON(data []byte) error

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"`
}

ReactionTypeCustomEmoji

The reaction is based on a custom emoji.

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"`
}

ReactionTypeEmoji

The reaction is based on an emoji.

type ReactionTypePaid

type ReactionTypePaid struct {
	// Type of the reaction, always “paid”
	Type string `json:"type"`
}

ReactionTypePaid

The reaction is paid.

type ReadBusinessMessageOption

type ReadBusinessMessageOption func(params *ReadBusinessMessageParams) ReadBusinessMessageOption

func WithReadBusinessMessageBusinessConnectionID

func WithReadBusinessMessageBusinessConnectionID(value string) ReadBusinessMessageOption

Unique identifier of the business connection on behalf of which to read the message

func WithReadBusinessMessageChatID

func WithReadBusinessMessageChatID(value int64) ReadBusinessMessageOption

Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours.

func WithReadBusinessMessageMessageID

func WithReadBusinessMessageMessageID(value int64) ReadBusinessMessageOption

Unique identifier of the message to mark as read

type ReadBusinessMessageParams

type ReadBusinessMessageParams struct {
	// Unique identifier of the business connection on behalf of which to read the message
	BusinessConnectionID string `json:"business_connection_id"`

	// Unique identifier of the chat in which the message was received.
	// The chat must have been active in the last 24 hours.
	ChatID int64 `json:"chat_id"`

	// Unique identifier of the message to mark as read
	MessageID int64 `json:"message_id"`
}

func (*ReadBusinessMessageParams) Option

type RefundStarPaymentOption

type RefundStarPaymentOption func(params *RefundStarPaymentParams) RefundStarPaymentOption

func WithRefundStarPaymentTelegramPaymentChargeID

func WithRefundStarPaymentTelegramPaymentChargeID(value string) RefundStarPaymentOption

Telegram payment identifier

func WithRefundStarPaymentUserID

func WithRefundStarPaymentUserID(value int64) RefundStarPaymentOption

Identifier of the user whose payment will be refunded

type RefundStarPaymentParams

type RefundStarPaymentParams struct {
	// Identifier of the user whose payment will be refunded
	UserID int64 `json:"user_id"`

	// Telegram payment identifier
	TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
}

func (*RefundStarPaymentParams) Option

type RefundedPayment

type RefundedPayment struct {
	// Three-letter ISO 4217 [currency] code, or “XTR” for payments in [Telegram Stars].
	// Currently, always “XTR”
	//
	// [currency]: https://core.telegram.org/bots/payments#supported-currencies
	// [Telegram Stars]: https://t.me/BotNews/90
	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 [currencies.json], it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
	//
	// [currencies.json]: https://core.telegram.org/bots/payments/currencies.json
	TotalAmount int64 `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"`
}

RefundedPayment

This object contains basic information about a refunded payment.

type RemoveBusinessAccountProfilePhotoOption

type RemoveBusinessAccountProfilePhotoOption func(params *RemoveBusinessAccountProfilePhotoParams) RemoveBusinessAccountProfilePhotoOption

func WithRemoveBusinessAccountProfilePhotoBusinessConnectionID

func WithRemoveBusinessAccountProfilePhotoBusinessConnectionID(value string) RemoveBusinessAccountProfilePhotoOption

Unique identifier of the business connection

func WithRemoveBusinessAccountProfilePhotoIsPublic

func WithRemoveBusinessAccountProfilePhotoIsPublic(value bool) RemoveBusinessAccountProfilePhotoOption

Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.

type RemoveBusinessAccountProfilePhotoParams

type RemoveBusinessAccountProfilePhotoParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings.
	// After the main photo is removed, the previous profile photo (if present) becomes the main photo.
	IsPublic bool `json:"is_public,omitempty"`
}

func (*RemoveBusinessAccountProfilePhotoParams) Option

type RemoveChatVerificationOption

type RemoveChatVerificationOption func(params *RemoveChatVerificationParams) RemoveChatVerificationOption

func WithRemoveChatVerificationChatID

func WithRemoveChatVerificationChatID(value string) RemoveChatVerificationOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

type RemoveChatVerificationParams

type RemoveChatVerificationParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`
}

func (*RemoveChatVerificationParams) Option

type RemoveMyProfilePhotoOption

type RemoveMyProfilePhotoOption func(params *RemoveMyProfilePhotoParams) RemoveMyProfilePhotoOption

type RemoveMyProfilePhotoParams

type RemoveMyProfilePhotoParams struct {
}

func (*RemoveMyProfilePhotoParams) Option

type RemoveUserVerificationOption

type RemoveUserVerificationOption func(params *RemoveUserVerificationParams) RemoveUserVerificationOption

func WithRemoveUserVerificationUserID

func WithRemoveUserVerificationUserID(value int64) RemoveUserVerificationOption

Unique identifier of the target user

type RemoveUserVerificationParams

type RemoveUserVerificationParams struct {
	// Unique identifier of the target user
	UserID int64 `json:"user_id"`
}

func (*RemoveUserVerificationParams) Option

type ReopenForumTopicOption

type ReopenForumTopicOption func(params *ReopenForumTopicParams) ReopenForumTopicOption

func WithReopenForumTopicChatID

func WithReopenForumTopicChatID(value string) ReopenForumTopicOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

func WithReopenForumTopicMessageThreadID

func WithReopenForumTopicMessageThreadID(value int64) ReopenForumTopicOption

Unique identifier for the target message thread of the forum topic

type ReopenForumTopicParams

type ReopenForumTopicParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread of the forum topic
	MessageThreadID int64 `json:"message_thread_id"`
}

func (*ReopenForumTopicParams) Option

type ReopenGeneralForumTopicOption

type ReopenGeneralForumTopicOption func(params *ReopenGeneralForumTopicParams) ReopenGeneralForumTopicOption

func WithReopenGeneralForumTopicChatID

func WithReopenGeneralForumTopicChatID(value string) ReopenGeneralForumTopicOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

type ReopenGeneralForumTopicParams

type ReopenGeneralForumTopicParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`
}

func (*ReopenGeneralForumTopicParams) Option

type ReplaceStickerInSetOption

type ReplaceStickerInSetOption func(params *ReplaceStickerInSetParams) ReplaceStickerInSetOption

func WithReplaceStickerInSetName

func WithReplaceStickerInSetName(value string) ReplaceStickerInSetOption

Sticker set name

func WithReplaceStickerInSetOldSticker

func WithReplaceStickerInSetOldSticker(value string) ReplaceStickerInSetOption

File identifier of the replaced sticker

func WithReplaceStickerInSetSticker

func WithReplaceStickerInSetSticker(value InputSticker) ReplaceStickerInSetOption

A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.

func WithReplaceStickerInSetUserID

func WithReplaceStickerInSetUserID(value int64) ReplaceStickerInSetOption

User identifier of the sticker set owner

type ReplaceStickerInSetParams

type ReplaceStickerInSetParams struct {
	// User identifier of the sticker set owner
	UserID int64 `json:"user_id"`

	// Sticker set name
	Name string `json:"name"`

	// File identifier of the replaced sticker
	OldSticker string `json:"old_sticker"`

	// A JSON-serialized object with information about the added sticker.
	// If exactly the same sticker had already been added to the set, then the set remains unchanged.
	Sticker InputSticker `json:"sticker"`
}

func (*ReplaceStickerInSetParams) Option

type ReplyKeyboardMarkup

type ReplyKeyboardMarkup struct {
	// Array of button rows, each represented by an Array of [KeyboardButton] objects
	//
	// [KeyboardButton]: https://core.telegram.org/bots/api#keyboardbutton
	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.
	//
	// [Message]: https://core.telegram.org/bots/api#message
	Selective bool `json:"selective,omitempty"`
}

ReplyKeyboardMarkup

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.

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])
	//
	// [ReplyKeyboardMarkup]: https://core.telegram.org/bots/api#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.
	//
	// [Message]: https://core.telegram.org/bots/api#message
	Selective bool `json:"selective,omitempty"`
}

ReplyKeyboardRemove

Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.

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 int64 `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 and messages from channel direct messages chats.
	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 [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	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 int64 `json:"quote_position,omitempty"`

	// Optional.
	// Identifier of the specific checklist task to be replied to
	ChecklistTaskID int64 `json:"checklist_task_id,omitempty"`
}

ReplyParameters

Describes reply parameters for the message that is being sent.

type RepostStoryOption

type RepostStoryOption func(params *RepostStoryParams) RepostStoryOption

func WithRepostStoryActivePeriod

func WithRepostStoryActivePeriod(value int64) RepostStoryOption

Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400

func WithRepostStoryBusinessConnectionID

func WithRepostStoryBusinessConnectionID(value string) RepostStoryOption

Unique identifier of the business connection

func WithRepostStoryFromChatID

func WithRepostStoryFromChatID(value int64) RepostStoryOption

Unique identifier of the chat which posted the story that should be reposted

func WithRepostStoryFromStoryID

func WithRepostStoryFromStoryID(value int64) RepostStoryOption

Unique identifier of the story that should be reposted

func WithRepostStoryPostToChatPage

func WithRepostStoryPostToChatPage(value bool) RepostStoryOption

Pass True to keep the story accessible after it expires

func WithRepostStoryProtectContent

func WithRepostStoryProtectContent(value bool) RepostStoryOption

Pass True if the content of the story must be protected from forwarding and screenshotting

type RepostStoryParams

type RepostStoryParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Unique identifier of the chat which posted the story that should be reposted
	FromChatID int64 `json:"from_chat_id"`

	// Unique identifier of the story that should be reposted
	FromStoryID int64 `json:"from_story_id"`

	// Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400
	ActivePeriod int64 `json:"active_period"`

	// Pass True to keep the story accessible after it expires
	PostToChatPage bool `json:"post_to_chat_page,omitempty"`

	// Pass True if the content of the story must be protected from forwarding and screenshotting
	ProtectContent bool `json:"protect_content,omitempty"`
}

func (*RepostStoryParams) Option

func (r *RepostStoryParams) Option(opts ...RepostStoryOption) (previous RepostStoryOption)

type Response

type Response struct {
	Parameters  *ResponseParameters `json:"parameters,omitempty"`
	Description string              `json:"description,omitempty"`
	Result      json.RawMessage     `json:"result,omitempty"`
	ErrorCode   int                 `json:"error_code,omitempty"`
	OK          bool                `json:"ok"`
}

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 int64 `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 int64 `json:"retry_after,omitempty"`
}

ResponseParameters

Describes why a request was unsuccessful.

type RestrictChatMemberOption

type RestrictChatMemberOption func(params *RestrictChatMemberParams) RestrictChatMemberOption

func WithRestrictChatMemberChatID

func WithRestrictChatMemberChatID(value string) RestrictChatMemberOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

func WithRestrictChatMemberPermissions

func WithRestrictChatMemberPermissions(value ChatPermissions) RestrictChatMemberOption

A JSON-serialized object for new user permissions

func WithRestrictChatMemberUntilDate

func WithRestrictChatMemberUntilDate(value int64) RestrictChatMemberOption

Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever

func WithRestrictChatMemberUseIndependentChatPermissions

func WithRestrictChatMemberUseIndependentChatPermissions(value bool) RestrictChatMemberOption

Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.

func WithRestrictChatMemberUserID

func WithRestrictChatMemberUserID(value int64) RestrictChatMemberOption

Unique identifier of the target user

type RestrictChatMemberParams

type RestrictChatMemberParams struct {
	// 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 int64 `json:"user_id"`

	// A JSON-serialized object for new user permissions
	Permissions ChatPermissions `json:"permissions"`

	// Pass True if chat permissions are set independently.
	// Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.
	UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"`

	// Date when restrictions will be lifted for the user; Unix time.
	// If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever
	UntilDate int64 `json:"until_date,omitempty"`
}

func (*RestrictChatMemberParams) Option

type RetryError

type RetryError struct {
	Err        error
	RetryAfter time.Duration
}

RetryError in case of exceeding flood control, the number of seconds left to wait before the request can be repeated.

func (*RetryError) Error

func (e *RetryError) Error() string

func (*RetryError) Unwrap

func (e *RetryError) Unwrap() error

type RevenueWithdrawalState

RevenueWithdrawalState

This object describes the state of a revenue withdrawal operation. Currently, it can be one of

RevenueWithdrawalStatePending

RevenueWithdrawalStateSucceeded

RevenueWithdrawalStateFailed

func (*RevenueWithdrawalState) MarshalJSON

func (r *RevenueWithdrawalState) MarshalJSON() ([]byte, error)

func (*RevenueWithdrawalState) UnmarshalJSON

func (r *RevenueWithdrawalState) UnmarshalJSON(data []byte) error

type RevenueWithdrawalStateFailed

type RevenueWithdrawalStateFailed struct {
	// Type of the state, always “failed”
	Type string `json:"type"`
}

RevenueWithdrawalStateFailed

The withdrawal failed and the transaction was refunded.

type RevenueWithdrawalStatePending

type RevenueWithdrawalStatePending struct {
	// Type of the state, always “pending”
	Type string `json:"type"`
}

RevenueWithdrawalStatePending

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 int64 `json:"date"`

	// An HTTPS URL that can be used to see transaction details
	URL string `json:"url"`
}

RevenueWithdrawalStateSucceeded

The withdrawal succeeded.

type RevokeChatInviteLinkOption

type RevokeChatInviteLinkOption func(params *RevokeChatInviteLinkParams) RevokeChatInviteLinkOption

func WithRevokeChatInviteLinkChatID

func WithRevokeChatInviteLinkChatID(value string) RevokeChatInviteLinkOption

Unique identifier of the target chat or username of the target channel (in the format @channelusername)

func WithRevokeChatInviteLinkInviteLink(value string) RevokeChatInviteLinkOption

The invite link to revoke

type RevokeChatInviteLinkParams

type RevokeChatInviteLinkParams struct {
	// Unique identifier of the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// The invite link to revoke
	InviteLink string `json:"invite_link"`
}

func (*RevokeChatInviteLinkParams) Option

type Router

type Router struct {
	*RouterGroup
	// contains filtered or unexported fields
}

func NewRouter

func NewRouter() *Router

func (*Router) HandleInlineKeyboardButton

func (r *Router) HandleInlineKeyboardButton(
	b *InlineKeyboardButton,
	handler func(ctx *Context, cq *CallbackQuery,
	) error)

func (*Router) HandleKeyboardButton

func (r *Router) HandleKeyboardButton(b *KeyboardButton, handler func(ctx *Context, m *Message) error)

func (*Router) Process

func (r *Router) Process(ctx *Context)

func (*Router) SetHandlerDefault

func (r *Router) SetHandlerDefault(handler HandlerFunc)

func (*Router) SetHandlerErr

func (r *Router) SetHandlerErr(handler HandlerFuncErr)

func (*Router) SetHandlerPanic

func (r *Router) SetHandlerPanic(handler HandlerFuncPanic)

func (*Router) Use

func (r *Router) Use(funcs ...MiddlewareFunc)

Use must be called before handlers functions because middlewares applied one time in place.

type RouterGroup

type RouterGroup struct {
	// contains filtered or unexported fields
}

func (*RouterGroup) Group

func (rg *RouterGroup) Group(filters ...Filter) *RouterGroup

func (*RouterGroup) HandleOnBusinessConnection

func (rg *RouterGroup) HandleOnBusinessConnection(handler func(*Context, *BusinessConnection) error, filters ...Filter)

func (*RouterGroup) HandleOnBusinessMessage

func (rg *RouterGroup) HandleOnBusinessMessage(handler func(*Context, *Message) error, filters ...Filter)

func (*RouterGroup) HandleOnCallbackQuery

func (rg *RouterGroup) HandleOnCallbackQuery(handler func(*Context, *CallbackQuery) error, filters ...Filter)

func (*RouterGroup) HandleOnChannelPost

func (rg *RouterGroup) HandleOnChannelPost(handler func(*Context, *Message) error, filters ...Filter)

func (*RouterGroup) HandleOnChatBoost

func (rg *RouterGroup) HandleOnChatBoost(handler func(*Context, *ChatBoostUpdated) error, filters ...Filter)

func (*RouterGroup) HandleOnChatJoinRequest

func (rg *RouterGroup) HandleOnChatJoinRequest(handler func(*Context, *ChatJoinRequest) error, filters ...Filter)

func (*RouterGroup) HandleOnChatMember

func (rg *RouterGroup) HandleOnChatMember(handler func(*Context, *ChatMemberUpdated) error, filters ...Filter)

func (*RouterGroup) HandleOnChosenInlineResult

func (rg *RouterGroup) HandleOnChosenInlineResult(handler func(*Context, *ChosenInlineResult) error, filters ...Filter)

func (*RouterGroup) HandleOnDeletedBusinessMessages

func (rg *RouterGroup) HandleOnDeletedBusinessMessages(handler func(*Context, *BusinessMessagesDeleted) error, filters ...Filter)

func (*RouterGroup) HandleOnEditedBusinessMessage

func (rg *RouterGroup) HandleOnEditedBusinessMessage(handler func(*Context, *Message) error, filters ...Filter)

func (*RouterGroup) HandleOnEditedChannelPost

func (rg *RouterGroup) HandleOnEditedChannelPost(handler func(*Context, *Message) error, filters ...Filter)

func (*RouterGroup) HandleOnEditedMessage

func (rg *RouterGroup) HandleOnEditedMessage(handler func(*Context, *Message) error, filters ...Filter)

func (*RouterGroup) HandleOnInlineQuery

func (rg *RouterGroup) HandleOnInlineQuery(handler func(*Context, *InlineQuery) error, filters ...Filter)

func (*RouterGroup) HandleOnMessage

func (rg *RouterGroup) HandleOnMessage(handler func(*Context, *Message) error, filters ...Filter)

func (*RouterGroup) HandleOnMessageReaction

func (rg *RouterGroup) HandleOnMessageReaction(handler func(*Context, *MessageReactionUpdated) error, filters ...Filter)

func (*RouterGroup) HandleOnMessageReactionCount

func (rg *RouterGroup) HandleOnMessageReactionCount(handler func(*Context, *MessageReactionCountUpdated) error, filters ...Filter)

func (*RouterGroup) HandleOnMyChatMember

func (rg *RouterGroup) HandleOnMyChatMember(handler func(*Context, *ChatMemberUpdated) error, filters ...Filter)

func (*RouterGroup) HandleOnPoll

func (rg *RouterGroup) HandleOnPoll(handler func(*Context, *Poll) error, filters ...Filter)

func (*RouterGroup) HandleOnPollAnswer

func (rg *RouterGroup) HandleOnPollAnswer(handler func(*Context, *PollAnswer) error, filters ...Filter)

func (*RouterGroup) HandleOnPreCheckoutQuery

func (rg *RouterGroup) HandleOnPreCheckoutQuery(handler func(*Context, *PreCheckoutQuery) error, filters ...Filter)

func (*RouterGroup) HandleOnPurchasedPaidMedia

func (rg *RouterGroup) HandleOnPurchasedPaidMedia(handler func(*Context, *PaidMediaPurchased) error, filters ...Filter)

func (*RouterGroup) HandleOnRemovedChatBoost

func (rg *RouterGroup) HandleOnRemovedChatBoost(handler func(*Context, *ChatBoostRemoved) error, filters ...Filter)

func (*RouterGroup) HandleOnShippingQuery

func (rg *RouterGroup) HandleOnShippingQuery(handler func(*Context, *ShippingQuery) error, filters ...Filter)

func (*RouterGroup) Use

func (rg *RouterGroup) Use(funcs ...MiddlewareFunc)

type SavePreparedInlineMessageOption

type SavePreparedInlineMessageOption func(params *SavePreparedInlineMessageParams) SavePreparedInlineMessageOption

func WithSavePreparedInlineMessageAllowBotChats

func WithSavePreparedInlineMessageAllowBotChats(value bool) SavePreparedInlineMessageOption

Pass True if the message can be sent to private chats with bots

func WithSavePreparedInlineMessageAllowChannelChats

func WithSavePreparedInlineMessageAllowChannelChats(value bool) SavePreparedInlineMessageOption

Pass True if the message can be sent to channel chats

func WithSavePreparedInlineMessageAllowGroupChats

func WithSavePreparedInlineMessageAllowGroupChats(value bool) SavePreparedInlineMessageOption

Pass True if the message can be sent to group and supergroup chats

func WithSavePreparedInlineMessageAllowUserChats

func WithSavePreparedInlineMessageAllowUserChats(value bool) SavePreparedInlineMessageOption

Pass True if the message can be sent to private chats with users

func WithSavePreparedInlineMessageResult

func WithSavePreparedInlineMessageResult(value InlineQueryResult) SavePreparedInlineMessageOption

A JSON-serialized object describing the message to be sent

func WithSavePreparedInlineMessageUserID

func WithSavePreparedInlineMessageUserID(value int64) SavePreparedInlineMessageOption

Unique identifier of the target user that can use the prepared message

type SavePreparedInlineMessageParams

type SavePreparedInlineMessageParams struct {
	// Unique identifier of the target user that can use the prepared message
	UserID int64 `json:"user_id"`

	// A JSON-serialized object describing the message to be sent
	Result InlineQueryResult `json:"result"`

	// Pass True if the message can be sent to private chats with users
	AllowUserChats bool `json:"allow_user_chats,omitempty"`

	// Pass True if the message can be sent to private chats with bots
	AllowBotChats bool `json:"allow_bot_chats,omitempty"`

	// Pass True if the message can be sent to group and supergroup chats
	AllowGroupChats bool `json:"allow_group_chats,omitempty"`

	// Pass True if the message can be sent to channel chats
	AllowChannelChats bool `json:"allow_channel_chats,omitempty"`
}

func (*SavePreparedInlineMessageParams) Option

type SendAnimationOption

type SendAnimationOption func(params *SendAnimationParams) SendAnimationOption

func WithSendAnimationAllowPaidBroadcast

func WithSendAnimationAllowPaidBroadcast(value bool) SendAnimationOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendAnimationAnimation

func WithSendAnimationAnimation(value InputFile) SendAnimationOption

Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files »

func WithSendAnimationBusinessConnectionID

func WithSendAnimationBusinessConnectionID(value string) SendAnimationOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendAnimationCaption

func WithSendAnimationCaption(value string) SendAnimationOption

Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing

func WithSendAnimationCaptionEntities

func WithSendAnimationCaptionEntities(value []MessageEntity) SendAnimationOption

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

func WithSendAnimationChatID

func WithSendAnimationChatID(value string) SendAnimationOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendAnimationDirectMessagesTopicID

func WithSendAnimationDirectMessagesTopicID(value int64) SendAnimationOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendAnimationDisableNotification

func WithSendAnimationDisableNotification(value bool) SendAnimationOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendAnimationDuration

func WithSendAnimationDuration(value int64) SendAnimationOption

Duration of sent animation in seconds

func WithSendAnimationHasSpoiler

func WithSendAnimationHasSpoiler(value bool) SendAnimationOption

Pass True if the animation needs to be covered with a spoiler animation

func WithSendAnimationHeight

func WithSendAnimationHeight(value int64) SendAnimationOption

Animation height

func WithSendAnimationMessageEffectID

func WithSendAnimationMessageEffectID(value string) SendAnimationOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendAnimationMessageThreadID

func WithSendAnimationMessageThreadID(value int64) SendAnimationOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendAnimationParseMode

func WithSendAnimationParseMode(value string) SendAnimationOption

Mode for parsing entities in the animation caption. See formatting options for more details.

func WithSendAnimationProtectContent

func WithSendAnimationProtectContent(value bool) SendAnimationOption

Protects the contents of the sent message from forwarding and saving

func WithSendAnimationReplyMarkup

func WithSendAnimationReplyMarkup(value *ReplyMarkup) SendAnimationOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendAnimationReplyParameters

func WithSendAnimationReplyParameters(value *ReplyParameters) SendAnimationOption

Description of the message to reply to

func WithSendAnimationShowCaptionAboveMedia

func WithSendAnimationShowCaptionAboveMedia(value bool) SendAnimationOption

Pass True, if the caption must be shown above the message media

func WithSendAnimationSuggestedPostParameters

func WithSendAnimationSuggestedPostParameters(value *SuggestedPostParameters) SendAnimationOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

func WithSendAnimationThumbnail

func WithSendAnimationThumbnail(value *InputFile) SendAnimationOption

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 »

func WithSendAnimationWidth

func WithSendAnimationWidth(value int64) SendAnimationOption

Animation width

type SendAnimationParams

type SendAnimationParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Animation to send.
	// Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data.
	// [More information on Sending Files »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Animation InputFile `json:"animation"`

	// Duration of sent animation in seconds
	Duration int64 `json:"duration,omitempty"`

	// Animation width
	Width int64 `json:"width,omitempty"`

	// Animation height
	Height int64 `json:"height,omitempty"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Thumbnail *InputFile `json:"thumbnail,omitempty"`

	// Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// Mode for parsing entities in the animation caption.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized 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 animation needs to be covered with a spoiler animation
	HasSpoiler bool `json:"has_spoiler,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendAnimationParams) Option

func (r *SendAnimationParams) Option(opts ...SendAnimationOption) (previous SendAnimationOption)

type SendAudioOption

type SendAudioOption func(params *SendAudioParams) SendAudioOption

func WithSendAudioAllowPaidBroadcast

func WithSendAudioAllowPaidBroadcast(value bool) SendAudioOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendAudioAudio

func WithSendAudioAudio(value InputFile) SendAudioOption

Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »

func WithSendAudioBusinessConnectionID

func WithSendAudioBusinessConnectionID(value string) SendAudioOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendAudioCaption

func WithSendAudioCaption(value string) SendAudioOption

Audio caption, 0-1024 characters after entities parsing

func WithSendAudioCaptionEntities

func WithSendAudioCaptionEntities(value []MessageEntity) SendAudioOption

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

func WithSendAudioChatID

func WithSendAudioChatID(value string) SendAudioOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendAudioDirectMessagesTopicID

func WithSendAudioDirectMessagesTopicID(value int64) SendAudioOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendAudioDisableNotification

func WithSendAudioDisableNotification(value bool) SendAudioOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendAudioDuration

func WithSendAudioDuration(value int64) SendAudioOption

Duration of the audio in seconds

func WithSendAudioMessageEffectID

func WithSendAudioMessageEffectID(value string) SendAudioOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendAudioMessageThreadID

func WithSendAudioMessageThreadID(value int64) SendAudioOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendAudioParseMode

func WithSendAudioParseMode(value string) SendAudioOption

Mode for parsing entities in the audio caption. See formatting options for more details.

func WithSendAudioPerformer

func WithSendAudioPerformer(value string) SendAudioOption

Performer

func WithSendAudioProtectContent

func WithSendAudioProtectContent(value bool) SendAudioOption

Protects the contents of the sent message from forwarding and saving

func WithSendAudioReplyMarkup

func WithSendAudioReplyMarkup(value *ReplyMarkup) SendAudioOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendAudioReplyParameters

func WithSendAudioReplyParameters(value *ReplyParameters) SendAudioOption

Description of the message to reply to

func WithSendAudioSuggestedPostParameters

func WithSendAudioSuggestedPostParameters(value *SuggestedPostParameters) SendAudioOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

func WithSendAudioThumbnail

func WithSendAudioThumbnail(value *InputFile) SendAudioOption

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 »

func WithSendAudioTitle

func WithSendAudioTitle(value string) SendAudioOption

Track name

type SendAudioParams

type SendAudioParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Audio file to send.
	// Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data.
	// [More information on Sending Files »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Audio InputFile `json:"audio"`

	// Audio caption, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// Mode for parsing entities in the audio caption.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized 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 int64 `json:"duration,omitempty"`

	// Performer
	Performer string `json:"performer,omitempty"`

	// Track name
	Title string `json:"title,omitempty"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Thumbnail *InputFile `json:"thumbnail,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendAudioParams) Option

func (r *SendAudioParams) Option(opts ...SendAudioOption) (previous SendAudioOption)

type SendChatActionOption

type SendChatActionOption func(params *SendChatActionParams) SendChatActionOption

func WithSendChatActionAction

func WithSendChatActionAction(value string) SendChatActionOption

Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.

func WithSendChatActionBusinessConnectionID

func WithSendChatActionBusinessConnectionID(value string) SendChatActionOption

Unique identifier of the business connection on behalf of which the action will be sent

func WithSendChatActionChatID

func WithSendChatActionChatID(value string) SendChatActionOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel chats and channel direct messages chats aren't supported.

func WithSendChatActionMessageThreadID

func WithSendChatActionMessageThreadID(value int64) SendChatActionOption

Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only

type SendChatActionParams

type SendChatActionParams struct {
	// Unique identifier of the business connection on behalf of which the action will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).
	// Channel chats and channel direct messages chats aren't supported.
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Type of action to broadcast.
	// Choose one, depending on what the user is about to receive: typing for [text messages], upload_photo for [photos], record_video or upload_video for [videos], record_voice or upload_voice for [voice notes], upload_document for [general files], choose_sticker for [stickers], find_location for [location data], record_video_note or upload_video_note for [video notes].
	//
	// [text messages]: https://core.telegram.org/bots/api#sendmessage
	// [photos]: https://core.telegram.org/bots/api#sendphoto
	// [videos]: https://core.telegram.org/bots/api#sendvideo
	// [voice notes]: https://core.telegram.org/bots/api#sendvoice
	// [general files]: https://core.telegram.org/bots/api#senddocument
	// [stickers]: https://core.telegram.org/bots/api#sendsticker
	// [location data]: https://core.telegram.org/bots/api#sendlocation
	// [video notes]: https://core.telegram.org/bots/api#sendvideonote
	Action string `json:"action"`
}

func (*SendChatActionParams) Option

func (r *SendChatActionParams) Option(opts ...SendChatActionOption) (previous SendChatActionOption)

type SendChecklistOption

type SendChecklistOption func(params *SendChecklistParams) SendChecklistOption

func WithSendChecklistBusinessConnectionID

func WithSendChecklistBusinessConnectionID(value string) SendChecklistOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendChecklistChatID

func WithSendChecklistChatID(value int64) SendChecklistOption

Unique identifier for the target chat

func WithSendChecklistChecklist

func WithSendChecklistChecklist(value InputChecklist) SendChecklistOption

A JSON-serialized object for the checklist to send

func WithSendChecklistDisableNotification

func WithSendChecklistDisableNotification(value bool) SendChecklistOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendChecklistMessageEffectID

func WithSendChecklistMessageEffectID(value string) SendChecklistOption

Unique identifier of the message effect to be added to the message

func WithSendChecklistProtectContent

func WithSendChecklistProtectContent(value bool) SendChecklistOption

Protects the contents of the sent message from forwarding and saving

func WithSendChecklistReplyMarkup

func WithSendChecklistReplyMarkup(value *InlineKeyboardMarkup) SendChecklistOption

A JSON-serialized object for an inline keyboard

func WithSendChecklistReplyParameters

func WithSendChecklistReplyParameters(value *ReplyParameters) SendChecklistOption

A JSON-serialized object for description of the message to reply to

type SendChecklistParams

type SendChecklistParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id"`

	// Unique identifier for the target chat
	ChatID int64 `json:"chat_id"`

	// A JSON-serialized object for the checklist to send
	Checklist InputChecklist `json:"checklist"`

	// Sends the message silently.
	// Users will receive a notification with no sound.
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Unique identifier of the message effect to be added to the message
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object for description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// A JSON-serialized object for an [inline keyboard]
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func (*SendChecklistParams) Option

func (r *SendChecklistParams) Option(opts ...SendChecklistOption) (previous SendChecklistOption)

type SendContactOption

type SendContactOption func(params *SendContactParams) SendContactOption

func WithSendContactAllowPaidBroadcast

func WithSendContactAllowPaidBroadcast(value bool) SendContactOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendContactBusinessConnectionID

func WithSendContactBusinessConnectionID(value string) SendContactOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendContactChatID

func WithSendContactChatID(value string) SendContactOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendContactDirectMessagesTopicID

func WithSendContactDirectMessagesTopicID(value int64) SendContactOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendContactDisableNotification

func WithSendContactDisableNotification(value bool) SendContactOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendContactFirstName

func WithSendContactFirstName(value string) SendContactOption

Contact's first name

func WithSendContactLastName

func WithSendContactLastName(value string) SendContactOption

Contact's last name

func WithSendContactMessageEffectID

func WithSendContactMessageEffectID(value string) SendContactOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendContactMessageThreadID

func WithSendContactMessageThreadID(value int64) SendContactOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendContactPhoneNumber

func WithSendContactPhoneNumber(value string) SendContactOption

Contact's phone number

func WithSendContactProtectContent

func WithSendContactProtectContent(value bool) SendContactOption

Protects the contents of the sent message from forwarding and saving

func WithSendContactReplyMarkup

func WithSendContactReplyMarkup(value *ReplyMarkup) SendContactOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendContactReplyParameters

func WithSendContactReplyParameters(value *ReplyParameters) SendContactOption

Description of the message to reply to

func WithSendContactSuggestedPostParameters

func WithSendContactSuggestedPostParameters(value *SuggestedPostParameters) SendContactOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

func WithSendContactVcard

func WithSendContactVcard(value string) SendContactOption

Additional data about the contact in the form of a vCard, 0-2048 bytes

type SendContactParams

type SendContactParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Contact's phone number
	PhoneNumber string `json:"phone_number"`

	// Contact's first name
	FirstName string `json:"first_name"`

	// Contact's last name
	LastName string `json:"last_name,omitempty"`

	// Additional data about the contact in the form of a [vCard], 0-2048 bytes
	//
	// [vCard]: https://en.wikipedia.org/wiki/VCard
	Vcard string `json:"vcard,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendContactParams) Option

func (r *SendContactParams) Option(opts ...SendContactOption) (previous SendContactOption)

type SendDiceOption

type SendDiceOption func(params *SendDiceParams) SendDiceOption

func WithSendDiceAllowPaidBroadcast

func WithSendDiceAllowPaidBroadcast(value bool) SendDiceOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendDiceBusinessConnectionID

func WithSendDiceBusinessConnectionID(value string) SendDiceOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendDiceChatID

func WithSendDiceChatID(value string) SendDiceOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendDiceDirectMessagesTopicID

func WithSendDiceDirectMessagesTopicID(value int64) SendDiceOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendDiceDisableNotification

func WithSendDiceDisableNotification(value bool) SendDiceOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendDiceEmoji

func WithSendDiceEmoji(value string) SendDiceOption

Emoji on which the dice throw animation is based. Currently, must be one of “”, “”, “”, “”, “”, or “”. Dice can have values 1-6 for “”, “” and “”, values 1-5 for “” and “”, and values 1-64 for “”. Defaults to “”

func WithSendDiceMessageEffectID

func WithSendDiceMessageEffectID(value string) SendDiceOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendDiceMessageThreadID

func WithSendDiceMessageThreadID(value int64) SendDiceOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendDiceProtectContent

func WithSendDiceProtectContent(value bool) SendDiceOption

Protects the contents of the sent message from forwarding

func WithSendDiceReplyMarkup

func WithSendDiceReplyMarkup(value *ReplyMarkup) SendDiceOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendDiceReplyParameters

func WithSendDiceReplyParameters(value *ReplyParameters) SendDiceOption

Description of the message to reply to

func WithSendDiceSuggestedPostParameters

func WithSendDiceSuggestedPostParameters(value *SuggestedPostParameters) SendDiceOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

type SendDiceParams

type SendDiceParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Emoji on which the dice throw animation is based.
	// Currently, must be one of “”, “”, “”, “”, “”, or “”.
	// Dice can have values 1-6 for “”, “” and “”, values 1-5 for “” and “”, and values 1-64 for “”.
	// Defaults to “”
	Emoji string `json:"emoji,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendDiceParams) Option

func (r *SendDiceParams) Option(opts ...SendDiceOption) (previous SendDiceOption)

type SendDocumentOption

type SendDocumentOption func(params *SendDocumentParams) SendDocumentOption

func WithSendDocumentAllowPaidBroadcast

func WithSendDocumentAllowPaidBroadcast(value bool) SendDocumentOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendDocumentBusinessConnectionID

func WithSendDocumentBusinessConnectionID(value string) SendDocumentOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendDocumentCaption

func WithSendDocumentCaption(value string) SendDocumentOption

Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing

func WithSendDocumentCaptionEntities

func WithSendDocumentCaptionEntities(value []MessageEntity) SendDocumentOption

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

func WithSendDocumentChatID

func WithSendDocumentChatID(value string) SendDocumentOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendDocumentDirectMessagesTopicID

func WithSendDocumentDirectMessagesTopicID(value int64) SendDocumentOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendDocumentDisableContentTypeDetection

func WithSendDocumentDisableContentTypeDetection(value bool) SendDocumentOption

Disables automatic server-side content type detection for files uploaded using multipart/form-data

func WithSendDocumentDisableNotification

func WithSendDocumentDisableNotification(value bool) SendDocumentOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendDocumentDocument

func WithSendDocumentDocument(value InputFile) SendDocumentOption

File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »

func WithSendDocumentMessageEffectID

func WithSendDocumentMessageEffectID(value string) SendDocumentOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendDocumentMessageThreadID

func WithSendDocumentMessageThreadID(value int64) SendDocumentOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendDocumentParseMode

func WithSendDocumentParseMode(value string) SendDocumentOption

Mode for parsing entities in the document caption. See formatting options for more details.

func WithSendDocumentProtectContent

func WithSendDocumentProtectContent(value bool) SendDocumentOption

Protects the contents of the sent message from forwarding and saving

func WithSendDocumentReplyMarkup

func WithSendDocumentReplyMarkup(value *ReplyMarkup) SendDocumentOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendDocumentReplyParameters

func WithSendDocumentReplyParameters(value *ReplyParameters) SendDocumentOption

Description of the message to reply to

func WithSendDocumentSuggestedPostParameters

func WithSendDocumentSuggestedPostParameters(value *SuggestedPostParameters) SendDocumentOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

func WithSendDocumentThumbnail

func WithSendDocumentThumbnail(value *InputFile) SendDocumentOption

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 »

type SendDocumentParams

type SendDocumentParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// File to send.
	// Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.
	// [More information on Sending Files »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Document InputFile `json:"document"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Thumbnail *InputFile `json:"thumbnail,omitempty"`

	// Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// Mode for parsing entities in the document caption.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
	CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`

	// Disables automatic server-side content type detection for files uploaded using multipart/form-data
	DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendDocumentParams) Option

func (r *SendDocumentParams) Option(opts ...SendDocumentOption) (previous SendDocumentOption)

type SendGameOption

type SendGameOption func(params *SendGameParams) SendGameOption

func WithSendGameAllowPaidBroadcast

func WithSendGameAllowPaidBroadcast(value bool) SendGameOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendGameBusinessConnectionID

func WithSendGameBusinessConnectionID(value string) SendGameOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendGameChatID

func WithSendGameChatID(value int64) SendGameOption

Unique identifier for the target chat. Games can't be sent to channel direct messages chats and channel chats.

func WithSendGameDisableNotification

func WithSendGameDisableNotification(value bool) SendGameOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendGameGameShortName

func WithSendGameGameShortName(value string) SendGameOption

Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.

func WithSendGameMessageEffectID

func WithSendGameMessageEffectID(value string) SendGameOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendGameMessageThreadID

func WithSendGameMessageThreadID(value int64) SendGameOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendGameProtectContent

func WithSendGameProtectContent(value bool) SendGameOption

Protects the contents of the sent message from forwarding and saving

func WithSendGameReplyMarkup

func WithSendGameReplyMarkup(value *InlineKeyboardMarkup) SendGameOption

A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.

func WithSendGameReplyParameters

func WithSendGameReplyParameters(value *ReplyParameters) SendGameOption

Description of the message to reply to

type SendGameParams

type SendGameParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat.
	// Games can't be sent to channel direct messages chats and channel chats.
	ChatID int64 `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Short name of the game, serves as the unique identifier for the game.
	// Set up your games via [@BotFather].
	//
	// [@BotFather]: https://t.me/botfather
	GameShortName string `json:"game_short_name"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// A JSON-serialized object for an [inline keyboard].
	// If empty, one 'Play game_title' button will be shown.
	// If not empty, the first button must launch the game.
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func (*SendGameParams) Option

func (r *SendGameParams) Option(opts ...SendGameOption) (previous SendGameOption)

type SendGiftOption

type SendGiftOption func(params *SendGiftParams) SendGiftOption

func WithSendGiftChatID

func WithSendGiftChatID(value string) SendGiftOption

Required if user_id is not specified. Unique identifier for the chat or username of the channel (in the format @channelusername) that will receive the gift.

func WithSendGiftGiftID

func WithSendGiftGiftID(value string) SendGiftOption

Identifier of the gift; limited gifts can't be sent to channel chats

func WithSendGiftPayForUpgrade

func WithSendGiftPayForUpgrade(value bool) SendGiftOption

Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver

func WithSendGiftText

func WithSendGiftText(value string) SendGiftOption

Text that will be shown along with the gift; 0-128 characters

func WithSendGiftTextEntities

func WithSendGiftTextEntities(value []MessageEntity) SendGiftOption

A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.

func WithSendGiftTextParseMode

func WithSendGiftTextParseMode(value string) SendGiftOption

Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.

func WithSendGiftUserID

func WithSendGiftUserID(value int64) SendGiftOption

Required if chat_id is not specified. Unique identifier of the target user who will receive the gift.

type SendGiftParams

type SendGiftParams struct {
	// Required if chat_id is not specified.
	// Unique identifier of the target user who will receive the gift.
	UserID int64 `json:"user_id,omitempty"`

	// Required if user_id is not specified.
	// Unique identifier for the chat or username of the channel (in the format @channelusername) that will receive the gift.
	ChatID string `json:"chat_id,omitempty"`

	// Identifier of the gift; limited gifts can't be sent to channel chats
	GiftID string `json:"gift_id"`

	// Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver
	PayForUpgrade bool `json:"pay_for_upgrade,omitempty"`

	// Text that will be shown along with the gift; 0-128 characters
	Text string `json:"text,omitempty"`

	// Mode for parsing entities in the text.
	// See [formatting options] for more details.
	// Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	TextParseMode string `json:"text_parse_mode,omitempty"`

	// A JSON-serialized list of special entities that appear in the gift text.
	// It can be specified instead of text_parse_mode.
	// Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.
	TextEntities []MessageEntity `json:"text_entities,omitempty"`
}

func (*SendGiftParams) Option

func (r *SendGiftParams) Option(opts ...SendGiftOption) (previous SendGiftOption)

type SendInvoiceOption

type SendInvoiceOption func(params *SendInvoiceParams) SendInvoiceOption

func WithSendInvoiceAllowPaidBroadcast

func WithSendInvoiceAllowPaidBroadcast(value bool) SendInvoiceOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendInvoiceChatID

func WithSendInvoiceChatID(value string) SendInvoiceOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendInvoiceCurrency

func WithSendInvoiceCurrency(value string) SendInvoiceOption

Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.

func WithSendInvoiceDescription

func WithSendInvoiceDescription(value string) SendInvoiceOption

Product description, 1-255 characters

func WithSendInvoiceDirectMessagesTopicID

func WithSendInvoiceDirectMessagesTopicID(value int64) SendInvoiceOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendInvoiceDisableNotification

func WithSendInvoiceDisableNotification(value bool) SendInvoiceOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendInvoiceIsFlexible

func WithSendInvoiceIsFlexible(value bool) SendInvoiceOption

Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.

func WithSendInvoiceMaxTipAmount

func WithSendInvoiceMaxTipAmount(value int64) SendInvoiceOption

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 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.

func WithSendInvoiceMessageEffectID

func WithSendInvoiceMessageEffectID(value string) SendInvoiceOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendInvoiceMessageThreadID

func WithSendInvoiceMessageThreadID(value int64) SendInvoiceOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendInvoiceNeedEmail

func WithSendInvoiceNeedEmail(value bool) SendInvoiceOption

Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.

func WithSendInvoiceNeedName

func WithSendInvoiceNeedName(value bool) SendInvoiceOption

Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.

func WithSendInvoiceNeedPhoneNumber

func WithSendInvoiceNeedPhoneNumber(value bool) SendInvoiceOption

Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.

func WithSendInvoiceNeedShippingAddress

func WithSendInvoiceNeedShippingAddress(value bool) SendInvoiceOption

Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.

func WithSendInvoicePayload

func WithSendInvoicePayload(value string) SendInvoiceOption

Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.

func WithSendInvoicePhotoHeight

func WithSendInvoicePhotoHeight(value int64) SendInvoiceOption

Photo height

func WithSendInvoicePhotoSize

func WithSendInvoicePhotoSize(value int64) SendInvoiceOption

Photo size in bytes

func WithSendInvoicePhotoUrl

func WithSendInvoicePhotoUrl(value string) SendInvoiceOption

URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.

func WithSendInvoicePhotoWidth

func WithSendInvoicePhotoWidth(value int64) SendInvoiceOption

Photo width

func WithSendInvoicePrices

func WithSendInvoicePrices(value []LabeledPrice) SendInvoiceOption

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.

func WithSendInvoiceProtectContent

func WithSendInvoiceProtectContent(value bool) SendInvoiceOption

Protects the contents of the sent message from forwarding and saving

func WithSendInvoiceProviderData

func WithSendInvoiceProviderData(value string) SendInvoiceOption

JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.

func WithSendInvoiceProviderToken

func WithSendInvoiceProviderToken(value string) SendInvoiceOption

Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.

func WithSendInvoiceReplyMarkup

func WithSendInvoiceReplyMarkup(value *InlineKeyboardMarkup) SendInvoiceOption

A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.

func WithSendInvoiceReplyParameters

func WithSendInvoiceReplyParameters(value *ReplyParameters) SendInvoiceOption

Description of the message to reply to

func WithSendInvoiceSendEmailToProvider

func WithSendInvoiceSendEmailToProvider(value bool) SendInvoiceOption

Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.

func WithSendInvoiceSendPhoneNumberToProvider

func WithSendInvoiceSendPhoneNumberToProvider(value bool) SendInvoiceOption

Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.

func WithSendInvoiceStartParameter

func WithSendInvoiceStartParameter(value string) SendInvoiceOption

Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter

func WithSendInvoiceSuggestedPostParameters

func WithSendInvoiceSuggestedPostParameters(value *SuggestedPostParameters) SendInvoiceOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

func WithSendInvoiceSuggestedTipAmounts

func WithSendInvoiceSuggestedTipAmounts(value []int64) SendInvoiceOption

A JSON-serialized array of suggested amounts of tips 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.

func WithSendInvoiceTitle

func WithSendInvoiceTitle(value string) SendInvoiceOption

Product name, 1-32 characters

type SendInvoiceParams

type SendInvoiceParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// 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"`

	// Payment provider token, obtained via [@BotFather].
	// Pass an empty string for payments in [Telegram Stars].
	//
	// [@BotFather]: https://t.me/botfather
	// [Telegram Stars]: https://t.me/BotNews/90
	ProviderToken string `json:"provider_token,omitempty"`

	// Three-letter ISO 4217 currency code, see [more on currencies].
	// Pass “XTR” for payments in [Telegram Stars].
	//
	// [more on currencies]: https://core.telegram.org/bots/payments#supported-currencies
	// [Telegram Stars]: https://t.me/BotNews/90
	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].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	Prices []LabeledPrice `json:"prices"`

	// 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 [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].
	//
	// [currencies.json]: https://core.telegram.org/bots/payments/currencies.json
	// [Telegram Stars]: https://t.me/BotNews/90
	MaxTipAmount int64 `json:"max_tip_amount,omitempty"`

	// A JSON-serialized array of suggested amounts of tips 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 []int64 `json:"suggested_tip_amounts,omitempty"`

	// Unique deep-linking parameter.
	// If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice.
	// If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter
	StartParameter string `json:"start_parameter,omitempty"`

	// JSON-serialized data about the invoice, which will be shared with the payment provider.
	// A detailed description of required fields should be provided by the payment provider.
	ProviderData string `json:"provider_data,omitempty"`

	// URL of the product photo for the invoice.
	// Can be a photo of the goods or a marketing image for a service.
	// People like it better when they see what they are paying for.
	PhotoUrl string `json:"photo_url,omitempty"`

	// Photo size in bytes
	PhotoSize int64 `json:"photo_size,omitempty"`

	// Photo width
	PhotoWidth int64 `json:"photo_width,omitempty"`

	// Photo height
	PhotoHeight int64 `json:"photo_height,omitempty"`

	// Pass True if you require the user's full name to complete the order.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	NeedName bool `json:"need_name,omitempty"`

	// Pass True if you require the user's phone number to complete the order.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	NeedPhoneNumber bool `json:"need_phone_number,omitempty"`

	// Pass True if you require the user's email address to complete the order.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	NeedEmail bool `json:"need_email,omitempty"`

	// Pass True if you require the user's shipping address to complete the order.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	NeedShippingAddress bool `json:"need_shipping_address,omitempty"`

	// Pass True if the user's phone number should be sent to the provider.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	SendPhoneNumberToProvider bool `json:"send_phone_number_to_provider,omitempty"`

	// Pass True if the user's email address should be sent to the provider.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	SendEmailToProvider bool `json:"send_email_to_provider,omitempty"`

	// Pass True if the final price depends on the shipping method.
	// Ignored for payments in [Telegram Stars].
	//
	// [Telegram Stars]: https://t.me/BotNews/90
	IsFlexible bool `json:"is_flexible,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// A JSON-serialized object for an [inline keyboard].
	// If empty, one 'Pay total price' button will be shown.
	// If not empty, the first button must be a Pay button.
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func (*SendInvoiceParams) Option

func (r *SendInvoiceParams) Option(opts ...SendInvoiceOption) (previous SendInvoiceOption)

type SendLocationOption

type SendLocationOption func(params *SendLocationParams) SendLocationOption

func WithSendLocationAllowPaidBroadcast

func WithSendLocationAllowPaidBroadcast(value bool) SendLocationOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendLocationBusinessConnectionID

func WithSendLocationBusinessConnectionID(value string) SendLocationOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendLocationChatID

func WithSendLocationChatID(value string) SendLocationOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendLocationDirectMessagesTopicID

func WithSendLocationDirectMessagesTopicID(value int64) SendLocationOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendLocationDisableNotification

func WithSendLocationDisableNotification(value bool) SendLocationOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendLocationHeading

func WithSendLocationHeading(value int64) SendLocationOption

For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

func WithSendLocationHorizontalAccuracy

func WithSendLocationHorizontalAccuracy(value float64) SendLocationOption

The radius of uncertainty for the location, measured in meters; 0-1500

func WithSendLocationLatitude

func WithSendLocationLatitude(value float64) SendLocationOption

Latitude of the location

func WithSendLocationLivePeriod

func WithSendLocationLivePeriod(value int64) SendLocationOption

Period in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.

func WithSendLocationLongitude

func WithSendLocationLongitude(value float64) SendLocationOption

Longitude of the location

func WithSendLocationMessageEffectID

func WithSendLocationMessageEffectID(value string) SendLocationOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendLocationMessageThreadID

func WithSendLocationMessageThreadID(value int64) SendLocationOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendLocationProtectContent

func WithSendLocationProtectContent(value bool) SendLocationOption

Protects the contents of the sent message from forwarding and saving

func WithSendLocationProximityAlertRadius

func WithSendLocationProximityAlertRadius(value int64) SendLocationOption

For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

func WithSendLocationReplyMarkup

func WithSendLocationReplyMarkup(value *ReplyMarkup) SendLocationOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendLocationReplyParameters

func WithSendLocationReplyParameters(value *ReplyParameters) SendLocationOption

Description of the message to reply to

func WithSendLocationSuggestedPostParameters

func WithSendLocationSuggestedPostParameters(value *SuggestedPostParameters) SendLocationOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

type SendLocationParams

type SendLocationParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Latitude of the location
	Latitude float64 `json:"latitude"`

	// Longitude of the location
	Longitude float64 `json:"longitude"`

	// The radius of uncertainty for the location, measured in meters; 0-1500
	HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`

	// Period in seconds during which the location will be updated (see [Live Locations], should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.
	//
	// [Live Locations]: https://telegram.org/blog/live-locations
	LivePeriod int64 `json:"live_period,omitempty"`

	// For live locations, a direction in which the user is moving, in degrees.
	// Must be between 1 and 360 if specified.
	Heading int64 `json:"heading,omitempty"`

	// 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 int64 `json:"proximity_alert_radius,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendLocationParams) Option

func (r *SendLocationParams) Option(opts ...SendLocationOption) (previous SendLocationOption)

type SendMediaGroupOption

type SendMediaGroupOption func(params *SendMediaGroupParams) SendMediaGroupOption

func WithSendMediaGroupAllowPaidBroadcast

func WithSendMediaGroupAllowPaidBroadcast(value bool) SendMediaGroupOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendMediaGroupBusinessConnectionID

func WithSendMediaGroupBusinessConnectionID(value string) SendMediaGroupOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendMediaGroupChatID

func WithSendMediaGroupChatID(value string) SendMediaGroupOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendMediaGroupDirectMessagesTopicID

func WithSendMediaGroupDirectMessagesTopicID(value int64) SendMediaGroupOption

Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat

func WithSendMediaGroupDisableNotification

func WithSendMediaGroupDisableNotification(value bool) SendMediaGroupOption

Sends messages silently. Users will receive a notification with no sound.

func WithSendMediaGroupMedia

func WithSendMediaGroupMedia(value []InputMedia) SendMediaGroupOption

A JSON-serialized array describing messages to be sent, must include 2-10 items

func WithSendMediaGroupMessageEffectID

func WithSendMediaGroupMessageEffectID(value string) SendMediaGroupOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendMediaGroupMessageThreadID

func WithSendMediaGroupMessageThreadID(value int64) SendMediaGroupOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendMediaGroupProtectContent

func WithSendMediaGroupProtectContent(value bool) SendMediaGroupOption

Protects the contents of the sent messages from forwarding and saving

func WithSendMediaGroupReplyParameters

func WithSendMediaGroupReplyParameters(value *ReplyParameters) SendMediaGroupOption

Description of the message to reply to

type SendMediaGroupParams

type SendMediaGroupParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// A JSON-serialized array describing messages to be sent, must include 2-10 items
	Media []InputMedia `json:"media"`

	// Sends messages [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent messages from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
}

func (*SendMediaGroupParams) Option

func (r *SendMediaGroupParams) Option(opts ...SendMediaGroupOption) (previous SendMediaGroupOption)

type SendMessageDraftOption

type SendMessageDraftOption func(params *SendMessageDraftParams) SendMessageDraftOption

func WithSendMessageDraftChatID

func WithSendMessageDraftChatID(value int64) SendMessageDraftOption

Unique identifier for the target private chat

func WithSendMessageDraftDraftID

func WithSendMessageDraftDraftID(value int64) SendMessageDraftOption

Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated

func WithSendMessageDraftEntities

func WithSendMessageDraftEntities(value []MessageEntity) SendMessageDraftOption

A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode

func WithSendMessageDraftMessageThreadID

func WithSendMessageDraftMessageThreadID(value int64) SendMessageDraftOption

Unique identifier for the target message thread

func WithSendMessageDraftParseMode

func WithSendMessageDraftParseMode(value string) SendMessageDraftOption

Mode for parsing entities in the message text. See formatting options for more details.

func WithSendMessageDraftText

func WithSendMessageDraftText(value string) SendMessageDraftOption

Text of the message to be sent, 1-4096 characters after entities parsing

type SendMessageDraftParams

type SendMessageDraftParams struct {
	// Unique identifier for the target private chat
	ChatID int64 `json:"chat_id"`

	// Unique identifier for the target message thread
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Unique identifier of the message draft; must be non-zero.
	// Changes of drafts with the same identifier are animated
	DraftID int64 `json:"draft_id"`

	// Text of the message to be sent, 1-4096 characters after entities parsing
	Text string `json:"text"`

	// Mode for parsing entities in the message text.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
	Entities []MessageEntity `json:"entities,omitempty"`
}

func (*SendMessageDraftParams) Option

type SendMessageOption

type SendMessageOption func(params *SendMessageParams) SendMessageOption

func WithSendMessageAllowPaidBroadcast

func WithSendMessageAllowPaidBroadcast(value bool) SendMessageOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendMessageBusinessConnectionID

func WithSendMessageBusinessConnectionID(value string) SendMessageOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendMessageChatID

func WithSendMessageChatID(value string) SendMessageOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendMessageDirectMessagesTopicID

func WithSendMessageDirectMessagesTopicID(value int64) SendMessageOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendMessageDisableNotification

func WithSendMessageDisableNotification(value bool) SendMessageOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendMessageEntities

func WithSendMessageEntities(value []MessageEntity) SendMessageOption

A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode

func WithSendMessageInlineButtons

func WithSendMessageInlineButtons(buttons ...InlineKeyboardButton) SendMessageOption

WithSendMessageInlineButtons helps add bunch of buttons in one column.

func WithSendMessageInlineKeyboard

func WithSendMessageInlineKeyboard(keyboard [][]InlineKeyboardButton) SendMessageOption

WithSendMessageInlineKeyboard helps add keyboard to ReplyMarkup.

func WithSendMessageLinkPreviewOptions

func WithSendMessageLinkPreviewOptions(value *LinkPreviewOptions) SendMessageOption

Link preview generation options for the message

func WithSendMessageMessageEffectID

func WithSendMessageMessageEffectID(value string) SendMessageOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendMessageMessageThreadID

func WithSendMessageMessageThreadID(value int64) SendMessageOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendMessageParseMode

func WithSendMessageParseMode(value string) SendMessageOption

Mode for parsing entities in the message text. See formatting options for more details.

func WithSendMessageProtectContent

func WithSendMessageProtectContent(value bool) SendMessageOption

Protects the contents of the sent message from forwarding and saving

func WithSendMessageReplyMarkup

func WithSendMessageReplyMarkup(value *ReplyMarkup) SendMessageOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendMessageReplyParameters

func WithSendMessageReplyParameters(value *ReplyParameters) SendMessageOption

Description of the message to reply to

func WithSendMessageSuggestedPostParameters

func WithSendMessageSuggestedPostParameters(value *SuggestedPostParameters) SendMessageOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

func WithSendMessageText

func WithSendMessageText(value string) SendMessageOption

Text of the message to be sent, 1-4096 characters after entities parsing

type SendMessageParams

type SendMessageParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Text of the message to be sent, 1-4096 characters after entities parsing
	Text string `json:"text"`

	// Mode for parsing entities in the message text.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
	Entities []MessageEntity `json:"entities,omitempty"`

	// Link preview generation options for the message
	LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendMessageParams) Option

func (r *SendMessageParams) Option(opts ...SendMessageOption) (previous SendMessageOption)

type SendPaidMediaOption

type SendPaidMediaOption func(params *SendPaidMediaParams) SendPaidMediaOption

func WithSendPaidMediaAllowPaidBroadcast

func WithSendPaidMediaAllowPaidBroadcast(value bool) SendPaidMediaOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendPaidMediaBusinessConnectionID

func WithSendPaidMediaBusinessConnectionID(value string) SendPaidMediaOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendPaidMediaCaption

func WithSendPaidMediaCaption(value string) SendPaidMediaOption

Media caption, 0-1024 characters after entities parsing

func WithSendPaidMediaCaptionEntities

func WithSendPaidMediaCaptionEntities(value []MessageEntity) SendPaidMediaOption

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

func WithSendPaidMediaChatID

func WithSendPaidMediaChatID(value string) SendPaidMediaOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.

func WithSendPaidMediaDirectMessagesTopicID

func WithSendPaidMediaDirectMessagesTopicID(value int64) SendPaidMediaOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendPaidMediaDisableNotification

func WithSendPaidMediaDisableNotification(value bool) SendPaidMediaOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendPaidMediaMedia

func WithSendPaidMediaMedia(value []InputPaidMedia) SendPaidMediaOption

A JSON-serialized array describing the media to be sent; up to 10 items

func WithSendPaidMediaMessageThreadID

func WithSendPaidMediaMessageThreadID(value int64) SendPaidMediaOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendPaidMediaParseMode

func WithSendPaidMediaParseMode(value string) SendPaidMediaOption

Mode for parsing entities in the media caption. See formatting options for more details.

func WithSendPaidMediaPayload

func WithSendPaidMediaPayload(value string) SendPaidMediaOption

Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.

func WithSendPaidMediaProtectContent

func WithSendPaidMediaProtectContent(value bool) SendPaidMediaOption

Protects the contents of the sent message from forwarding and saving

func WithSendPaidMediaReplyMarkup

func WithSendPaidMediaReplyMarkup(value *ReplyMarkup) SendPaidMediaOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendPaidMediaReplyParameters

func WithSendPaidMediaReplyParameters(value *ReplyParameters) SendPaidMediaOption

Description of the message to reply to

func WithSendPaidMediaShowCaptionAboveMedia

func WithSendPaidMediaShowCaptionAboveMedia(value bool) SendPaidMediaOption

Pass True, if the caption must be shown above the message media

func WithSendPaidMediaStarCount

func WithSendPaidMediaStarCount(value int64) SendPaidMediaOption

The number of Telegram Stars that must be paid to buy access to the media; 1-25000

func WithSendPaidMediaSuggestedPostParameters

func WithSendPaidMediaSuggestedPostParameters(value *SuggestedPostParameters) SendPaidMediaOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

type SendPaidMediaParams

type SendPaidMediaParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername).
	// If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance.
	// Otherwise, they will be credited to the bot's balance.
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// The number of Telegram Stars that must be paid to buy access to the media; 1-25000
	StarCount int64 `json:"star_count"`

	// A JSON-serialized array describing the media to be sent; up to 10 items
	Media []InputPaidMedia `json:"media"`

	// Bot-defined paid media payload, 0-128 bytes.
	// This will not be displayed to the user, use it for your internal processes.
	Payload string `json:"payload,omitempty"`

	// Media caption, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// Mode for parsing entities in the media caption.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized 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"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendPaidMediaParams) Option

func (r *SendPaidMediaParams) Option(opts ...SendPaidMediaOption) (previous SendPaidMediaOption)

type SendPhotoOption

type SendPhotoOption func(params *SendPhotoParams) SendPhotoOption

func WithSendPhotoAllowPaidBroadcast

func WithSendPhotoAllowPaidBroadcast(value bool) SendPhotoOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendPhotoBusinessConnectionID

func WithSendPhotoBusinessConnectionID(value string) SendPhotoOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendPhotoCaption

func WithSendPhotoCaption(value string) SendPhotoOption

Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing

func WithSendPhotoCaptionEntities

func WithSendPhotoCaptionEntities(value []MessageEntity) SendPhotoOption

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

func WithSendPhotoChatID

func WithSendPhotoChatID(value string) SendPhotoOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendPhotoDirectMessagesTopicID

func WithSendPhotoDirectMessagesTopicID(value int64) SendPhotoOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendPhotoDisableNotification

func WithSendPhotoDisableNotification(value bool) SendPhotoOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendPhotoHasSpoiler

func WithSendPhotoHasSpoiler(value bool) SendPhotoOption

Pass True if the photo needs to be covered with a spoiler animation

func WithSendPhotoMessageEffectID

func WithSendPhotoMessageEffectID(value string) SendPhotoOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendPhotoMessageThreadID

func WithSendPhotoMessageThreadID(value int64) SendPhotoOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendPhotoParseMode

func WithSendPhotoParseMode(value string) SendPhotoOption

Mode for parsing entities in the photo caption. See formatting options for more details.

func WithSendPhotoPhoto

func WithSendPhotoPhoto(value InputFile) SendPhotoOption

Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files »

func WithSendPhotoProtectContent

func WithSendPhotoProtectContent(value bool) SendPhotoOption

Protects the contents of the sent message from forwarding and saving

func WithSendPhotoReplyMarkup

func WithSendPhotoReplyMarkup(value *ReplyMarkup) SendPhotoOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendPhotoReplyParameters

func WithSendPhotoReplyParameters(value *ReplyParameters) SendPhotoOption

Description of the message to reply to

func WithSendPhotoShowCaptionAboveMedia

func WithSendPhotoShowCaptionAboveMedia(value bool) SendPhotoOption

Pass True, if the caption must be shown above the message media

func WithSendPhotoSuggestedPostParameters

func WithSendPhotoSuggestedPostParameters(value *SuggestedPostParameters) SendPhotoOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

type SendPhotoParams

type SendPhotoParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Photo to send.
	// Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data.
	// The photo must be at most 10 MB in size.
	// The photo's width and height must not exceed 10000 in total.
	// Width and height ratio must be at most 20.
	// [More information on Sending Files »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Photo InputFile `json:"photo"`

	// Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// Mode for parsing entities in the photo caption.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized 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"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendPhotoParams) Option

func (r *SendPhotoParams) Option(opts ...SendPhotoOption) (previous SendPhotoOption)

type SendPollOption

type SendPollOption func(params *SendPollParams) SendPollOption

func WithSendPollAllowPaidBroadcast

func WithSendPollAllowPaidBroadcast(value bool) SendPollOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendPollAllowsMultipleAnswers

func WithSendPollAllowsMultipleAnswers(value bool) SendPollOption

True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False

func WithSendPollBusinessConnectionID

func WithSendPollBusinessConnectionID(value string) SendPollOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendPollChatID

func WithSendPollChatID(value string) SendPollOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername). Polls can't be sent to channel direct messages chats.

func WithSendPollCloseDate

func WithSendPollCloseDate(value int64) SendPollOption

Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period.

func WithSendPollCorrectOptionID

func WithSendPollCorrectOptionID(value int64) SendPollOption

0-based identifier of the correct answer option, required for polls in quiz mode

func WithSendPollDisableNotification

func WithSendPollDisableNotification(value bool) SendPollOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendPollExplanation

func WithSendPollExplanation(value string) SendPollOption

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 with at most 2 line feeds after entities parsing

func WithSendPollExplanationEntities

func WithSendPollExplanationEntities(value []MessageEntity) SendPollOption

A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode

func WithSendPollExplanationParseMode

func WithSendPollExplanationParseMode(value string) SendPollOption

Mode for parsing entities in the explanation. See formatting options for more details.

func WithSendPollIsAnonymous

func WithSendPollIsAnonymous(value bool) SendPollOption

True, if the poll needs to be anonymous, defaults to True

func WithSendPollIsClosed

func WithSendPollIsClosed(value bool) SendPollOption

Pass True if the poll needs to be immediately closed. This can be useful for poll preview.

func WithSendPollMessageEffectID

func WithSendPollMessageEffectID(value string) SendPollOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendPollMessageThreadID

func WithSendPollMessageThreadID(value int64) SendPollOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendPollOpenPeriod

func WithSendPollOpenPeriod(value int64) SendPollOption

Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.

func WithSendPollOptions

func WithSendPollOptions(value []InputPollOption) SendPollOption

A JSON-serialized list of 2-12 answer options

func WithSendPollProtectContent

func WithSendPollProtectContent(value bool) SendPollOption

Protects the contents of the sent message from forwarding and saving

func WithSendPollQuestion

func WithSendPollQuestion(value string) SendPollOption

Poll question, 1-300 characters

func WithSendPollQuestionEntities

func WithSendPollQuestionEntities(value []MessageEntity) SendPollOption

A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode

func WithSendPollQuestionParseMode

func WithSendPollQuestionParseMode(value string) SendPollOption

Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed

func WithSendPollReplyMarkup

func WithSendPollReplyMarkup(value *ReplyMarkup) SendPollOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendPollReplyParameters

func WithSendPollReplyParameters(value *ReplyParameters) SendPollOption

Description of the message to reply to

func WithSendPollType

func WithSendPollType(value string) SendPollOption

Poll type, “quiz” or “regular”, defaults to “regular”

type SendPollParams

type SendPollParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername).
	// Polls can't be sent to channel direct messages chats.
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Poll question, 1-300 characters
	Question string `json:"question"`

	// Mode for parsing entities in the question.
	// See [formatting options] for more details.
	// Currently, only custom emoji entities are allowed
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	QuestionParseMode string `json:"question_parse_mode,omitempty"`

	// A JSON-serialized list of special entities that appear in the poll question.
	// It can be specified instead of question_parse_mode
	QuestionEntities []MessageEntity `json:"question_entities,omitempty"`

	// A JSON-serialized list of 2-12 answer options
	Options []InputPollOption `json:"options"`

	// True, if the poll needs to be anonymous, defaults to True
	IsAnonymous bool `json:"is_anonymous,omitempty"`

	// Poll type, “quiz” or “regular”, defaults to “regular”
	Type string `json:"type,omitempty"`

	// True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False
	AllowsMultipleAnswers bool `json:"allows_multiple_answers,omitempty"`

	// 0-based identifier of the correct answer option, required for polls in quiz mode
	CorrectOptionID int64 `json:"correct_option_id,omitempty"`

	// 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 with at most 2 line feeds after entities parsing
	Explanation string `json:"explanation,omitempty"`

	// Mode for parsing entities in the explanation.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ExplanationParseMode string `json:"explanation_parse_mode,omitempty"`

	// A JSON-serialized list of special entities that appear in the poll explanation.
	// It can be specified instead of explanation_parse_mode
	ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"`

	// Amount of time in seconds the poll will be active after creation, 5-600.
	// Can't be used together with close_date.
	OpenPeriod int64 `json:"open_period,omitempty"`

	// Point in time (Unix timestamp) when the poll will be automatically closed.
	// Must be at least 5 and no more than 600 seconds in the future.
	// Can't be used together with open_period.
	CloseDate int64 `json:"close_date,omitempty"`

	// Pass True if the poll needs to be immediately closed.
	// This can be useful for poll preview.
	IsClosed bool `json:"is_closed,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendPollParams) Option

func (r *SendPollParams) Option(opts ...SendPollOption) (previous SendPollOption)

type SendStickerOption

type SendStickerOption func(params *SendStickerParams) SendStickerOption

func WithSendStickerAllowPaidBroadcast

func WithSendStickerAllowPaidBroadcast(value bool) SendStickerOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendStickerBusinessConnectionID

func WithSendStickerBusinessConnectionID(value string) SendStickerOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendStickerChatID

func WithSendStickerChatID(value string) SendStickerOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendStickerDirectMessagesTopicID

func WithSendStickerDirectMessagesTopicID(value int64) SendStickerOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendStickerDisableNotification

func WithSendStickerDisableNotification(value bool) SendStickerOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendStickerEmoji

func WithSendStickerEmoji(value string) SendStickerOption

Emoji associated with the sticker; only for just uploaded stickers

func WithSendStickerMessageEffectID

func WithSendStickerMessageEffectID(value string) SendStickerOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendStickerMessageThreadID

func WithSendStickerMessageThreadID(value int64) SendStickerOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendStickerProtectContent

func WithSendStickerProtectContent(value bool) SendStickerOption

Protects the contents of the sent message from forwarding and saving

func WithSendStickerReplyMarkup

func WithSendStickerReplyMarkup(value *ReplyMarkup) SendStickerOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendStickerReplyParameters

func WithSendStickerReplyParameters(value *ReplyParameters) SendStickerOption

Description of the message to reply to

func WithSendStickerSticker

func WithSendStickerSticker(value InputFile) SendStickerOption

Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. More information on Sending Files ». Video and animated stickers can't be sent via an HTTP URL.

func WithSendStickerSuggestedPostParameters

func WithSendStickerSuggestedPostParameters(value *SuggestedPostParameters) SendStickerOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

type SendStickerParams

type SendStickerParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Sticker to send.
	// Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data.
	// [More information on Sending Files »].
	// Video and animated stickers can't be sent via an HTTP URL.
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Sticker InputFile `json:"sticker"`

	// Emoji associated with the sticker; only for just uploaded stickers
	Emoji string `json:"emoji,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendStickerParams) Option

func (r *SendStickerParams) Option(opts ...SendStickerOption) (previous SendStickerOption)

type SendVenueOption

type SendVenueOption func(params *SendVenueParams) SendVenueOption

func WithSendVenueAddress

func WithSendVenueAddress(value string) SendVenueOption

Address of the venue

func WithSendVenueAllowPaidBroadcast

func WithSendVenueAllowPaidBroadcast(value bool) SendVenueOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendVenueBusinessConnectionID

func WithSendVenueBusinessConnectionID(value string) SendVenueOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendVenueChatID

func WithSendVenueChatID(value string) SendVenueOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendVenueDirectMessagesTopicID

func WithSendVenueDirectMessagesTopicID(value int64) SendVenueOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendVenueDisableNotification

func WithSendVenueDisableNotification(value bool) SendVenueOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendVenueFoursquareID

func WithSendVenueFoursquareID(value string) SendVenueOption

Foursquare identifier of the venue

func WithSendVenueFoursquareType

func WithSendVenueFoursquareType(value string) SendVenueOption

Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

func WithSendVenueGooglePlaceID

func WithSendVenueGooglePlaceID(value string) SendVenueOption

Google Places identifier of the venue

func WithSendVenueGooglePlaceType

func WithSendVenueGooglePlaceType(value string) SendVenueOption

Google Places type of the venue. (See supported types.)

func WithSendVenueLatitude

func WithSendVenueLatitude(value float64) SendVenueOption

Latitude of the venue

func WithSendVenueLongitude

func WithSendVenueLongitude(value float64) SendVenueOption

Longitude of the venue

func WithSendVenueMessageEffectID

func WithSendVenueMessageEffectID(value string) SendVenueOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendVenueMessageThreadID

func WithSendVenueMessageThreadID(value int64) SendVenueOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendVenueProtectContent

func WithSendVenueProtectContent(value bool) SendVenueOption

Protects the contents of the sent message from forwarding and saving

func WithSendVenueReplyMarkup

func WithSendVenueReplyMarkup(value *ReplyMarkup) SendVenueOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendVenueReplyParameters

func WithSendVenueReplyParameters(value *ReplyParameters) SendVenueOption

Description of the message to reply to

func WithSendVenueSuggestedPostParameters

func WithSendVenueSuggestedPostParameters(value *SuggestedPostParameters) SendVenueOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

func WithSendVenueTitle

func WithSendVenueTitle(value string) SendVenueOption

Name of the venue

type SendVenueParams

type SendVenueParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Latitude of the venue
	Latitude float64 `json:"latitude"`

	// Longitude of the venue
	Longitude float64 `json:"longitude"`

	// Name of the venue
	Title string `json:"title"`

	// Address of the venue
	Address string `json:"address"`

	// Foursquare identifier of the venue
	FoursquareID string `json:"foursquare_id,omitempty"`

	// Foursquare type of the venue, if known.
	// (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
	FoursquareType string `json:"foursquare_type,omitempty"`

	// Google Places identifier of the venue
	GooglePlaceID string `json:"google_place_id,omitempty"`

	// Google Places type of the venue.
	// (See [supported types].)
	//
	// [supported types]: https://developers.google.com/places/web-service/supported_types
	GooglePlaceType string `json:"google_place_type,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendVenueParams) Option

func (r *SendVenueParams) Option(opts ...SendVenueOption) (previous SendVenueOption)

type SendVideoNoteOption

type SendVideoNoteOption func(params *SendVideoNoteParams) SendVideoNoteOption

func WithSendVideoNoteAllowPaidBroadcast

func WithSendVideoNoteAllowPaidBroadcast(value bool) SendVideoNoteOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendVideoNoteBusinessConnectionID

func WithSendVideoNoteBusinessConnectionID(value string) SendVideoNoteOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendVideoNoteChatID

func WithSendVideoNoteChatID(value string) SendVideoNoteOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendVideoNoteDirectMessagesTopicID

func WithSendVideoNoteDirectMessagesTopicID(value int64) SendVideoNoteOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendVideoNoteDisableNotification

func WithSendVideoNoteDisableNotification(value bool) SendVideoNoteOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendVideoNoteDuration

func WithSendVideoNoteDuration(value int64) SendVideoNoteOption

Duration of sent video in seconds

func WithSendVideoNoteLength

func WithSendVideoNoteLength(value int64) SendVideoNoteOption

Video width and height, i.e. diameter of the video message

func WithSendVideoNoteMessageEffectID

func WithSendVideoNoteMessageEffectID(value string) SendVideoNoteOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendVideoNoteMessageThreadID

func WithSendVideoNoteMessageThreadID(value int64) SendVideoNoteOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendVideoNoteProtectContent

func WithSendVideoNoteProtectContent(value bool) SendVideoNoteOption

Protects the contents of the sent message from forwarding and saving

func WithSendVideoNoteReplyMarkup

func WithSendVideoNoteReplyMarkup(value *ReplyMarkup) SendVideoNoteOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendVideoNoteReplyParameters

func WithSendVideoNoteReplyParameters(value *ReplyParameters) SendVideoNoteOption

Description of the message to reply to

func WithSendVideoNoteSuggestedPostParameters

func WithSendVideoNoteSuggestedPostParameters(value *SuggestedPostParameters) SendVideoNoteOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

func WithSendVideoNoteThumbnail

func WithSendVideoNoteThumbnail(value *InputFile) SendVideoNoteOption

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 »

func WithSendVideoNoteVideoNote

func WithSendVideoNoteVideoNote(value InputFile) SendVideoNoteOption

Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending video notes by a URL is currently unsupported

type SendVideoNoteParams

type SendVideoNoteParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Video note to send.
	// Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data.
	// [More information on Sending Files »].
	// Sending video notes by a URL is currently unsupported
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	VideoNote InputFile `json:"video_note"`

	// Duration of sent video in seconds
	Duration int64 `json:"duration,omitempty"`

	// Video width and height, i.e.
	// diameter of the video message
	Length int64 `json:"length,omitempty"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Thumbnail *InputFile `json:"thumbnail,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendVideoNoteParams) Option

func (r *SendVideoNoteParams) Option(opts ...SendVideoNoteOption) (previous SendVideoNoteOption)

type SendVideoOption

type SendVideoOption func(params *SendVideoParams) SendVideoOption

func WithSendVideoAllowPaidBroadcast

func WithSendVideoAllowPaidBroadcast(value bool) SendVideoOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendVideoBusinessConnectionID

func WithSendVideoBusinessConnectionID(value string) SendVideoOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendVideoCaption

func WithSendVideoCaption(value string) SendVideoOption

Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing

func WithSendVideoCaptionEntities

func WithSendVideoCaptionEntities(value []MessageEntity) SendVideoOption

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

func WithSendVideoChatID

func WithSendVideoChatID(value string) SendVideoOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendVideoCover

func WithSendVideoCover(value *InputFile) SendVideoOption

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 »

func WithSendVideoDirectMessagesTopicID

func WithSendVideoDirectMessagesTopicID(value int64) SendVideoOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendVideoDisableNotification

func WithSendVideoDisableNotification(value bool) SendVideoOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendVideoDuration

func WithSendVideoDuration(value int64) SendVideoOption

Duration of sent video in seconds

func WithSendVideoHasSpoiler

func WithSendVideoHasSpoiler(value bool) SendVideoOption

Pass True if the video needs to be covered with a spoiler animation

func WithSendVideoHeight

func WithSendVideoHeight(value int64) SendVideoOption

Video height

func WithSendVideoMessageEffectID

func WithSendVideoMessageEffectID(value string) SendVideoOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendVideoMessageThreadID

func WithSendVideoMessageThreadID(value int64) SendVideoOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendVideoParseMode

func WithSendVideoParseMode(value string) SendVideoOption

Mode for parsing entities in the video caption. See formatting options for more details.

func WithSendVideoProtectContent

func WithSendVideoProtectContent(value bool) SendVideoOption

Protects the contents of the sent message from forwarding and saving

func WithSendVideoReplyMarkup

func WithSendVideoReplyMarkup(value *ReplyMarkup) SendVideoOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendVideoReplyParameters

func WithSendVideoReplyParameters(value *ReplyParameters) SendVideoOption

Description of the message to reply to

func WithSendVideoShowCaptionAboveMedia

func WithSendVideoShowCaptionAboveMedia(value bool) SendVideoOption

Pass True, if the caption must be shown above the message media

func WithSendVideoStartTimestamp

func WithSendVideoStartTimestamp(value int64) SendVideoOption

Start timestamp for the video in the message

func WithSendVideoSuggestedPostParameters

func WithSendVideoSuggestedPostParameters(value *SuggestedPostParameters) SendVideoOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

func WithSendVideoSupportsStreaming

func WithSendVideoSupportsStreaming(value bool) SendVideoOption

Pass True if the uploaded video is suitable for streaming

func WithSendVideoThumbnail

func WithSendVideoThumbnail(value *InputFile) SendVideoOption

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 »

func WithSendVideoVideo

func WithSendVideoVideo(value InputFile) SendVideoOption

Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files »

func WithSendVideoWidth

func WithSendVideoWidth(value int64) SendVideoOption

Video width

type SendVideoParams

type SendVideoParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Video to send.
	// Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data.
	// [More information on Sending Files »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Video InputFile `json:"video"`

	// Duration of sent video in seconds
	Duration int64 `json:"duration,omitempty"`

	// Video width
	Width int64 `json:"width,omitempty"`

	// Video height
	Height int64 `json:"height,omitempty"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Thumbnail *InputFile `json:"thumbnail,omitempty"`

	// 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 »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Cover *InputFile `json:"cover,omitempty"`

	// Start timestamp for the video in the message
	StartTimestamp int64 `json:"start_timestamp,omitempty"`

	// Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// Mode for parsing entities in the video caption.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized 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 video needs to be covered with a spoiler animation
	HasSpoiler bool `json:"has_spoiler,omitempty"`

	// Pass True if the uploaded video is suitable for streaming
	SupportsStreaming bool `json:"supports_streaming,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendVideoParams) Option

func (r *SendVideoParams) Option(opts ...SendVideoOption) (previous SendVideoOption)

type SendVoiceOption

type SendVoiceOption func(params *SendVoiceParams) SendVoiceOption

func WithSendVoiceAllowPaidBroadcast

func WithSendVoiceAllowPaidBroadcast(value bool) SendVoiceOption

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

func WithSendVoiceBusinessConnectionID

func WithSendVoiceBusinessConnectionID(value string) SendVoiceOption

Unique identifier of the business connection on behalf of which the message will be sent

func WithSendVoiceCaption

func WithSendVoiceCaption(value string) SendVoiceOption

Voice message caption, 0-1024 characters after entities parsing

func WithSendVoiceCaptionEntities

func WithSendVoiceCaptionEntities(value []MessageEntity) SendVoiceOption

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

func WithSendVoiceChatID

func WithSendVoiceChatID(value string) SendVoiceOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSendVoiceDirectMessagesTopicID

func WithSendVoiceDirectMessagesTopicID(value int64) SendVoiceOption

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

func WithSendVoiceDisableNotification

func WithSendVoiceDisableNotification(value bool) SendVoiceOption

Sends the message silently. Users will receive a notification with no sound.

func WithSendVoiceDuration

func WithSendVoiceDuration(value int64) SendVoiceOption

Duration of the voice message in seconds

func WithSendVoiceMessageEffectID

func WithSendVoiceMessageEffectID(value string) SendVoiceOption

Unique identifier of the message effect to be added to the message; for private chats only

func WithSendVoiceMessageThreadID

func WithSendVoiceMessageThreadID(value int64) SendVoiceOption

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

func WithSendVoiceParseMode

func WithSendVoiceParseMode(value string) SendVoiceOption

Mode for parsing entities in the voice message caption. See formatting options for more details.

func WithSendVoiceProtectContent

func WithSendVoiceProtectContent(value bool) SendVoiceOption

Protects the contents of the sent message from forwarding and saving

func WithSendVoiceReplyMarkup

func WithSendVoiceReplyMarkup(value *ReplyMarkup) SendVoiceOption

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user

func WithSendVoiceReplyParameters

func WithSendVoiceReplyParameters(value *ReplyParameters) SendVoiceOption

Description of the message to reply to

func WithSendVoiceSuggestedPostParameters

func WithSendVoiceSuggestedPostParameters(value *SuggestedPostParameters) SendVoiceOption

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

func WithSendVoiceVoice

func WithSendVoiceVoice(value InputFile) SendVoiceOption

Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »

type SendVoiceParams

type SendVoiceParams struct {
	// Unique identifier of the business connection on behalf of which the message will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int64 `json:"message_thread_id,omitempty"`

	// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
	DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`

	// Audio file to send.
	// Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.
	// [More information on Sending Files »]
	//
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Voice InputFile `json:"voice"`

	// Voice message caption, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// Mode for parsing entities in the voice message caption.
	// See [formatting options] for more details.
	//
	// [formatting options]: https://core.telegram.org/bots/api#formatting-options
	ParseMode string `json:"parse_mode,omitempty"`

	// A JSON-serialized 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 voice message in seconds
	Duration int64 `json:"duration,omitempty"`

	// Sends the message [silently].
	// Users will receive a notification with no sound.
	//
	// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
	DisableNotification bool `json:"disable_notification,omitempty"`

	// Protects the contents of the sent message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// Pass True to allow up to 1000 messages per second, ignoring [broadcasting limits] for a fee of 0.1 Telegram Stars per message.
	// The relevant Stars will be withdrawn from the bot's balance
	//
	// [broadcasting limits]: https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once
	AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`

	// Unique identifier of the message effect to be added to the message; for private chats only
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
	// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// Additional interface options.
	// A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	// [custom reply keyboard]: https://core.telegram.org/bots/features#keyboards
	ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
}

func (*SendVoiceParams) Option

func (r *SendVoiceParams) Option(opts ...SendVoiceOption) (previous SendVoiceOption)

type SentWebAppMessage

type SentWebAppMessage struct {
	// Optional.
	// Identifier of the sent inline message.
	// Available only if there is an [inline keyboard] attached to the message.
	//
	// [inline keyboard]: https://core.telegram.org/bots/api#inlinekeyboardmarkup
	InlineMessageID string `json:"inline_message_id,omitempty"`
}

SentWebAppMessage

Describes an inline message sent by a Web App on behalf of a user.

type SetBusinessAccountBioOption

type SetBusinessAccountBioOption func(params *SetBusinessAccountBioParams) SetBusinessAccountBioOption

func WithSetBusinessAccountBioBio

func WithSetBusinessAccountBioBio(value string) SetBusinessAccountBioOption

The new value of the bio for the business account; 0-140 characters

func WithSetBusinessAccountBioBusinessConnectionID

func WithSetBusinessAccountBioBusinessConnectionID(value string) SetBusinessAccountBioOption

Unique identifier of the business connection

type SetBusinessAccountBioParams

type SetBusinessAccountBioParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// The new value of the bio for the business account; 0-140 characters
	Bio string `json:"bio,omitempty"`
}

func (*SetBusinessAccountBioParams) Option

type SetBusinessAccountGiftSettingsOption

type SetBusinessAccountGiftSettingsOption func(params *SetBusinessAccountGiftSettingsParams) SetBusinessAccountGiftSettingsOption

func WithSetBusinessAccountGiftSettingsAcceptedGiftTypes

func WithSetBusinessAccountGiftSettingsAcceptedGiftTypes(value AcceptedGiftTypes) SetBusinessAccountGiftSettingsOption

Types of gifts accepted by the business account

func WithSetBusinessAccountGiftSettingsBusinessConnectionID

func WithSetBusinessAccountGiftSettingsBusinessConnectionID(value string) SetBusinessAccountGiftSettingsOption

Unique identifier of the business connection

func WithSetBusinessAccountGiftSettingsShowGiftButton

func WithSetBusinessAccountGiftSettingsShowGiftButton(value bool) SetBusinessAccountGiftSettingsOption

Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field

type SetBusinessAccountGiftSettingsParams

type SetBusinessAccountGiftSettingsParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field
	ShowGiftButton bool `json:"show_gift_button"`

	// Types of gifts accepted by the business account
	AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"`
}

func (*SetBusinessAccountGiftSettingsParams) Option

type SetBusinessAccountNameOption

type SetBusinessAccountNameOption func(params *SetBusinessAccountNameParams) SetBusinessAccountNameOption

func WithSetBusinessAccountNameBusinessConnectionID

func WithSetBusinessAccountNameBusinessConnectionID(value string) SetBusinessAccountNameOption

Unique identifier of the business connection

func WithSetBusinessAccountNameFirstName

func WithSetBusinessAccountNameFirstName(value string) SetBusinessAccountNameOption

The new value of the first name for the business account; 1-64 characters

func WithSetBusinessAccountNameLastName

func WithSetBusinessAccountNameLastName(value string) SetBusinessAccountNameOption

The new value of the last name for the business account; 0-64 characters

type SetBusinessAccountNameParams

type SetBusinessAccountNameParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// The new value of the first name for the business account; 1-64 characters
	FirstName string `json:"first_name"`

	// The new value of the last name for the business account; 0-64 characters
	LastName string `json:"last_name,omitempty"`
}

func (*SetBusinessAccountNameParams) Option

type SetBusinessAccountProfilePhotoOption

type SetBusinessAccountProfilePhotoOption func(params *SetBusinessAccountProfilePhotoParams) SetBusinessAccountProfilePhotoOption

func WithSetBusinessAccountProfilePhotoBusinessConnectionID

func WithSetBusinessAccountProfilePhotoBusinessConnectionID(value string) SetBusinessAccountProfilePhotoOption

Unique identifier of the business connection

func WithSetBusinessAccountProfilePhotoIsPublic

func WithSetBusinessAccountProfilePhotoIsPublic(value bool) SetBusinessAccountProfilePhotoOption

Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.

func WithSetBusinessAccountProfilePhotoPhoto

func WithSetBusinessAccountProfilePhotoPhoto(value InputProfilePhoto) SetBusinessAccountProfilePhotoOption

The new profile photo to set

type SetBusinessAccountProfilePhotoParams

type SetBusinessAccountProfilePhotoParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// The new profile photo to set
	Photo InputProfilePhoto `json:"photo"`

	// Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings.
	// An account can have only one public photo.
	IsPublic bool `json:"is_public,omitempty"`
}

func (*SetBusinessAccountProfilePhotoParams) Option

type SetBusinessAccountUsernameOption

type SetBusinessAccountUsernameOption func(params *SetBusinessAccountUsernameParams) SetBusinessAccountUsernameOption

func WithSetBusinessAccountUsernameBusinessConnectionID

func WithSetBusinessAccountUsernameBusinessConnectionID(value string) SetBusinessAccountUsernameOption

Unique identifier of the business connection

func WithSetBusinessAccountUsernameUsername

func WithSetBusinessAccountUsernameUsername(value string) SetBusinessAccountUsernameOption

The new value of the username for the business account; 0-32 characters

type SetBusinessAccountUsernameParams

type SetBusinessAccountUsernameParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// The new value of the username for the business account; 0-32 characters
	Username string `json:"username,omitempty"`
}

func (*SetBusinessAccountUsernameParams) Option

type SetChatAdministratorCustomTitleOption

type SetChatAdministratorCustomTitleOption func(params *SetChatAdministratorCustomTitleParams) SetChatAdministratorCustomTitleOption

func WithSetChatAdministratorCustomTitleChatID

func WithSetChatAdministratorCustomTitleChatID(value string) SetChatAdministratorCustomTitleOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

func WithSetChatAdministratorCustomTitleCustomTitle

func WithSetChatAdministratorCustomTitleCustomTitle(value string) SetChatAdministratorCustomTitleOption

New custom title for the administrator; 0-16 characters, emoji are not allowed

func WithSetChatAdministratorCustomTitleUserID

func WithSetChatAdministratorCustomTitleUserID(value int64) SetChatAdministratorCustomTitleOption

Unique identifier of the target user

type SetChatAdministratorCustomTitleParams

type SetChatAdministratorCustomTitleParams struct {
	// 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 int64 `json:"user_id"`

	// New custom title for the administrator; 0-16 characters, emoji are not allowed
	CustomTitle string `json:"custom_title"`
}

func (*SetChatAdministratorCustomTitleParams) Option

type SetChatDescriptionOption

type SetChatDescriptionOption func(params *SetChatDescriptionParams) SetChatDescriptionOption

func WithSetChatDescriptionChatID

func WithSetChatDescriptionChatID(value string) SetChatDescriptionOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSetChatDescriptionDescription

func WithSetChatDescriptionDescription(value string) SetChatDescriptionOption

New chat description, 0-255 characters

type SetChatDescriptionParams

type SetChatDescriptionParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// New chat description, 0-255 characters
	Description string `json:"description,omitempty"`
}

func (*SetChatDescriptionParams) Option

type SetChatMenuButtonOption

type SetChatMenuButtonOption func(params *SetChatMenuButtonParams) SetChatMenuButtonOption

func WithSetChatMenuButtonChatID

func WithSetChatMenuButtonChatID(value int64) SetChatMenuButtonOption

Unique identifier for the target private chat. If not specified, default bot's menu button will be changed

func WithSetChatMenuButtonMenuButton

func WithSetChatMenuButtonMenuButton(value *MenuButton) SetChatMenuButtonOption

A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault

type SetChatMenuButtonParams

type SetChatMenuButtonParams struct {
	// Unique identifier for the target private chat.
	// If not specified, default bot's menu button will be changed
	ChatID int64 `json:"chat_id,omitempty"`

	// A JSON-serialized object for the bot's new menu button.
	// Defaults to [MenuButtonDefault]
	//
	// [MenuButtonDefault]: https://core.telegram.org/bots/api#menubuttondefault
	MenuButton *MenuButton `json:"menu_button,omitempty"`
}

func (*SetChatMenuButtonParams) Option

type SetChatPermissionsOption

type SetChatPermissionsOption func(params *SetChatPermissionsParams) SetChatPermissionsOption

func WithSetChatPermissionsChatID

func WithSetChatPermissionsChatID(value string) SetChatPermissionsOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

func WithSetChatPermissionsPermissions

func WithSetChatPermissionsPermissions(value ChatPermissions) SetChatPermissionsOption

A JSON-serialized object for new default chat permissions

func WithSetChatPermissionsUseIndependentChatPermissions

func WithSetChatPermissionsUseIndependentChatPermissions(value bool) SetChatPermissionsOption

Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.

type SetChatPermissionsParams

type SetChatPermissionsParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`

	// A JSON-serialized object for new default chat permissions
	Permissions ChatPermissions `json:"permissions"`

	// Pass True if chat permissions are set independently.
	// Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.
	UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"`
}

func (*SetChatPermissionsParams) Option

type SetChatPhotoOption

type SetChatPhotoOption func(params *SetChatPhotoParams) SetChatPhotoOption

func WithSetChatPhotoChatID

func WithSetChatPhotoChatID(value string) SetChatPhotoOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSetChatPhotoPhoto

func WithSetChatPhotoPhoto(value InputFile) SetChatPhotoOption

New chat photo, uploaded using multipart/form-data

type SetChatPhotoParams

type SetChatPhotoParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// New chat photo, uploaded using multipart/form-data
	Photo InputFile `json:"photo"`
}

func (*SetChatPhotoParams) Option

func (r *SetChatPhotoParams) Option(opts ...SetChatPhotoOption) (previous SetChatPhotoOption)

type SetChatStickerSetOption

type SetChatStickerSetOption func(params *SetChatStickerSetParams) SetChatStickerSetOption

func WithSetChatStickerSetChatID

func WithSetChatStickerSetChatID(value string) SetChatStickerSetOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

func WithSetChatStickerSetStickerSetName

func WithSetChatStickerSetStickerSetName(value string) SetChatStickerSetOption

Name of the sticker set to be set as the group sticker set

type SetChatStickerSetParams

type SetChatStickerSetParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`

	// Name of the sticker set to be set as the group sticker set
	StickerSetName string `json:"sticker_set_name"`
}

func (*SetChatStickerSetParams) Option

type SetChatTitleOption

type SetChatTitleOption func(params *SetChatTitleParams) SetChatTitleOption

func WithSetChatTitleChatID

func WithSetChatTitleChatID(value string) SetChatTitleOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSetChatTitleTitle

func WithSetChatTitleTitle(value string) SetChatTitleOption

New chat title, 1-128 characters

type SetChatTitleParams

type SetChatTitleParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// New chat title, 1-128 characters
	Title string `json:"title"`
}

func (*SetChatTitleParams) Option

func (r *SetChatTitleParams) Option(opts ...SetChatTitleOption) (previous SetChatTitleOption)

type SetCustomEmojiStickerSetThumbnailOption

type SetCustomEmojiStickerSetThumbnailOption func(params *SetCustomEmojiStickerSetThumbnailParams) SetCustomEmojiStickerSetThumbnailOption

func WithSetCustomEmojiStickerSetThumbnailCustomEmojiID

func WithSetCustomEmojiStickerSetThumbnailCustomEmojiID(value string) SetCustomEmojiStickerSetThumbnailOption

Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail.

func WithSetCustomEmojiStickerSetThumbnailName

func WithSetCustomEmojiStickerSetThumbnailName(value string) SetCustomEmojiStickerSetThumbnailOption

Sticker set name

type SetCustomEmojiStickerSetThumbnailParams

type SetCustomEmojiStickerSetThumbnailParams struct {
	// Sticker set name
	Name string `json:"name"`

	// Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail.
	CustomEmojiID string `json:"custom_emoji_id,omitempty"`
}

func (*SetCustomEmojiStickerSetThumbnailParams) Option

type SetGameScoreOption

type SetGameScoreOption func(params *SetGameScoreParams) SetGameScoreOption

func WithSetGameScoreChatID

func WithSetGameScoreChatID(value int64) SetGameScoreOption

Required if inline_message_id is not specified. Unique identifier for the target chat

func WithSetGameScoreDisableEditMessage

func WithSetGameScoreDisableEditMessage(value bool) SetGameScoreOption

Pass True if the game message should not be automatically edited to include the current scoreboard

func WithSetGameScoreForce

func WithSetGameScoreForce(value bool) SetGameScoreOption

Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters

func WithSetGameScoreInlineMessageID

func WithSetGameScoreInlineMessageID(value string) SetGameScoreOption

Required if chat_id and message_id are not specified. Identifier of the inline message

func WithSetGameScoreMessageID

func WithSetGameScoreMessageID(value int64) SetGameScoreOption

Required if inline_message_id is not specified. Identifier of the sent message

func WithSetGameScoreScore

func WithSetGameScoreScore(value int64) SetGameScoreOption

New score, must be non-negative

func WithSetGameScoreUserID

func WithSetGameScoreUserID(value int64) SetGameScoreOption

User identifier

type SetGameScoreParams

type SetGameScoreParams struct {
	// User identifier
	UserID int64 `json:"user_id"`

	// New score, must be non-negative
	Score int64 `json:"score"`

	// Pass True if the high score is allowed to decrease.
	// This can be useful when fixing mistakes or banning cheaters
	Force bool `json:"force,omitempty"`

	// Pass True if the game message should not be automatically edited to include the current scoreboard
	DisableEditMessage bool `json:"disable_edit_message,omitempty"`

	// Required if inline_message_id is not specified.
	// Unique identifier for the target chat
	ChatID int64 `json:"chat_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Identifier of the sent message
	MessageID int64 `json:"message_id,omitempty"`

	// Required if chat_id and message_id are not specified.
	// Identifier of the inline message
	InlineMessageID string `json:"inline_message_id,omitempty"`
}

func (*SetGameScoreParams) Option

func (r *SetGameScoreParams) Option(opts ...SetGameScoreOption) (previous SetGameScoreOption)

type SetMessageReactionOption

type SetMessageReactionOption func(params *SetMessageReactionParams) SetMessageReactionOption

func WithSetMessageReactionChatID

func WithSetMessageReactionChatID(value string) SetMessageReactionOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithSetMessageReactionIsBig

func WithSetMessageReactionIsBig(value bool) SetMessageReactionOption

Pass True to set the reaction with a big animation

func WithSetMessageReactionMessageID

func WithSetMessageReactionMessageID(value int64) SetMessageReactionOption

Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead.

func WithSetMessageReactionReaction

func WithSetMessageReactionReaction(value []ReactionType) SetMessageReactionOption

A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.

type SetMessageReactionParams

type SetMessageReactionParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Identifier of the target message.
	// If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead.
	MessageID int64 `json:"message_id"`

	// A JSON-serialized list of reaction types to set on the message.
	// Currently, as non-premium users, bots can set up to one reaction per message.
	// A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.
	// Paid reactions can't be used by bots.
	Reaction []ReactionType `json:"reaction,omitempty"`

	// Pass True to set the reaction with a big animation
	IsBig bool `json:"is_big,omitempty"`
}

func (*SetMessageReactionParams) Option

type SetMyCommandsOption

type SetMyCommandsOption func(params *SetMyCommandsParams) SetMyCommandsOption

func WithSetMyCommandsCommands

func WithSetMyCommandsCommands(value []BotCommand) SetMyCommandsOption

A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.

func WithSetMyCommandsLanguageCode

func WithSetMyCommandsLanguageCode(value string) SetMyCommandsOption

A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands

func WithSetMyCommandsScope

func WithSetMyCommandsScope(value *BotCommandScope) SetMyCommandsOption

A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.

type SetMyCommandsParams

type SetMyCommandsParams struct {
	// A JSON-serialized list of bot commands to be set as the list of the bot's commands.
	// At most 100 commands can be specified.
	Commands []BotCommand `json:"commands"`

	// A JSON-serialized object, describing scope of users for which the commands are relevant.
	// Defaults to [BotCommandScopeDefault].
	//
	// [BotCommandScopeDefault]: https://core.telegram.org/bots/api#botcommandscopedefault
	Scope *BotCommandScope `json:"scope,omitempty"`

	// A two-letter ISO 639-1 language code.
	// If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands
	LanguageCode string `json:"language_code,omitempty"`
}

func (*SetMyCommandsParams) Option

func (r *SetMyCommandsParams) Option(opts ...SetMyCommandsOption) (previous SetMyCommandsOption)

type SetMyDefaultAdministratorRightsOption

type SetMyDefaultAdministratorRightsOption func(params *SetMyDefaultAdministratorRightsParams) SetMyDefaultAdministratorRightsOption

func WithSetMyDefaultAdministratorRightsForChannels

func WithSetMyDefaultAdministratorRightsForChannels(value bool) SetMyDefaultAdministratorRightsOption

Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.

func WithSetMyDefaultAdministratorRightsRights

func WithSetMyDefaultAdministratorRightsRights(value *ChatAdministratorRights) SetMyDefaultAdministratorRightsOption

A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.

type SetMyDefaultAdministratorRightsParams

type SetMyDefaultAdministratorRightsParams struct {
	// A JSON-serialized object describing new default administrator rights.
	// If not specified, the default administrator rights will be cleared.
	Rights *ChatAdministratorRights `json:"rights,omitempty"`

	// Pass True to change the default administrator rights of the bot in channels.
	// Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.
	ForChannels bool `json:"for_channels,omitempty"`
}

func (*SetMyDefaultAdministratorRightsParams) Option

type SetMyDescriptionOption

type SetMyDescriptionOption func(params *SetMyDescriptionParams) SetMyDescriptionOption

func WithSetMyDescriptionDescription

func WithSetMyDescriptionDescription(value string) SetMyDescriptionOption

New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.

func WithSetMyDescriptionLanguageCode

func WithSetMyDescriptionLanguageCode(value string) SetMyDescriptionOption

A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.

type SetMyDescriptionParams

type SetMyDescriptionParams struct {
	// New bot description; 0-512 characters.
	// Pass an empty string to remove the dedicated description for the given language.
	Description string `json:"description,omitempty"`

	// A two-letter ISO 639-1 language code.
	// If empty, the description will be applied to all users for whose language there is no dedicated description.
	LanguageCode string `json:"language_code,omitempty"`
}

func (*SetMyDescriptionParams) Option

type SetMyNameOption

type SetMyNameOption func(params *SetMyNameParams) SetMyNameOption

func WithSetMyNameLanguageCode

func WithSetMyNameLanguageCode(value string) SetMyNameOption

A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name.

func WithSetMyNameName

func WithSetMyNameName(value string) SetMyNameOption

New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language.

type SetMyNameParams

type SetMyNameParams struct {
	// New bot name; 0-64 characters.
	// Pass an empty string to remove the dedicated name for the given language.
	Name string `json:"name,omitempty"`

	// A two-letter ISO 639-1 language code.
	// If empty, the name will be shown to all users for whose language there is no dedicated name.
	LanguageCode string `json:"language_code,omitempty"`
}

func (*SetMyNameParams) Option

func (r *SetMyNameParams) Option(opts ...SetMyNameOption) (previous SetMyNameOption)

type SetMyProfilePhotoOption

type SetMyProfilePhotoOption func(params *SetMyProfilePhotoParams) SetMyProfilePhotoOption

func WithSetMyProfilePhotoPhoto

func WithSetMyProfilePhotoPhoto(value InputProfilePhoto) SetMyProfilePhotoOption

The new profile photo to set

type SetMyProfilePhotoParams

type SetMyProfilePhotoParams struct {
	// The new profile photo to set
	Photo InputProfilePhoto `json:"photo"`
}

func (*SetMyProfilePhotoParams) Option

type SetMyShortDescriptionOption

type SetMyShortDescriptionOption func(params *SetMyShortDescriptionParams) SetMyShortDescriptionOption

func WithSetMyShortDescriptionLanguageCode

func WithSetMyShortDescriptionLanguageCode(value string) SetMyShortDescriptionOption

A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description.

func WithSetMyShortDescriptionShortDescription

func WithSetMyShortDescriptionShortDescription(value string) SetMyShortDescriptionOption

New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.

type SetMyShortDescriptionParams

type SetMyShortDescriptionParams struct {
	// New short description for the bot; 0-120 characters.
	// Pass an empty string to remove the dedicated short description for the given language.
	ShortDescription string `json:"short_description,omitempty"`

	// A two-letter ISO 639-1 language code.
	// If empty, the short description will be applied to all users for whose language there is no dedicated short description.
	LanguageCode string `json:"language_code,omitempty"`
}

func (*SetMyShortDescriptionParams) Option

type SetPassportDataErrorsOption

type SetPassportDataErrorsOption func(params *SetPassportDataErrorsParams) SetPassportDataErrorsOption

func WithSetPassportDataErrorsErrors

func WithSetPassportDataErrorsErrors(value []PassportElementError) SetPassportDataErrorsOption

A JSON-serialized array describing the errors

func WithSetPassportDataErrorsUserID

func WithSetPassportDataErrorsUserID(value int64) SetPassportDataErrorsOption

User identifier

type SetPassportDataErrorsParams

type SetPassportDataErrorsParams struct {
	// User identifier
	UserID int64 `json:"user_id"`

	// A JSON-serialized array describing the errors
	Errors []PassportElementError `json:"errors"`
}

func (*SetPassportDataErrorsParams) Option

type SetStickerEmojiListOption

type SetStickerEmojiListOption func(params *SetStickerEmojiListParams) SetStickerEmojiListOption

func WithSetStickerEmojiListEmojiList

func WithSetStickerEmojiListEmojiList(value []string) SetStickerEmojiListOption

A JSON-serialized list of 1-20 emoji associated with the sticker

func WithSetStickerEmojiListSticker

func WithSetStickerEmojiListSticker(value string) SetStickerEmojiListOption

File identifier of the sticker

type SetStickerEmojiListParams

type SetStickerEmojiListParams struct {
	// File identifier of the sticker
	Sticker string `json:"sticker"`

	// A JSON-serialized list of 1-20 emoji associated with the sticker
	EmojiList []string `json:"emoji_list"`
}

func (*SetStickerEmojiListParams) Option

type SetStickerKeywordsOption

type SetStickerKeywordsOption func(params *SetStickerKeywordsParams) SetStickerKeywordsOption

func WithSetStickerKeywordsKeywords

func WithSetStickerKeywordsKeywords(value []string) SetStickerKeywordsOption

A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters

func WithSetStickerKeywordsSticker

func WithSetStickerKeywordsSticker(value string) SetStickerKeywordsOption

File identifier of the sticker

type SetStickerKeywordsParams

type SetStickerKeywordsParams struct {
	// File identifier of the sticker
	Sticker string `json:"sticker"`

	// A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters
	Keywords []string `json:"keywords,omitempty"`
}

func (*SetStickerKeywordsParams) Option

type SetStickerMaskPositionOption

type SetStickerMaskPositionOption func(params *SetStickerMaskPositionParams) SetStickerMaskPositionOption

func WithSetStickerMaskPositionMaskPosition

func WithSetStickerMaskPositionMaskPosition(value *MaskPosition) SetStickerMaskPositionOption

A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position.

func WithSetStickerMaskPositionSticker

func WithSetStickerMaskPositionSticker(value string) SetStickerMaskPositionOption

File identifier of the sticker

type SetStickerMaskPositionParams

type SetStickerMaskPositionParams struct {
	// File identifier of the sticker
	Sticker string `json:"sticker"`

	// A JSON-serialized object with the position where the mask should be placed on faces.
	// Omit the parameter to remove the mask position.
	MaskPosition *MaskPosition `json:"mask_position,omitempty"`
}

func (*SetStickerMaskPositionParams) Option

type SetStickerPositionInSetOption

type SetStickerPositionInSetOption func(params *SetStickerPositionInSetParams) SetStickerPositionInSetOption

func WithSetStickerPositionInSetPosition

func WithSetStickerPositionInSetPosition(value int64) SetStickerPositionInSetOption

New sticker position in the set, zero-based

func WithSetStickerPositionInSetSticker

func WithSetStickerPositionInSetSticker(value string) SetStickerPositionInSetOption

File identifier of the sticker

type SetStickerPositionInSetParams

type SetStickerPositionInSetParams struct {
	// File identifier of the sticker
	Sticker string `json:"sticker"`

	// New sticker position in the set, zero-based
	Position int64 `json:"position"`
}

func (*SetStickerPositionInSetParams) Option

type SetStickerSetThumbnailOption

type SetStickerSetThumbnailOption func(params *SetStickerSetThumbnailParams) SetStickerSetThumbnailOption

func WithSetStickerSetThumbnailFormat

func WithSetStickerSetThumbnailFormat(value string) SetStickerSetThumbnailOption

Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a .WEBM video

func WithSetStickerSetThumbnailName

func WithSetStickerSetThumbnailName(value string) SetStickerSetThumbnailOption

Sticker set name

func WithSetStickerSetThumbnailThumbnail

func WithSetStickerSetThumbnailThumbnail(value *InputFile) SetStickerSetThumbnailOption

A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a .WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.

func WithSetStickerSetThumbnailUserID

func WithSetStickerSetThumbnailUserID(value int64) SetStickerSetThumbnailOption

User identifier of the sticker set owner

type SetStickerSetThumbnailParams

type SetStickerSetThumbnailParams struct {
	// Sticker set name
	Name string `json:"name"`

	// User identifier of the sticker set owner
	UserID int64 `json:"user_id"`

	// A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see [https://core.telegram.org/stickers#animation-requirements] for animated sticker technical requirements), or a .WEBM video with the thumbnail up to 32 kilobytes in size; see [https://core.telegram.org/stickers#video-requirements] for video sticker technical requirements.
	// Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.
	// [More information on Sending Files »].
	// Animated and video sticker set thumbnails can't be uploaded via HTTP URL.
	// If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.
	//
	// [https://core.telegram.org/stickers#animation-requirements]: https://core.telegram.org/stickers#animation-requirements
	// [https://core.telegram.org/stickers#video-requirements]: https://core.telegram.org/stickers#video-requirements
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Thumbnail *InputFile `json:"thumbnail,omitempty"`

	// Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a .WEBM video
	Format string `json:"format"`
}

func (*SetStickerSetThumbnailParams) Option

type SetStickerSetTitleOption

type SetStickerSetTitleOption func(params *SetStickerSetTitleParams) SetStickerSetTitleOption

func WithSetStickerSetTitleName

func WithSetStickerSetTitleName(value string) SetStickerSetTitleOption

Sticker set name

func WithSetStickerSetTitleTitle

func WithSetStickerSetTitleTitle(value string) SetStickerSetTitleOption

Sticker set title, 1-64 characters

type SetStickerSetTitleParams

type SetStickerSetTitleParams struct {
	// Sticker set name
	Name string `json:"name"`

	// Sticker set title, 1-64 characters
	Title string `json:"title"`
}

func (*SetStickerSetTitleParams) Option

type SetUserEmojiStatusOption

type SetUserEmojiStatusOption func(params *SetUserEmojiStatusParams) SetUserEmojiStatusOption

func WithSetUserEmojiStatusEmojiStatusCustomEmojiID

func WithSetUserEmojiStatusEmojiStatusCustomEmojiID(value string) SetUserEmojiStatusOption

Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status.

func WithSetUserEmojiStatusEmojiStatusExpirationDate

func WithSetUserEmojiStatusEmojiStatusExpirationDate(value int64) SetUserEmojiStatusOption

Expiration date of the emoji status, if any

func WithSetUserEmojiStatusUserID

func WithSetUserEmojiStatusUserID(value int64) SetUserEmojiStatusOption

Unique identifier of the target user

type SetUserEmojiStatusParams

type SetUserEmojiStatusParams struct {
	// Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// Custom emoji identifier of the emoji status to set.
	// Pass an empty string to remove the status.
	EmojiStatusCustomEmojiID string `json:"emoji_status_custom_emoji_id,omitempty"`

	// Expiration date of the emoji status, if any
	EmojiStatusExpirationDate int64 `json:"emoji_status_expiration_date,omitempty"`
}

func (*SetUserEmojiStatusParams) Option

type SetWebhookOption

type SetWebhookOption func(params *SetWebhookParams) SetWebhookOption

func WithSetWebhookAllowedUpdates

func WithSetWebhookAllowedUpdates(value []string) SetWebhookOption

A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.

func WithSetWebhookCertificate

func WithSetWebhookCertificate(value *InputFile) SetWebhookOption

Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.

func WithSetWebhookDropPendingUpdates

func WithSetWebhookDropPendingUpdates(value bool) SetWebhookOption

Pass True to drop all pending updates

func WithSetWebhookIpAddress

func WithSetWebhookIpAddress(value string) SetWebhookOption

The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS

func WithSetWebhookMaxConnections

func WithSetWebhookMaxConnections(value int64) SetWebhookOption

The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.

func WithSetWebhookSecretToken

func WithSetWebhookSecretToken(value string) SetWebhookOption

A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.

func WithSetWebhookURL

func WithSetWebhookURL(value string) SetWebhookOption

HTTPS URL to send updates to. Use an empty string to remove webhook integration

type SetWebhookParams

type SetWebhookParams struct {
	// HTTPS URL to send updates to.
	// Use an empty string to remove webhook integration
	URL string `json:"url"`

	// Upload your public key certificate so that the root certificate in use can be checked.
	// See our [self-signed guide] for details.
	//
	// [self-signed guide]: https://core.telegram.org/bots/self-signed
	Certificate *InputFile `json:"certificate,omitempty"`

	// The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS
	IpAddress string `json:"ip_address,omitempty"`

	// The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100.
	// Defaults to 40.
	// Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
	MaxConnections int64 `json:"max_connections,omitempty"`

	// A JSON-serialized list of the update types you want your bot to receive.
	// For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types.
	// See [Update] for a complete list of available update types.
	// Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default).
	// If not specified, the previous setting will be used.
	// Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.
	//
	// [Update]: https://core.telegram.org/bots/api#update
	AllowedUpdates []string `json:"allowed_updates,omitempty"`

	// Pass True to drop all pending updates
	DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`

	// A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters.
	// Only characters A-Z, a-z, 0-9, _ and - are allowed.
	// The header is useful to ensure that the request comes from a webhook set by you.
	SecretToken string `json:"secret_token,omitempty"`
}

func (*SetWebhookParams) Option

func (r *SetWebhookParams) Option(opts ...SetWebhookOption) (previous SetWebhookOption)

type SharedUser

type SharedUser struct {
	// Identifier of the shared user.
	// 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 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"`

	// Optional.
	// First name of the user, if the name was requested by the bot
	FirstName string `json:"first_name,omitempty"`

	// Optional.
	// Last name of the user, if the name was requested by the bot
	LastName string `json:"last_name,omitempty"`

	// Optional.
	// Username of the user, if the username was requested by the bot
	Username string `json:"username,omitempty"`

	// Optional.
	// Available sizes of the chat photo, if the photo was requested by the bot
	Photo []PhotoSize `json:"photo,omitempty"`
}

SharedUser

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
	//
	// [ISO 3166-1 alpha-2]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
	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"`
}

ShippingAddress

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"`
}

ShippingOption

This object represents one shipping option.

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"`
}

ShippingQuery

This object contains information about an incoming shipping query.

type StarAmount

type StarAmount struct {
	// Integer amount of Telegram Stars, rounded to 0; can be negative
	Amount int64 `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 int64 `json:"nanostar_amount,omitempty"`
}

StarAmount

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 int64 `json:"amount"`

	// Optional.
	// The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999
	NanostarAmount int64 `json:"nanostar_amount,omitempty"`

	// Date the transaction was created in Unix time
	Date int64 `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"`
}

StarTransaction

Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.

type StarTransactions

type StarTransactions struct {
	// The list of transactions
	Transactions []StarTransaction `json:"transactions"`
}

StarTransactions

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 int64 `json:"width"`

	// Sticker height
	Height int64 `json:"height"`

	// True, if the sticker is [animated]
	//
	// [animated]: https://telegram.org/blog/animated-stickers
	IsAnimated bool `json:"is_animated"`

	// True, if the sticker is a [video sticker]
	//
	// [video sticker]: https://telegram.org/blog/video-stickers-better-reactions
	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 int64 `json:"file_size,omitempty"`
}

Sticker

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"`
}

StickerSet

This object represents a sticker set.

type StopMessageLiveLocationOption

type StopMessageLiveLocationOption func(params *StopMessageLiveLocationParams) StopMessageLiveLocationOption

func WithStopMessageLiveLocationBusinessConnectionID

func WithStopMessageLiveLocationBusinessConnectionID(value string) StopMessageLiveLocationOption

Unique identifier of the business connection on behalf of which the message to be edited was sent

func WithStopMessageLiveLocationChatID

func WithStopMessageLiveLocationChatID(value string) StopMessageLiveLocationOption

Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithStopMessageLiveLocationInlineMessageID

func WithStopMessageLiveLocationInlineMessageID(value string) StopMessageLiveLocationOption

Required if chat_id and message_id are not specified. Identifier of the inline message

func WithStopMessageLiveLocationMessageID

func WithStopMessageLiveLocationMessageID(value int64) StopMessageLiveLocationOption

Required if inline_message_id is not specified. Identifier of the message with live location to stop

func WithStopMessageLiveLocationReplyMarkup

func WithStopMessageLiveLocationReplyMarkup(value *InlineKeyboardMarkup) StopMessageLiveLocationOption

A JSON-serialized object for a new inline keyboard.

type StopMessageLiveLocationParams

type StopMessageLiveLocationParams struct {
	// Unique identifier of the business connection on behalf of which the message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id,omitempty"`

	// Required if inline_message_id is not specified.
	// Identifier of the message with live location to stop
	MessageID int64 `json:"message_id,omitempty"`

	// Required if chat_id and message_id are not specified.
	// Identifier of the inline message
	InlineMessageID string `json:"inline_message_id,omitempty"`

	// A JSON-serialized object for a new [inline keyboard].
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func (*StopMessageLiveLocationParams) Option

type StopPollOption

type StopPollOption func(params *StopPollParams) StopPollOption

func WithStopPollBusinessConnectionID

func WithStopPollBusinessConnectionID(value string) StopPollOption

Unique identifier of the business connection on behalf of which the message to be edited was sent

func WithStopPollChatID

func WithStopPollChatID(value string) StopPollOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithStopPollMessageID

func WithStopPollMessageID(value int64) StopPollOption

Identifier of the original message with the poll

func WithStopPollReplyMarkup

func WithStopPollReplyMarkup(value *InlineKeyboardMarkup) StopPollOption

A JSON-serialized object for a new message inline keyboard.

type StopPollParams

type StopPollParams struct {
	// Unique identifier of the business connection on behalf of which the message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Identifier of the original message with the poll
	MessageID int64 `json:"message_id"`

	// A JSON-serialized object for a new message [inline keyboard].
	//
	// [inline keyboard]: https://core.telegram.org/bots/features#inline-keyboards
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

func (*StopPollParams) Option

func (r *StopPollParams) Option(opts ...StopPollOption) (previous StopPollOption)

type Story

type Story struct {
	// Chat that posted the story
	Chat Chat `json:"chat"`

	// Unique identifier for the story in the chat
	ID int64 `json:"id"`
}

Story

This object represents a story.

type StoryArea

type StoryArea struct {
	// Position of the area
	Position StoryAreaPosition `json:"position"`

	// Type of the area
	Type StoryAreaType `json:"type"`
}

StoryArea

Describes a clickable area on a story media.

type StoryAreaPosition

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"`
}

StoryAreaPosition

Describes the position of a clickable area within a story.

type StoryAreaType

StoryAreaType

Describes the type of a clickable area on a story. Currently, it can be one of

StoryAreaTypeLocation

StoryAreaTypeSuggestedReaction

StoryAreaTypeLink

StoryAreaTypeWeather

StoryAreaTypeUniqueGift

func (*StoryAreaType) MarshalJSON

func (r *StoryAreaType) MarshalJSON() ([]byte, error)

func (*StoryAreaType) UnmarshalJSON

func (r *StoryAreaType) UnmarshalJSON(data []byte) error
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"`
}

StoryAreaTypeLink

Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.

type StoryAreaTypeLocation

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
	Longitude float64 `json:"longitude"`

	// Optional.
	// Address of the location
	Address *LocationAddress `json:"address,omitempty"`
}

StoryAreaTypeLocation

Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.

type StoryAreaTypeSuggestedReaction

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"`
}

StoryAreaTypeSuggestedReaction

Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.

type StoryAreaTypeUniqueGift

type StoryAreaTypeUniqueGift struct {
	// Type of the area, always “unique_gift”
	Type string `json:"type"`

	// Unique name of the gift
	Name string `json:"name"`
}

StoryAreaTypeUniqueGift

Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.

type StoryAreaTypeWeather

type StoryAreaTypeWeather struct {
	// Type of the area, always “weather”
	Type string `json:"type"`

	// Temperature, in degree Celsius
	Temperature float64 `json:"temperature"`

	// Emoji representing the weather
	Emoji string `json:"emoji"`

	// A color of the area background in the ARGB format
	BackgroundColor int64 `json:"background_color"`
}

StoryAreaTypeWeather

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]: https://core.telegram.org/bots/payments#supported-currencies
	// [Telegram Stars]: https://t.me/BotNews/90
	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 [currencies.json], it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
	//
	// [currencies.json]: https://core.telegram.org/bots/payments/currencies.json
	TotalAmount int64 `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 int64 `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"`
}

SuccessfulPayment

This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.

type SuggestedPostApprovalFailed

type SuggestedPostApprovalFailed struct {
	// Optional.
	// Message containing the suggested post whose approval has failed.
	// Note that the [Message] object in this field will not contain the reply_to_message field even if it itself is a reply.
	//
	// [Message]: https://core.telegram.org/bots/api#message
	SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`

	// Expected price of the post
	Price SuggestedPostPrice `json:"price"`
}

SuggestedPostApprovalFailed

Describes a service message about the failed approval of a suggested post. Currently, only caused by insufficient user funds at the time of approval.

type SuggestedPostApproved

type SuggestedPostApproved struct {
	// Optional.
	// Message containing the suggested post.
	// Note that the [Message] object in this field will not contain the reply_to_message field even if it itself is a reply.
	//
	// [Message]: https://core.telegram.org/bots/api#message
	SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`

	// Optional.
	// Amount paid for the post
	Price *SuggestedPostPrice `json:"price,omitempty"`

	// Date when the post will be published
	SendDate int64 `json:"send_date"`
}

SuggestedPostApproved

Describes a service message about the approval of a suggested post.

type SuggestedPostDeclined

type SuggestedPostDeclined struct {
	// Optional.
	// Message containing the suggested post.
	// Note that the [Message] object in this field will not contain the reply_to_message field even if it itself is a reply.
	//
	// [Message]: https://core.telegram.org/bots/api#message
	SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`

	// Optional.
	// Comment with which the post was declined
	Comment string `json:"comment,omitempty"`
}

SuggestedPostDeclined

Describes a service message about the rejection of a suggested post.

type SuggestedPostInfo

type SuggestedPostInfo struct {
	// State of the suggested post.
	// Currently, it can be one of “pending”, “approved”, “declined”.
	State string `json:"state"`

	// Optional.
	// Proposed price of the post.
	// If the field is omitted, then the post is unpaid.
	Price *SuggestedPostPrice `json:"price,omitempty"`

	// Optional.
	// Proposed send date of the post.
	// If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user or administrator who approves it.
	SendDate int64 `json:"send_date,omitempty"`
}

SuggestedPostInfo

Contains information about a suggested post.

type SuggestedPostPaid

type SuggestedPostPaid struct {
	// Optional.
	// Message containing the suggested post.
	// Note that the [Message] object in this field will not contain the reply_to_message field even if it itself is a reply.
	//
	// [Message]: https://core.telegram.org/bots/api#message
	SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`

	// Currency in which the payment was made.
	// Currently, one of “XTR” for Telegram Stars or “TON” for toncoins
	Currency string `json:"currency"`

	// Optional.
	// The amount of the currency that was received by the channel in nanotoncoins; for payments in toncoins only
	Amount int64 `json:"amount,omitempty"`

	// Optional.
	// The amount of Telegram Stars that was received by the channel; for payments in Telegram Stars only
	StarAmount *StarAmount `json:"star_amount,omitempty"`
}

SuggestedPostPaid

Describes a service message about a successful payment for a suggested post.

type SuggestedPostParameters

type SuggestedPostParameters struct {
	// Optional.
	// Proposed price for the post.
	// If the field is omitted, then the post is unpaid.
	Price *SuggestedPostPrice `json:"price,omitempty"`

	// Optional.
	// Proposed send date of the post.
	// If specified, then the date must be between 300 second and 2678400 seconds (30 days) in the future.
	// If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user who approves it.
	SendDate int64 `json:"send_date,omitempty"`
}

SuggestedPostParameters

Contains parameters of a post that is being suggested by the bot.

type SuggestedPostPrice

type SuggestedPostPrice struct {
	// Currency in which the post will be paid.
	// Currently, must be one of “XTR” for Telegram Stars or “TON” for toncoins
	Currency string `json:"currency"`

	// The amount of the currency that will be paid for the post in the smallest units of the currency, i.e.
	// Telegram Stars or nanotoncoins.
	// Currently, price in Telegram Stars must be between 5 and 100000, and price in nanotoncoins must be between 10000000 and 10000000000000.
	Amount int64 `json:"amount"`
}

SuggestedPostPrice

Describes the price of a suggested post.

type SuggestedPostRefunded

type SuggestedPostRefunded struct {
	// Optional.
	// Message containing the suggested post.
	// Note that the [Message] object in this field will not contain the reply_to_message field even if it itself is a reply.
	//
	// [Message]: https://core.telegram.org/bots/api#message
	SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`

	// Reason for the refund.
	// Currently, one of “post_deleted” if the post was deleted within 24 hours of being posted or removed from scheduled messages without being posted, or “payment_refunded” if the payer refunded their payment.
	Reason string `json:"reason"`
}

SuggestedPostRefunded

Describes a service message about a payment refund for a suggested post.

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"`
}

SwitchInlineQueryChosenChat

This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.

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 int64 `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"`
}

TextQuote

This object contains information about the quoted part of a message that is replied to by the given message.

type TransactionPartner

TransactionPartner

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) MarshalJSON

func (r *TransactionPartner) MarshalJSON() ([]byte, error)

func (*TransactionPartner) UnmarshalJSON

func (r *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
	CommissionPerMille int64 `json:"commission_per_mille"`
}

TransactionPartnerAffiliateProgram

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"`
}

TransactionPartnerChat

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"`
}

TransactionPartnerFragment

Describes a withdrawal transaction with Fragment.

type TransactionPartnerOther

type TransactionPartnerOther struct {
	// Type of the transaction partner, always “other”
	Type string `json:"type"`
}

TransactionPartnerOther

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"`
}

TransactionPartnerTelegramAds

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 int64 `json:"request_count"`
}

TransactionPartnerTelegramApi

Describes a transaction with payment for paid broadcasting.

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.
	// Can be available only for “invoice_payment” and “paid_media_payment” transactions.
	Affiliate *AffiliateInfo `json:"affiliate,omitempty"`

	// Optional.
	// Bot-specified invoice payload.
	// Can be available only for “invoice_payment” transactions.
	InvoicePayload string `json:"invoice_payload,omitempty"`

	// Optional.
	// The duration of the paid subscription.
	// Can be available only for “invoice_payment” transactions.
	SubscriptionPeriod int64 `json:"subscription_period,omitempty"`

	// Optional.
	// Information about the paid media bought by the user; for “paid_media_payment” transactions only
	PaidMedia []PaidMedia `json:"paid_media,omitempty"`

	// Optional.
	// Bot-specified paid media payload.
	// Can be available only for “paid_media_payment” transactions.
	PaidMediaPayload string `json:"paid_media_payload,omitempty"`

	// Optional.
	// The gift sent to the user by the bot; for “gift_purchase” transactions only
	Gift *Gift `json:"gift,omitempty"`

	// Optional.
	// Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only
	PremiumSubscriptionDuration int64 `json:"premium_subscription_duration,omitempty"`
}

TransactionPartnerUser

Describes a transaction with a user.

type TransferBusinessAccountStarsOption

type TransferBusinessAccountStarsOption func(params *TransferBusinessAccountStarsParams) TransferBusinessAccountStarsOption

func WithTransferBusinessAccountStarsBusinessConnectionID

func WithTransferBusinessAccountStarsBusinessConnectionID(value string) TransferBusinessAccountStarsOption

Unique identifier of the business connection

func WithTransferBusinessAccountStarsStarCount

func WithTransferBusinessAccountStarsStarCount(value int64) TransferBusinessAccountStarsOption

Number of Telegram Stars to transfer; 1-10000

type TransferBusinessAccountStarsParams

type TransferBusinessAccountStarsParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Number of Telegram Stars to transfer; 1-10000
	StarCount int64 `json:"star_count"`
}

func (*TransferBusinessAccountStarsParams) Option

type TransferGiftOption

type TransferGiftOption func(params *TransferGiftParams) TransferGiftOption

func WithTransferGiftBusinessConnectionID

func WithTransferGiftBusinessConnectionID(value string) TransferGiftOption

Unique identifier of the business connection

func WithTransferGiftNewOwnerChatID

func WithTransferGiftNewOwnerChatID(value int64) TransferGiftOption

Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.

func WithTransferGiftOwnedGiftID

func WithTransferGiftOwnedGiftID(value string) TransferGiftOption

Unique identifier of the regular gift that should be transferred

func WithTransferGiftStarCount

func WithTransferGiftStarCount(value int64) TransferGiftOption

The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required.

type TransferGiftParams

type TransferGiftParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Unique identifier of the regular gift that should be transferred
	OwnedGiftID string `json:"owned_gift_id"`

	// Unique identifier of the chat which will own the gift.
	// The chat must be active in the last 24 hours.
	NewOwnerChatID int64 `json:"new_owner_chat_id"`

	// The amount of Telegram Stars that will be paid for the transfer from the business account balance.
	// If positive, then the can_transfer_stars business bot right is required.
	StarCount int64 `json:"star_count,omitempty"`
}

func (*TransferGiftParams) Option

func (r *TransferGiftParams) Option(opts ...TransferGiftOption) (previous TransferGiftOption)

type UnbanChatMemberOption

type UnbanChatMemberOption func(params *UnbanChatMemberParams) UnbanChatMemberOption

func WithUnbanChatMemberChatID

func WithUnbanChatMemberChatID(value string) UnbanChatMemberOption

Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)

func WithUnbanChatMemberOnlyIfBanned

func WithUnbanChatMemberOnlyIfBanned(value bool) UnbanChatMemberOption

Do nothing if the user is not banned

func WithUnbanChatMemberUserID

func WithUnbanChatMemberUserID(value int64) UnbanChatMemberOption

Unique identifier of the target user

type UnbanChatMemberParams

type UnbanChatMemberParams struct {
	// Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// Do nothing if the user is not banned
	OnlyIfBanned bool `json:"only_if_banned,omitempty"`
}

func (*UnbanChatMemberParams) Option

type UnbanChatSenderChatOption

type UnbanChatSenderChatOption func(params *UnbanChatSenderChatParams) UnbanChatSenderChatOption

func WithUnbanChatSenderChatChatID

func WithUnbanChatSenderChatChatID(value string) UnbanChatSenderChatOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithUnbanChatSenderChatSenderChatID

func WithUnbanChatSenderChatSenderChatID(value int64) UnbanChatSenderChatOption

Unique identifier of the target sender chat

type UnbanChatSenderChatParams

type UnbanChatSenderChatParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Unique identifier of the target sender chat
	SenderChatID int64 `json:"sender_chat_id"`
}

func (*UnbanChatSenderChatParams) Option

type UnhideGeneralForumTopicOption

type UnhideGeneralForumTopicOption func(params *UnhideGeneralForumTopicParams) UnhideGeneralForumTopicOption

func WithUnhideGeneralForumTopicChatID

func WithUnhideGeneralForumTopicChatID(value string) UnhideGeneralForumTopicOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

type UnhideGeneralForumTopicParams

type UnhideGeneralForumTopicParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`
}

func (*UnhideGeneralForumTopicParams) Option

type UniqueGift

type UniqueGift struct {
	// Identifier of the regular gift from which the gift was upgraded
	GiftID string `json:"gift_id"`

	// 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 int64 `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"`

	// Optional.
	// True, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers
	IsPremium bool `json:"is_premium,omitempty"`

	// Optional.
	// True, if the gift was used to craft another gift and isn't available anymore
	IsBurned bool `json:"is_burned,omitempty"`

	// Optional.
	// True, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram
	IsFromBlockchain bool `json:"is_from_blockchain,omitempty"`

	// Optional.
	// The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews; for business account gifts and gifts that are currently on sale only
	Colors *UniqueGiftColors `json:"colors,omitempty"`

	// Optional.
	// Information about the chat that published the gift
	PublisherChat *Chat `json:"publisher_chat,omitempty"`
}

UniqueGift

This object describes a unique gift that was upgraded from a regular gift.

type UniqueGiftBackdrop

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
	RarityPerMille int64 `json:"rarity_per_mille"`
}

UniqueGiftBackdrop

This object describes the backdrop of a unique gift.

type UniqueGiftBackdropColors

type UniqueGiftBackdropColors struct {
	// The color in the center of the backdrop in RGB format
	CenterColor int64 `json:"center_color"`

	// The color on the edges of the backdrop in RGB format
	EdgeColor int64 `json:"edge_color"`

	// The color to be applied to the symbol in RGB format
	SymbolColor int64 `json:"symbol_color"`

	// The color for the text on the backdrop in RGB format
	TextColor int64 `json:"text_color"`
}

UniqueGiftBackdropColors

This object describes the colors of the backdrop of a unique gift.

type UniqueGiftColors

type UniqueGiftColors struct {
	// Custom emoji identifier of the unique gift's model
	ModelCustomEmojiID string `json:"model_custom_emoji_id"`

	// Custom emoji identifier of the unique gift's symbol
	SymbolCustomEmojiID string `json:"symbol_custom_emoji_id"`

	// Main color used in light themes; RGB format
	LightThemeMainColor int64 `json:"light_theme_main_color"`

	// List of 1-3 additional colors used in light themes; RGB format
	LightThemeOtherColors []int64 `json:"light_theme_other_colors"`

	// Main color used in dark themes; RGB format
	DarkThemeMainColor int64 `json:"dark_theme_main_color"`

	// List of 1-3 additional colors used in dark themes; RGB format
	DarkThemeOtherColors []int64 `json:"dark_theme_other_colors"`
}

UniqueGiftColors

This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.

type UniqueGiftInfo

type UniqueGiftInfo struct {
	// Information about the gift
	Gift UniqueGift `json:"gift"`

	// Origin of the gift.
	// Currently, either “upgrade” for gifts upgraded from regular gifts, “transfer” for gifts transferred from other users or channels, “resale” for gifts bought from other users, “gifted_upgrade” for upgrades purchased after the gift was sent, or “offer” for gifts bought or sold through gift purchase offers
	Origin string `json:"origin"`

	// Optional.
	// For gifts bought from other users, the currency in which the payment for the gift was done.
	// Currently, one of “XTR” for Telegram Stars or “TON” for toncoins.
	LastResaleCurrency string `json:"last_resale_currency,omitempty"`

	// Optional.
	// For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins
	LastResaleAmount int64 `json:"last_resale_amount,omitempty"`

	// 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 int64 `json:"transfer_star_count,omitempty"`

	// Optional.
	// Point in time (Unix timestamp) when the gift can be transferred.
	// If it is in the past, then the gift can be transferred now
	NextTransferDate int64 `json:"next_transfer_date,omitempty"`
}

UniqueGiftInfo

Describes a service message about a unique gift that was sent or received.

type UniqueGiftModel

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 gift upgrades.
	// Always 0 for crafted gifts.
	RarityPerMille int64 `json:"rarity_per_mille"`

	// Optional.
	// Rarity of the model if it is a crafted model.
	// Currently, can be “uncommon”, “rare”, “epic”, or “legendary”.
	Rarity string `json:"rarity,omitempty"`
}

UniqueGiftModel

This object describes the model of a unique gift.

type UniqueGiftSymbol

type UniqueGiftSymbol struct {
	// Name of the symbol
	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
	RarityPerMille int64 `json:"rarity_per_mille"`
}

UniqueGiftSymbol

This object describes the symbol shown on the pattern of a unique gift.

type UnpinAllChatMessagesOption

type UnpinAllChatMessagesOption func(params *UnpinAllChatMessagesParams) UnpinAllChatMessagesOption

func WithUnpinAllChatMessagesChatID

func WithUnpinAllChatMessagesChatID(value string) UnpinAllChatMessagesOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

type UnpinAllChatMessagesParams

type UnpinAllChatMessagesParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`
}

func (*UnpinAllChatMessagesParams) Option

type UnpinAllForumTopicMessagesOption

type UnpinAllForumTopicMessagesOption func(params *UnpinAllForumTopicMessagesParams) UnpinAllForumTopicMessagesOption

func WithUnpinAllForumTopicMessagesChatID

func WithUnpinAllForumTopicMessagesChatID(value string) UnpinAllForumTopicMessagesOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

func WithUnpinAllForumTopicMessagesMessageThreadID

func WithUnpinAllForumTopicMessagesMessageThreadID(value int64) UnpinAllForumTopicMessagesOption

Unique identifier for the target message thread of the forum topic

type UnpinAllForumTopicMessagesParams

type UnpinAllForumTopicMessagesParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`

	// Unique identifier for the target message thread of the forum topic
	MessageThreadID int64 `json:"message_thread_id"`
}

func (*UnpinAllForumTopicMessagesParams) Option

type UnpinAllGeneralForumTopicMessagesOption

type UnpinAllGeneralForumTopicMessagesOption func(params *UnpinAllGeneralForumTopicMessagesParams) UnpinAllGeneralForumTopicMessagesOption

func WithUnpinAllGeneralForumTopicMessagesChatID

func WithUnpinAllGeneralForumTopicMessagesChatID(value string) UnpinAllGeneralForumTopicMessagesOption

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

type UnpinAllGeneralForumTopicMessagesParams

type UnpinAllGeneralForumTopicMessagesParams struct {
	// Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
	ChatID string `json:"chat_id"`
}

func (*UnpinAllGeneralForumTopicMessagesParams) Option

type UnpinChatMessageOption

type UnpinChatMessageOption func(params *UnpinChatMessageParams) UnpinChatMessageOption

func WithUnpinChatMessageBusinessConnectionID

func WithUnpinChatMessageBusinessConnectionID(value string) UnpinChatMessageOption

Unique identifier of the business connection on behalf of which the message will be unpinned

func WithUnpinChatMessageChatID

func WithUnpinChatMessageChatID(value string) UnpinChatMessageOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

func WithUnpinChatMessageMessageID

func WithUnpinChatMessageMessageID(value int64) UnpinChatMessageOption

Identifier of the message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be unpinned.

type UnpinChatMessageParams

type UnpinChatMessageParams struct {
	// Unique identifier of the business connection on behalf of which the message will be unpinned
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
	ChatID string `json:"chat_id"`

	// Identifier of the message to unpin.
	// Required if business_connection_id is specified.
	// If not specified, the most recent pinned message (by sending date) will be unpinned.
	MessageID int64 `json:"message_id,omitempty"`
}

func (*UnpinChatMessageParams) Option

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.
	//
	// [webhooks]: https://core.telegram.org/bots/api#setwebhook
	UpdateID int64 `json:"update_id"`

	// Optional.
	// New incoming message of any kind - text, photo, sticker, etc.
	Message *Message `json:"message,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.
	// 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.
	// 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
	DeletedBusinessMessages *BusinessMessagesDeleted `json:"deleted_business_messages,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
	//
	// [inline]: https://core.telegram.org/bots/api#inline-mode
	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.
	//
	// [inline]: https://core.telegram.org/bots/api#inline-mode
	// [feedback collecting]: https://core.telegram.org/bots/inline#collecting-feedback
	ChosenInlineResult *ChosenInlineResult `json:"chosen_inline_result,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.
	// New incoming pre-checkout query.
	// Contains full information about checkout
	PreCheckoutQuery *PreCheckoutQuery `json:"pre_checkout_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 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"`
}

Update

This object represents an incoming update. At most one of the optional parameters can be present in any given update.

type UpgradeGiftOption

type UpgradeGiftOption func(params *UpgradeGiftParams) UpgradeGiftOption

func WithUpgradeGiftBusinessConnectionID

func WithUpgradeGiftBusinessConnectionID(value string) UpgradeGiftOption

Unique identifier of the business connection

func WithUpgradeGiftKeepOriginalDetails

func WithUpgradeGiftKeepOriginalDetails(value bool) UpgradeGiftOption

Pass True to keep the original gift text, sender and receiver in the upgraded gift

func WithUpgradeGiftOwnedGiftID

func WithUpgradeGiftOwnedGiftID(value string) UpgradeGiftOption

Unique identifier of the regular gift that should be upgraded to a unique one

func WithUpgradeGiftStarCount

func WithUpgradeGiftStarCount(value int64) UpgradeGiftOption

The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed.

type UpgradeGiftParams

type UpgradeGiftParams struct {
	// Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Unique identifier of the regular gift that should be upgraded to a unique one
	OwnedGiftID string `json:"owned_gift_id"`

	// Pass True to keep the original gift text, sender and receiver in the upgraded gift
	KeepOriginalDetails bool `json:"keep_original_details,omitempty"`

	// The amount of Telegram Stars that will be paid for the upgrade from the business account balance.
	// If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed.
	StarCount int64 `json:"star_count,omitempty"`
}

func (*UpgradeGiftParams) Option

func (r *UpgradeGiftParams) Option(opts ...UpgradeGiftOption) (previous UpgradeGiftOption)

type UploadStickerFileOption

type UploadStickerFileOption func(params *UploadStickerFileParams) UploadStickerFileOption

func WithUploadStickerFileSticker

func WithUploadStickerFileSticker(value InputFile) UploadStickerFileOption

A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files »

func WithUploadStickerFileStickerFormat

func WithUploadStickerFileStickerFormat(value string) UploadStickerFileOption

Format of the sticker, must be one of “static”, “animated”, “video”

func WithUploadStickerFileUserID

func WithUploadStickerFileUserID(value int64) UploadStickerFileOption

User identifier of sticker file owner

type UploadStickerFileParams

type UploadStickerFileParams struct {
	// User identifier of sticker file owner
	UserID int64 `json:"user_id"`

	// A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format.
	// See [https://core.telegram.org/stickers] for technical requirements.
	// [More information on Sending Files »]
	//
	// [https://core.telegram.org/stickers]: https://core.telegram.org/stickers
	// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
	Sticker InputFile `json:"sticker"`

	// Format of the sticker, must be one of “static”, “animated”, “video”
	StickerFormat string `json:"sticker_format"`
}

func (*UploadStickerFileParams) Option

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"`

	// True, if this user is a bot
	IsBot bool `json:"is_bot"`

	// User's or bot's first name
	FirstName string `json:"first_name"`

	// Optional.
	// User's or bot's last name
	LastName string `json:"last_name,omitempty"`

	// Optional.
	// User's or bot's username
	Username string `json:"username,omitempty"`

	// Optional.
	// [IETF language tag] of the user's language
	//
	// [IETF language tag]: https://en.wikipedia.org/wiki/IETF_language_tag
	LanguageCode string `json:"language_code,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 invited to groups.
	// Returned only in [getMe].
	//
	// [getMe]: https://core.telegram.org/bots/api#getme
	CanJoinGroups bool `json:"can_join_groups,omitempty"`

	// Optional.
	// True, if [privacy mode] is disabled for the bot.
	// Returned only in [getMe].
	//
	// [privacy mode]: https://core.telegram.org/bots/features#privacy-mode
	// [getMe]: https://core.telegram.org/bots/api#getme
	CanReadAllGroupMessages bool `json:"can_read_all_group_messages,omitempty"`

	// Optional.
	// True, if the bot supports inline queries.
	// Returned only in [getMe].
	//
	// [getMe]: https://core.telegram.org/bots/api#getme
	SupportsInlineQueries bool `json:"supports_inline_queries,omitempty"`

	// Optional.
	// True, if the bot can be connected to a Telegram Business account to receive its messages.
	// Returned only in [getMe].
	//
	// [getMe]: https://core.telegram.org/bots/api#getme
	CanConnectToBusiness bool `json:"can_connect_to_business,omitempty"`

	// Optional.
	// True, if the bot has a main Web App.
	// Returned only in [getMe].
	//
	// [getMe]: https://core.telegram.org/bots/api#getme
	HasMainWebApp bool `json:"has_main_web_app,omitempty"`

	// Optional.
	// True, if the bot has forum topic mode enabled in private chats.
	// Returned only in [getMe].
	//
	// [getMe]: https://core.telegram.org/bots/api#getme
	HasTopicsEnabled bool `json:"has_topics_enabled,omitempty"`

	// Optional.
	// True, if the bot allows users to create and delete topics in private chats.
	// Returned only in [getMe].
	//
	// [getMe]: https://core.telegram.org/bots/api#getme
	AllowsUsersToCreateTopics bool `json:"allows_users_to_create_topics,omitempty"`
}

User

This object represents a Telegram user or bot.

func (*User) Identifier

func (u *User) Identifier() string

type UserChatBoosts

type UserChatBoosts struct {
	// The list of boosts added to the chat by the user
	Boosts []ChatBoost `json:"boosts"`
}

UserChatBoosts

This object represents a list of boosts added to a chat by a user.

type UserProfileAudios

type UserProfileAudios struct {
	// Total number of profile audios for the target user
	TotalCount int64 `json:"total_count"`

	// Requested profile audios
	Audios []Audio `json:"audios"`
}

UserProfileAudios

This object represents the audios displayed on a user's profile.

type UserProfilePhotos

type UserProfilePhotos struct {
	// Total number of profile pictures the target user has
	TotalCount int64 `json:"total_count"`

	// Requested profile pictures (in up to 4 sizes each)
	Photos [][]PhotoSize `json:"photos"`
}

UserProfilePhotos

This object represent a user's profile pictures.

type UserRating

type UserRating struct {
	// Current level of the user, indicating their reliability when purchasing digital goods and services.
	// A higher level suggests a more trustworthy customer; a negative level is likely reason for concern.
	Level int64 `json:"level"`

	// Numerical value of the user's rating; the higher the rating, the better
	Rating int64 `json:"rating"`

	// The rating value required to get the current level
	CurrentLevelRating int64 `json:"current_level_rating"`

	// Optional.
	// The rating value required to get to the next level; omitted if the maximum level was reached
	NextLevelRating int64 `json:"next_level_rating,omitempty"`
}

UserRating

This object describes the rating of a user based on their Telegram Star spendings.

type UsersShared

type UsersShared struct {
	// Identifier of the request
	RequestID int64 `json:"request_id"`

	// Information about users shared with the bot.
	Users []SharedUser `json:"users"`
}

UsersShared

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:"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 [supported types].)
	//
	// [supported types]: https://developers.google.com/places/web-service/supported_types
	GooglePlaceType string `json:"google_place_type,omitempty"`
}

Venue

This object represents a venue.

type VerifyChatOption

type VerifyChatOption func(params *VerifyChatParams) VerifyChatOption

func WithVerifyChatChatID

func WithVerifyChatChatID(value string) VerifyChatOption

Unique identifier for the target chat or username of the target channel (in the format @channelusername). Channel direct messages chats can't be verified.

func WithVerifyChatCustomDescription

func WithVerifyChatCustomDescription(value string) VerifyChatOption

Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.

type VerifyChatParams

type VerifyChatParams struct {
	// Unique identifier for the target chat or username of the target channel (in the format @channelusername).
	// Channel direct messages chats can't be verified.
	ChatID string `json:"chat_id"`

	// Custom description for the verification; 0-70 characters.
	// Must be empty if the organization isn't allowed to provide a custom verification description.
	CustomDescription string `json:"custom_description,omitempty"`
}

func (*VerifyChatParams) Option

func (r *VerifyChatParams) Option(opts ...VerifyChatOption) (previous VerifyChatOption)

type VerifyUserOption

type VerifyUserOption func(params *VerifyUserParams) VerifyUserOption

func WithVerifyUserCustomDescription

func WithVerifyUserCustomDescription(value string) VerifyUserOption

Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.

func WithVerifyUserUserID

func WithVerifyUserUserID(value int64) VerifyUserOption

Unique identifier of the target user

type VerifyUserParams

type VerifyUserParams struct {
	// Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// Custom description for the verification; 0-70 characters.
	// Must be empty if the organization isn't allowed to provide a custom verification description.
	CustomDescription string `json:"custom_description,omitempty"`
}

func (*VerifyUserParams) Option

func (r *VerifyUserParams) Option(opts ...VerifyUserOption) (previous VerifyUserOption)

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 int64 `json:"width"`

	// Video height as defined by the sender
	Height int64 `json:"height"`

	// Duration of the video in seconds as defined by the sender
	Duration int64 `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 int64 `json:"start_timestamp,omitempty"`

	// Optional.
	// List of available qualities of the video
	Qualities []VideoQuality `json:"qualities,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"`
}

Video

This object represents a video file.

type VideoChatEnded

type VideoChatEnded struct {
	// Video chat duration in seconds
	Duration int64 `json:"duration"`
}

VideoChatEnded

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"`
}

VideoChatParticipantsInvited

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 int64 `json:"start_date"`
}

VideoChatScheduled

This object represents a service message about a video chat scheduled in the chat.

type VideoChatStarted

type VideoChatStarted struct {
}

VideoChatStarted

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 int64 `json:"length"`

	// Duration of the video in seconds as defined by the sender
	Duration int64 `json:"duration"`

	// Optional.
	// Video thumbnail
	Thumbnail *PhotoSize `json:"thumbnail,omitempty"`

	// Optional.
	// File size in bytes
	FileSize int64 `json:"file_size,omitempty"`
}

VideoNote

This object represents a video message (available in Telegram apps as of v.4.0).

type VideoQuality

type VideoQuality 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
	Width int64 `json:"width"`

	// Video height
	Height int64 `json:"height"`

	// Codec that was used to encode the video, for example, “h264”, “h265”, or “av01”
	Codec string `json:"codec"`

	// 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"`
}

VideoQuality

This object represents a video file of a specific quality.

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 int64 `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 int64 `json:"file_size,omitempty"`
}

Voice

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"`
}

WebAppData

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]
	//
	// [Initializing Web Apps]: https://core.telegram.org/bots/webapps#initializing-mini-apps
	URL string `json:"url"`
}

WebAppInfo

Describes a Web App.

type WebhookInfo

type WebhookInfo struct {
	// Webhook URL, may be empty if webhook is not set up
	URL string `json:"url"`

	// True, if a custom certificate was provided for webhook certificate checks
	HasCustomCertificate bool `json:"has_custom_certificate"`

	// Number of updates awaiting delivery
	PendingUpdateCount int64 `json:"pending_update_count"`

	// Optional.
	// Currently used webhook IP address
	IpAddress string `json:"ip_address,omitempty"`

	// Optional.
	// Unix time for the most recent error that happened when trying to deliver an update via webhook
	LastErrorDate int64 `json:"last_error_date,omitempty"`

	// Optional.
	// Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook
	LastErrorMessage string `json:"last_error_message,omitempty"`

	// Optional.
	// Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters
	LastSynchronizationErrorDate int64 `json:"last_synchronization_error_date,omitempty"`

	// Optional.
	// The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery
	MaxConnections int64 `json:"max_connections,omitempty"`

	// Optional.
	// A list of update types the bot is subscribed to.
	// Defaults to all update types except chat_member
	AllowedUpdates []string `json:"allowed_updates,omitempty"`
}

WebhookInfo

Describes the current status of a webhook.

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]
	//
	// [requestWriteAccess]: https://core.telegram.org/bots/webapps#initializing-mini-apps
	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"`
}

WriteAccessAllowed

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.

Directories

Path Synopsis
cmd
gen command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL