lukaszraczylo/go-telegram
1
0
Fork 0
mirror of https://github.com/lukaszraczylo/go-telegram.git synced 2026-06-05 22:43:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
26b98a53721ae29a5842937652bbbbe0f7a4d2a3
go-telegram/api/types.gen.go
T
lukaszraczylo 79c0617867 Merge pull request #1 from lukaszraczylo/feat/typed-allowed-updates 
feat(api): type AllowedUpdates as []UpdateType for compile-time typo …
2026-05-09 20:53:45 +01:00

7456 lines
361 KiB
Go
Raw Blame History

// Code generated by cmd/genapi. DO NOT EDIT.
//go:build !ignore_autogenerated
// Package api contains the Telegram Bot API object types and method
// wrappers, generated from the live documentation by cmd/genapi.
package api
import (
"fmt"
"github.com/goccy/go-json"
"io"
)
var _ = io.Discard // keep import even if no fields use io
var _ = json.Marshal // keep import for UnmarshalXxx helpers
var _ = fmt.Errorf // keep import for UnmarshalXxx helpers
// This object represents an incoming update.At most one of the optional fields can be present in any given update.
type Update struct {
// The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This identifier becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.
UpdateID 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. New guest message. The bot can use the field Message.guest_query_id and the method answerGuestQuery to send a message in response.
GuestMessage *Message `json:"guest_message,omitempty"`
// Optional. A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify "message_reaction" in the list of allowed_updates to receive these updates. The update isn't received for reactions set by bots.
MessageReaction *MessageReactionUpdated `json:"message_reaction,omitempty"`
// Optional. Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify "message_reaction_count" in the list of allowed_updates to receive these updates. The updates are grouped and can be sent with delay up to a few minutes.
MessageReactionCount *MessageReactionCountUpdated `json:"message_reaction_count,omitempty"`
// Optional. New incoming inline query
InlineQuery *InlineQuery `json:"inline_query,omitempty"`
// Optional. The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.
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"`
// Optional. A new bot was created to be managed by the bot, or token or owner of a managed bot was changed
ManagedBot *ManagedBotUpdated `json:"managed_bot,omitempty"`
}
// Describes the current status of a webhook.
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 []UpdateType `json:"allowed_updates,omitempty"`
}
// This object represents a Telegram user or bot.
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
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.
CanJoinGroups *bool `json:"can_join_groups,omitempty"`
// Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.
CanReadAllGroupMessages *bool `json:"can_read_all_group_messages,omitempty"`
// Optional. True, if the bot supports guest queries from chats it is not a member of. Returned only in getMe.
SupportsGuestQueries *bool `json:"supports_guest_queries,omitempty"`
// Optional. True, if the bot supports inline queries. Returned only in getMe.
SupportsInlineQueries *bool `json:"supports_inline_queries,omitempty"`
// Optional. True, if the bot can be connected to a user account to manage it. Returned only in getMe.
CanConnectToBusiness *bool `json:"can_connect_to_business,omitempty"`
// Optional. True, if the bot has a main Web App. Returned only in getMe.
HasMainWebApp *bool `json:"has_main_web_app,omitempty"`
// Optional. True, if the bot has forum topic mode enabled in private chats. Returned only in 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.
AllowsUsersToCreateTopics *bool `json:"allows_users_to_create_topics,omitempty"`
// Optional. True, if other bots can be created to be controlled by the bot. Returned only in getMe.
CanManageBots *bool `json:"can_manage_bots,omitempty"`
}
// This object represents a 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 ChatType `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)
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"`
}
// This object contains full information about a chat.
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 ChatType `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)
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.
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
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.
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.
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"`
}
// UnmarshalJSON decodes ChatFullInfo by dispatching union-typed fields
// (AvailableReactions) through their concrete UnmarshalXxx helpers.
func (m *ChatFullInfo) UnmarshalJSON(data []byte) error {
type Alias ChatFullInfo
aux := &struct {
AvailableReactions json.RawMessage `json:"available_reactions,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.AvailableReactions) > 0 && string(aux.AvailableReactions) != "null" {
var raws []json.RawMessage
if err := json.Unmarshal(aux.AvailableReactions, &raws); err != nil {
return fmt.Errorf("decoding available_reactions: %w", err)
}
decoded := make([]ReactionType, 0, len(raws))
for i, r := range raws {
v, err := UnmarshalReactionType(r)
if err != nil {
return fmt.Errorf("decoding available_reactions[%d]: %w", i, err)
}
decoded = append(decoded, v)
}
m.AvailableReactions = decoded
}
return nil
}
// This object represents a 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"`
// Optional. Tag or custom title of the sender of the message; for supergroups only
SenderTag string `json:"sender_tag,omitempty"`
// Date the message was sent in Unix time. It is always a positive number, representing a valid date.
Date int64 `json:"date"`
// Optional. The unique identifier for the guest query. Use this identifier with the method answerGuestQuery to send a response message. If non-empty, the message belongs to the chat where the guest bot was summoned, which may not coincide with other existing bot chats sharing the same identifier.
GuestQueryID string `json:"guest_query_id,omitempty"`
// 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.
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. Persistent identifier of the specific poll option that is being replied to
ReplyToPollOptionID string `json:"reply_to_poll_option_id,omitempty"`
// Optional. Bot through which the message was sent
ViaBot *User `json:"via_bot,omitempty"`
// Optional. For a message sent by a guest bot, this is the user whose original message triggered the bot's response
GuestBotCallerUser *User `json:"guest_bot_caller_user,omitempty"`
// Optional. For a message sent by a guest bot, this is the chat whose original message triggered the bot's response
GuestBotCallerChat *Chat `json:"guest_bot_caller_chat,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 inside this chat 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 is a live photo, information about the live photo. For backward compatibility, when this field is set, the photo field will also be set
LivePhoto *LivePhoto `json:"live_photo,omitempty"`
// Optional. Message contains paid media; information about the paid media
PaidMedia *PaidMediaInfo `json:"paid_media,omitempty"`
// Optional. Message is a photo, available sizes of the photo
Photo []PhotoSize `json:"photo,omitempty"`
// Optional. Message is a sticker, information about the sticker
Sticker *Sticker `json:"sticker,omitempty"`
// Optional. Message is a forwarded story
Story *Story `json:"story,omitempty"`
// Optional. Message is a video, information about the video
Video *Video `json:"video,omitempty"`
// Optional. Message is a video note, information about the video message
VideoNote *VideoNote `json:"video_note,omitempty"`
// Optional. Message is a voice message, information about the file
Voice *Voice `json:"voice,omitempty"`
// Optional. Caption for the animation, audio, document, paid media, photo, video or voice
Caption string `json:"caption,omitempty"`
// Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Optional. True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. True, if the message media is covered by a spoiler animation
HasMediaSpoiler *bool `json:"has_media_spoiler,omitempty"`
// Optional. Message is a 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 »
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.
PinnedMessage MaybeInaccessibleMessage `json:"pinned_message,omitempty"`
// Optional. Message is an invoice for a payment, information about the invoice. More about payments »
Invoice *Invoice `json:"invoice,omitempty"`
// Optional. Message is a service message about a successful payment, information about the payment. More about payments »
SuccessfulPayment *SuccessfulPayment `json:"successful_payment,omitempty"`
// Optional. Message is a service message about a refunded payment, information about the payment. More about 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 »
ConnectedWebsite string `json:"connected_website,omitempty"`
// Optional. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess
WriteAccessAllowed *WriteAccessAllowed `json:"write_access_allowed,omitempty"`
// Optional. Telegram Passport data
PassportData *PassportData `json:"passport_data,omitempty"`
// Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.
ProximityAlertTriggered *ProximityAlertTriggered `json:"proximity_alert_triggered,omitempty"`
// Optional. Service message: user boosted the chat
BoostAdded *ChatBoostAdded `json:"boost_added,omitempty"`
// Optional. Service message: chat background set
ChatBackgroundSet *ChatBackground `json:"chat_background_set,omitempty"`
// Optional. Service message: 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: user created a bot that will be managed by the current bot
ManagedBotCreated *ManagedBotCreated `json:"managed_bot_created,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: answer option was added to a poll
PollOptionAdded *PollOptionAdded `json:"poll_option_added,omitempty"`
// Optional. Service message: answer option was deleted from a poll
PollOptionDeleted *PollOptionDeleted `json:"poll_option_deleted,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.
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}
// UnmarshalJSON decodes Message by dispatching union-typed fields
// (ForwardOrigin, PinnedMessage) through their concrete UnmarshalXxx helpers.
func (m *Message) UnmarshalJSON(data []byte) error {
type Alias Message
aux := &struct {
ForwardOrigin json.RawMessage `json:"forward_origin,omitempty"`
PinnedMessage json.RawMessage `json:"pinned_message,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.ForwardOrigin) > 0 && string(aux.ForwardOrigin) != "null" {
v, err := UnmarshalMessageOrigin(aux.ForwardOrigin)
if err != nil {
return fmt.Errorf("decoding forward_origin: %w", err)
}
m.ForwardOrigin = v
}
if len(aux.PinnedMessage) > 0 && string(aux.PinnedMessage) != "null" {
v, err := UnmarshalMaybeInaccessibleMessage(aux.PinnedMessage)
if err != nil {
return fmt.Errorf("decoding pinned_message: %w", err)
}
m.PinnedMessage = v
}
return nil
}
// This object represents a unique message identifier.
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"`
}
// This object describes a message that was deleted or is otherwise inaccessible to the bot.
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"`
}
// MaybeInaccessibleMessage is a union type. The following concrete variants implement
// it:
// - Message
// - InaccessibleMessage
//
// This object describes a message that can be inaccessible to the bot. It can be one of
type MaybeInaccessibleMessage interface{ isMaybeInaccessibleMessage() }
// isMaybeInaccessibleMessage is the marker method that makes Message implement MaybeInaccessibleMessage.
func (*Message) isMaybeInaccessibleMessage() {}
// isMaybeInaccessibleMessage is the marker method that makes InaccessibleMessage implement MaybeInaccessibleMessage.
func (*InaccessibleMessage) isMaybeInaccessibleMessage() {}
// UnmarshalMaybeInaccessibleMessage decodes a JSON object into the correct
// MaybeInaccessibleMessage variant. Telegram uses the date field as a
// discriminator: date == 0 indicates InaccessibleMessage; any other value
// indicates a real Message.
func UnmarshalMaybeInaccessibleMessage(data []byte) (MaybeInaccessibleMessage, error) {
var probe struct {
Date int64 `json:"date"`
}
if err := json.Unmarshal(data, &probe); err != nil {
return nil, fmt.Errorf("MaybeInaccessibleMessage: %w", err)
}
if probe.Date == 0 {
v := &InaccessibleMessage{}
if err := json.Unmarshal(data, v); err != nil {
return nil, fmt.Errorf("InaccessibleMessage: %w", err)
}
return v, nil
}
v := &Message{}
if err := json.Unmarshal(data, v); err != nil {
return nil, fmt.Errorf("Message: %w", err)
}
return v, nil
}
// This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
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), or “date_time” (for formatted date and time)
Type MessageEntityType `json:"type"`
// Offset in UTF-16 code units to the start of the entity
Offset int64 `json:"offset"`
// Length of the entity in UTF-16 code units
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
CustomEmojiID string `json:"custom_emoji_id,omitempty"`
// Optional. For “date_time” only, the Unix time associated with the entity
UnixTime *int64 `json:"unix_time,omitempty"`
// Optional. For “date_time” only, the string that defines the formatting of the date and time. See date-time entity formatting for more details.
DateTimeFormat string `json:"date_time_format,omitempty"`
}
// This object contains information about the quoted part of a message that is replied to by the given message.
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, custom_emoji, and date_time 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"`
}
// This object contains information about a message that is being replied to, which may come from another chat or forum topic.
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 is a live photo, information about the live photo
LivePhoto *LivePhoto `json:"live_photo,omitempty"`
// Optional. Message contains paid media; information about the paid media
PaidMedia *PaidMediaInfo `json:"paid_media,omitempty"`
// Optional. Message is a photo, available sizes of the photo
Photo []PhotoSize `json:"photo,omitempty"`
// Optional. Message is a sticker, information about the sticker
Sticker *Sticker `json:"sticker,omitempty"`
// Optional. Message is a forwarded story
Story *Story `json:"story,omitempty"`
// Optional. Message is a video, information about the video
Video *Video `json:"video,omitempty"`
// Optional. Message is a video note, information about the video message
VideoNote *VideoNote `json:"video_note,omitempty"`
// Optional. Message is a voice message, information about the file
Voice *Voice `json:"voice,omitempty"`
// Optional. True, if the message media is covered by a spoiler animation
HasMediaSpoiler *bool `json:"has_media_spoiler,omitempty"`
// Optional. Message is a 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 »
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 »
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"`
}
// UnmarshalJSON decodes ExternalReplyInfo by dispatching union-typed fields
// (Origin) through their concrete UnmarshalXxx helpers.
func (m *ExternalReplyInfo) UnmarshalJSON(data []byte) error {
type Alias ExternalReplyInfo
aux := &struct {
Origin json.RawMessage `json:"origin,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.Origin) > 0 && string(aux.Origin) != "null" {
v, err := UnmarshalMessageOrigin(aux.Origin)
if err != nil {
return fmt.Errorf("decoding origin: %w", err)
}
m.Origin = v
}
return nil
}
// Describes reply parameters for the message that is being sent.
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 bot, supergroup or channel in the format @username. Not supported for messages sent on behalf of a business account and messages from channel direct messages chats.
ChatID *ChatID `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, custom_emoji, and date_time 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.
QuoteParseMode ParseMode `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"`
// Optional. Persistent identifier of the specific poll option to be replied to
PollOptionID string `json:"poll_option_id,omitempty"`
}
// MessageOrigin is a union type. The following concrete variants implement
// it:
// - MessageOriginUser
// - MessageOriginHiddenUser
// - MessageOriginChat
// - MessageOriginChannel
//
// This object describes the origin of a message. It can be one of
type MessageOrigin interface{ isMessageOrigin() }
// isMessageOrigin is the marker method that makes MessageOriginUser implement MessageOrigin.
func (*MessageOriginUser) isMessageOrigin() {}
// isMessageOrigin is the marker method that makes MessageOriginHiddenUser implement MessageOrigin.
func (*MessageOriginHiddenUser) isMessageOrigin() {}
// isMessageOrigin is the marker method that makes MessageOriginChat implement MessageOrigin.
func (*MessageOriginChat) isMessageOrigin() {}
// isMessageOrigin is the marker method that makes MessageOriginChannel implement MessageOrigin.
func (*MessageOriginChannel) isMessageOrigin() {}
// UnmarshalMessageOrigin decodes a MessageOrigin from JSON by inspecting the
// "type" field and dispatching to the correct concrete type.
func UnmarshalMessageOrigin(data []byte) (MessageOrigin, error) {
var probe struct {
V string `json:"type"`
}
if err := json.Unmarshal(data, &probe); err != nil {
return nil, err
}
var v MessageOrigin
switch probe.V {
case "channel":
v = &MessageOriginChannel{}
case "chat":
v = &MessageOriginChat{}
case "hidden_user":
v = &MessageOriginHiddenUser{}
case "user":
v = &MessageOriginUser{}
default:
return nil, fmt.Errorf("MessageOrigin: unknown type %q", probe.V)
}
if err := json.Unmarshal(data, v); err != nil {
return nil, err
}
return v, nil
}
// The message was originally sent by a known user.
type MessageOriginUser struct {
// Type of the message origin, always “user”
Type MessageOriginType `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"`
}
// MarshalJSON encodes MessageOriginUser with the discriminator field
// "type" forced to "user".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *MessageOriginUser) MarshalJSON() ([]byte, error) {
type alias MessageOriginUser
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "user",
alias: (*alias)(v),
})
}
// The message was originally sent by an unknown user.
type MessageOriginHiddenUser struct {
// Type of the message origin, always “hidden_user”
Type MessageOriginType `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"`
}
// MarshalJSON encodes MessageOriginHiddenUser with the discriminator field
// "type" forced to "hidden_user".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *MessageOriginHiddenUser) MarshalJSON() ([]byte, error) {
type alias MessageOriginHiddenUser
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "hidden_user",
alias: (*alias)(v),
})
}
// The message was originally sent on behalf of a chat to a group chat.
type MessageOriginChat struct {
// Type of the message origin, always “chat”
Type MessageOriginType `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"`
}
// MarshalJSON encodes MessageOriginChat with the discriminator field
// "type" forced to "chat".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *MessageOriginChat) MarshalJSON() ([]byte, error) {
type alias MessageOriginChat
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "chat",
alias: (*alias)(v),
})
}
// The message was originally sent to a channel chat.
type MessageOriginChannel struct {
// Type of the message origin, always “channel”
Type MessageOriginType `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"`
}
// MarshalJSON encodes MessageOriginChannel with the discriminator field
// "type" forced to "channel".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *MessageOriginChannel) MarshalJSON() ([]byte, error) {
type alias MessageOriginChannel
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "channel",
alias: (*alias)(v),
})
}
// This object represents one size of a photo or a file / sticker thumbnail.
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"`
}
// This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
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"`
}
// This object represents an audio file to be treated as music by the Telegram clients.
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"`
}
// This object represents a general file (as opposed to photos, voice messages and audio files).
type Document struct {
// Identifier for this file, which can be used to download or reuse the file
FileID string `json:"file_id"`
// Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
FileUniqueID string `json:"file_unique_id"`
// Optional. Document thumbnail as defined by the sender
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
// Optional. Original filename as defined by the sender
FileName string `json:"file_name,omitempty"`
// Optional. MIME type of the file as defined by the sender
MimeType string `json:"mime_type,omitempty"`
// Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
FileSize *int64 `json:"file_size,omitempty"`
}
// This object represents a live photo.
type LivePhoto struct {
// Optional. Available sizes of the corresponding static photo
Photo []PhotoSize `json:"photo,omitempty"`
// Identifier for the video file which can be used to download or reuse the file
FileID string `json:"file_id"`
// Unique identifier for the video 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. MIME type of the file as defined by the sender
MimeType string `json:"mime_type,omitempty"`
// Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
FileSize *int64 `json:"file_size,omitempty"`
}
// This object represents a 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"`
}
// This object represents a video file of a specific quality.
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"`
}
// This object represents a video file.
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"`
}
// This object represents a video message (available in Telegram apps as of v.4.0).
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"`
}
// This object represents a voice note.
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"`
}
// Describes the paid media added to a message.
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"`
}
// UnmarshalJSON decodes PaidMediaInfo by dispatching union-typed fields
// (PaidMedia) through their concrete UnmarshalXxx helpers.
func (m *PaidMediaInfo) UnmarshalJSON(data []byte) error {
type Alias PaidMediaInfo
aux := &struct {
PaidMedia json.RawMessage `json:"paid_media,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.PaidMedia) > 0 && string(aux.PaidMedia) != "null" {
var raws []json.RawMessage
if err := json.Unmarshal(aux.PaidMedia, &raws); err != nil {
return fmt.Errorf("decoding paid_media: %w", err)
}
decoded := make([]PaidMedia, 0, len(raws))
for i, r := range raws {
v, err := UnmarshalPaidMedia(r)
if err != nil {
return fmt.Errorf("decoding paid_media[%d]: %w", i, err)
}
decoded = append(decoded, v)
}
m.PaidMedia = decoded
}
return nil
}
// PaidMedia is a union type. The following concrete variants implement
// it:
// - PaidMediaLivePhoto
// - PaidMediaPhoto
// - PaidMediaPreview
// - PaidMediaVideo
//
// This object describes paid media. Currently, it can be one of
type PaidMedia interface{ isPaidMedia() }
// isPaidMedia is the marker method that makes PaidMediaLivePhoto implement PaidMedia.
func (*PaidMediaLivePhoto) isPaidMedia() {}
// isPaidMedia is the marker method that makes PaidMediaPhoto implement PaidMedia.
func (*PaidMediaPhoto) isPaidMedia() {}
// isPaidMedia is the marker method that makes PaidMediaPreview implement PaidMedia.
func (*PaidMediaPreview) isPaidMedia() {}
// isPaidMedia is the marker method that makes PaidMediaVideo implement PaidMedia.
func (*PaidMediaVideo) isPaidMedia() {}
// UnmarshalPaidMedia decodes a PaidMedia from JSON by inspecting the
// "type" field and dispatching to the correct concrete type.
func UnmarshalPaidMedia(data []byte) (PaidMedia, error) {
var probe struct {
V string `json:"type"`
}
if err := json.Unmarshal(data, &probe); err != nil {
return nil, err
}
var v PaidMedia
switch probe.V {
case "photo":
v = &PaidMediaPhoto{}
case "preview":
v = &PaidMediaPreview{}
case "video":
v = &PaidMediaVideo{}
default:
return nil, fmt.Errorf("PaidMedia: unknown type %q", probe.V)
}
if err := json.Unmarshal(data, v); err != nil {
return nil, err
}
return v, nil
}
// The paid media is a live photo.
type PaidMediaLivePhoto struct {
// Type of the paid media, always “live_photo”
Type PaidMediaType `json:"type"`
// The photo
LivePhoto LivePhoto `json:"live_photo"`
}
// MarshalJSON encodes PaidMediaLivePhoto with the discriminator field
// "type" forced to "live_photo".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *PaidMediaLivePhoto) MarshalJSON() ([]byte, error) {
type alias PaidMediaLivePhoto
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "live_photo",
alias: (*alias)(v),
})
}
// The paid media is a photo.
type PaidMediaPhoto struct {
// Type of the paid media, always “photo”
Type PaidMediaType `json:"type"`
// The photo
Photo []PhotoSize `json:"photo"`
}
// MarshalJSON encodes PaidMediaPhoto with the discriminator field
// "type" forced to "photo".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *PaidMediaPhoto) MarshalJSON() ([]byte, error) {
type alias PaidMediaPhoto
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "photo",
alias: (*alias)(v),
})
}
// The paid media isn't available before the payment.
type PaidMediaPreview struct {
// Type of the paid media, always “preview”
Type PaidMediaType `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"`
}
// MarshalJSON encodes PaidMediaPreview with the discriminator field
// "type" forced to "preview".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *PaidMediaPreview) MarshalJSON() ([]byte, error) {
type alias PaidMediaPreview
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "preview",
alias: (*alias)(v),
})
}
// The paid media is a video.
type PaidMediaVideo struct {
// Type of the paid media, always “video”
Type PaidMediaType `json:"type"`
// The video
Video Video `json:"video"`
}
// MarshalJSON encodes PaidMediaVideo with the discriminator field
// "type" forced to "video".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *PaidMediaVideo) MarshalJSON() ([]byte, error) {
type alias PaidMediaVideo
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "video",
alias: (*alias)(v),
})
}
// This object represents a phone contact.
type Contact struct {
// Contact's phone number
PhoneNumber string `json:"phone_number"`
// Contact's first name
FirstName string `json:"first_name"`
// Optional. Contact's last name
LastName string `json:"last_name,omitempty"`
// Optional. Contact's user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
UserID *int64 `json:"user_id,omitempty"`
// Optional. Additional data about the contact in the form of a vCard
Vcard string `json:"vcard,omitempty"`
}
// This object represents an animated emoji that displays a random value.
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"`
}
// At most one of the optional fields can be present in any given object.
type PollMedia struct {
// Optional. Media is an animation, information about the animation
Animation *Animation `json:"animation,omitempty"`
// Optional. Media is an audio file, information about the file; currently, can't be received in a poll option
Audio *Audio `json:"audio,omitempty"`
// Optional. Media is a general file, information about the file; currently, can't be received in a poll option
Document *Document `json:"document,omitempty"`
// Optional. Media is a live photo, information about the live photo
LivePhoto *LivePhoto `json:"live_photo,omitempty"`
// Optional. Media is a shared location, information about the location
Location *Location `json:"location,omitempty"`
// Optional. Media is a photo, available sizes of the photo
Photo []PhotoSize `json:"photo,omitempty"`
// Optional. Media is a sticker, information about the sticker; currently, for poll options only
Sticker *Sticker `json:"sticker,omitempty"`
// Optional. Media is a venue, information about the venue
Venue *Venue `json:"venue,omitempty"`
// Optional. Media is a video, information about the video
Video *Video `json:"video,omitempty"`
}
// InputPollMedia is a union type. The following concrete variants implement
// it:
// - InputMediaAnimation
// - InputMediaAudio
// - InputMediaDocument
// - InputMediaLivePhoto
// - InputMediaLocation
// - InputMediaPhoto
// - InputMediaVenue
// - InputMediaVideo
//
// This object represents the content of a poll description or a quiz explanation to be sent. It should be one of
type InputPollMedia interface{ isInputPollMedia() }
// isInputPollMedia is the marker method that makes InputMediaAnimation implement InputPollMedia.
func (*InputMediaAnimation) isInputPollMedia() {}
// isInputPollMedia is the marker method that makes InputMediaAudio implement InputPollMedia.
func (*InputMediaAudio) isInputPollMedia() {}
// isInputPollMedia is the marker method that makes InputMediaDocument implement InputPollMedia.
func (*InputMediaDocument) isInputPollMedia() {}
// isInputPollMedia is the marker method that makes InputMediaLivePhoto implement InputPollMedia.
func (*InputMediaLivePhoto) isInputPollMedia() {}
// isInputPollMedia is the marker method that makes InputMediaLocation implement InputPollMedia.
func (*InputMediaLocation) isInputPollMedia() {}
// isInputPollMedia is the marker method that makes InputMediaPhoto implement InputPollMedia.
func (*InputMediaPhoto) isInputPollMedia() {}
// isInputPollMedia is the marker method that makes InputMediaVenue implement InputPollMedia.
func (*InputMediaVenue) isInputPollMedia() {}
// isInputPollMedia is the marker method that makes InputMediaVideo implement InputPollMedia.
func (*InputMediaVideo) isInputPollMedia() {}
// InputPollOptionMedia is a union type. The following concrete variants implement
// it:
// - InputMediaAnimation
// - InputMediaLivePhoto
// - InputMediaLocation
// - InputMediaPhoto
// - InputMediaSticker
// - InputMediaVenue
// - InputMediaVideo
//
// This object represents the content of a poll option to be sent. It should be one of
type InputPollOptionMedia interface{ isInputPollOptionMedia() }
// isInputPollOptionMedia is the marker method that makes InputMediaAnimation implement InputPollOptionMedia.
func (*InputMediaAnimation) isInputPollOptionMedia() {}
// isInputPollOptionMedia is the marker method that makes InputMediaLivePhoto implement InputPollOptionMedia.
func (*InputMediaLivePhoto) isInputPollOptionMedia() {}
// isInputPollOptionMedia is the marker method that makes InputMediaLocation implement InputPollOptionMedia.
func (*InputMediaLocation) isInputPollOptionMedia() {}
// isInputPollOptionMedia is the marker method that makes InputMediaPhoto implement InputPollOptionMedia.
func (*InputMediaPhoto) isInputPollOptionMedia() {}
// isInputPollOptionMedia is the marker method that makes InputMediaSticker implement InputPollOptionMedia.
func (*InputMediaSticker) isInputPollOptionMedia() {}
// isInputPollOptionMedia is the marker method that makes InputMediaVenue implement InputPollOptionMedia.
func (*InputMediaVenue) isInputPollOptionMedia() {}
// isInputPollOptionMedia is the marker method that makes InputMediaVideo implement InputPollOptionMedia.
func (*InputMediaVideo) isInputPollOptionMedia() {}
// This object contains information about one answer option in a poll.
type PollOption struct {
// Unique identifier of the option, persistent on option addition and deletion
PersistentID string `json:"persistent_id"`
// 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"`
// Optional. Media added to the poll option
Media *PollMedia `json:"media,omitempty"`
// Number of users who voted for this option; may be 0 if unknown
VoterCount int64 `json:"voter_count"`
// Optional. User who added the option; omitted if the option wasn't added by a user after poll creation
AddedByUser *User `json:"added_by_user,omitempty"`
// Optional. Chat that added the option; omitted if the option wasn't added by a chat after poll creation
AddedByChat *Chat `json:"added_by_chat,omitempty"`
// Optional. Point in time (Unix timestamp) when the option was added; omitted if the option existed in the original poll
AdditionDate *int64 `json:"addition_date,omitempty"`
}
// This object contains information about one answer option in a poll to be sent.
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
TextParseMode ParseMode `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"`
// Optional. Media added to the poll option
Media InputPollOptionMedia `json:"media,omitempty"`
}
// This object represents an answer of a user in a non-anonymous poll.
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"`
// Persistent identifiers of the chosen answer options. May be empty if the vote was retracted.
OptionPersistentIds []string `json:"option_persistent_ids"`
}
// This object contains information about a 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 PollType `json:"type"`
// True, if the poll allows multiple answers
AllowsMultipleAnswers bool `json:"allows_multiple_answers"`
// True, if the poll allows to change the chosen answer options
AllowsRevoting bool `json:"allows_revoting"`
// True if voting is limited to users who have been members of the chat where the poll was originally sent for more than 24 hours
MembersOnly bool `json:"members_only"`
// Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which users can vote in the poll. If omitted, then users from any country can participate in the poll.
CountryCodes []string `json:"country_codes,omitempty"`
// Optional. Array of 0-based identifiers of the correct answer options. Available only for polls in quiz mode which are closed or were sent (not forwarded) by the bot or to the private chat with the bot.
CorrectOptionIds []int64 `json:"correct_option_ids,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. Media added to the quiz explanation
ExplanationMedia *PollMedia `json:"explanation_media,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"`
// Optional. Description of the poll; for polls inside the Message object only
Description string `json:"description,omitempty"`
// Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the description
DescriptionEntities []MessageEntity `json:"description_entities,omitempty"`
// Optional. Media added to the poll description; for polls inside the Message object only
Media *PollMedia `json:"media,omitempty"`
}
// Describes a task in a checklist.
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"`
}
// Describes a 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"`
}
// Describes a task to add to a checklist.
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.
ParseMode ParseMode `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, custom_emoji, and date_time entities are allowed.
TextEntities []MessageEntity `json:"text_entities,omitempty"`
}
// Describes a checklist to create.
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.
ParseMode ParseMode `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, custom_emoji, and date_time 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"`
}
// Describes a service message about checklist tasks marked as done or not done.
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.
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"`
}
// Describes a service message about tasks added to a checklist.
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.
ChecklistMessage *Message `json:"checklist_message,omitempty"`
// List of tasks added to the checklist
Tasks []ChecklistTask `json:"tasks"`
}
// This object represents a point on the map.
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"`
}
// This object represents a 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.)
GooglePlaceType string `json:"google_place_type,omitempty"`
}
// Describes data sent from a Web App to the bot.
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"`
}
// 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 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"`
}
// This object represents a service message about a change in auto-delete timer settings.
type MessageAutoDeleteTimerChanged struct {
// New auto-delete time for messages in the chat; in seconds
MessageAutoDeleteTime int64 `json:"message_auto_delete_time"`
}
// This object contains information about the bot that was created to be managed by the current bot.
type ManagedBotCreated struct {
// Information about the bot. The bot's token can be fetched using the method getManagedBotToken.
Bot User `json:"bot"`
}
// This object contains information about the creation, token update, or owner update of a bot that is managed by the current bot.
type ManagedBotUpdated struct {
// User that created the bot
User User `json:"user"`
// Information about the bot. Token of the bot can be fetched using the method getManagedBotToken.
Bot User `json:"bot"`
}
// Describes a service message about an option added to a poll.
type PollOptionAdded struct {
// Optional. Message containing the poll to which the option was added, if known. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
PollMessage MaybeInaccessibleMessage `json:"poll_message,omitempty"`
// Unique identifier of the added option
OptionPersistentID string `json:"option_persistent_id"`
// Option text
OptionText string `json:"option_text"`
// Optional. Special entities that appear in the option_text
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
}
// UnmarshalJSON decodes PollOptionAdded by dispatching union-typed fields
// (PollMessage) through their concrete UnmarshalXxx helpers.
func (m *PollOptionAdded) UnmarshalJSON(data []byte) error {
type Alias PollOptionAdded
aux := &struct {
PollMessage json.RawMessage `json:"poll_message,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.PollMessage) > 0 && string(aux.PollMessage) != "null" {
v, err := UnmarshalMaybeInaccessibleMessage(aux.PollMessage)
if err != nil {
return fmt.Errorf("decoding poll_message: %w", err)
}
m.PollMessage = v
}
return nil
}
// Describes a service message about an option deleted from a poll.
type PollOptionDeleted struct {
// Optional. Message containing the poll from which the option was deleted, if known. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
PollMessage MaybeInaccessibleMessage `json:"poll_message,omitempty"`
// Unique identifier of the deleted option
OptionPersistentID string `json:"option_persistent_id"`
// Option text
OptionText string `json:"option_text"`
// Optional. Special entities that appear in the option_text
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
}
// UnmarshalJSON decodes PollOptionDeleted by dispatching union-typed fields
// (PollMessage) through their concrete UnmarshalXxx helpers.
func (m *PollOptionDeleted) UnmarshalJSON(data []byte) error {
type Alias PollOptionDeleted
aux := &struct {
PollMessage json.RawMessage `json:"poll_message,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.PollMessage) > 0 && string(aux.PollMessage) != "null" {
v, err := UnmarshalMaybeInaccessibleMessage(aux.PollMessage)
if err != nil {
return fmt.Errorf("decoding poll_message: %w", err)
}
m.PollMessage = v
}
return nil
}
// This object represents a service message about a user boosting a chat.
type ChatBoostAdded struct {
// Number of boosts added by the user
BoostCount int64 `json:"boost_count"`
}
// BackgroundFill is a union type. The following concrete variants implement
// it:
// - BackgroundFillSolid
// - BackgroundFillGradient
// - BackgroundFillFreeformGradient
//
// This object describes the way a background is filled based on the selected colors. Currently, it can be one of
type BackgroundFill interface{ isBackgroundFill() }
// isBackgroundFill is the marker method that makes BackgroundFillSolid implement BackgroundFill.
func (*BackgroundFillSolid) isBackgroundFill() {}
// isBackgroundFill is the marker method that makes BackgroundFillGradient implement BackgroundFill.
func (*BackgroundFillGradient) isBackgroundFill() {}
// isBackgroundFill is the marker method that makes BackgroundFillFreeformGradient implement BackgroundFill.
func (*BackgroundFillFreeformGradient) isBackgroundFill() {}
// UnmarshalBackgroundFill decodes a BackgroundFill from JSON by inspecting the
// "type" field and dispatching to the correct concrete type.
func UnmarshalBackgroundFill(data []byte) (BackgroundFill, error) {
var probe struct {
V string `json:"type"`
}
if err := json.Unmarshal(data, &probe); err != nil {
return nil, err
}
var v BackgroundFill
switch probe.V {
case "freeform_gradient":
v = &BackgroundFillFreeformGradient{}
case "gradient":
v = &BackgroundFillGradient{}
case "solid":
v = &BackgroundFillSolid{}
default:
return nil, fmt.Errorf("BackgroundFill: unknown type %q", probe.V)
}
if err := json.Unmarshal(data, v); err != nil {
return nil, err
}
return v, nil
}
// The background is filled using the selected color.
type BackgroundFillSolid struct {
// Type of the background fill, always “solid”
Type BackgroundFillType `json:"type"`
// The color of the background fill in the RGB24 format
Color int64 `json:"color"`
}
// MarshalJSON encodes BackgroundFillSolid with the discriminator field
// "type" forced to "solid".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BackgroundFillSolid) MarshalJSON() ([]byte, error) {
type alias BackgroundFillSolid
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "solid",
alias: (*alias)(v),
})
}
// The background is a gradient fill.
type BackgroundFillGradient struct {
// Type of the background fill, always “gradient”
Type BackgroundFillType `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"`
}
// MarshalJSON encodes BackgroundFillGradient with the discriminator field
// "type" forced to "gradient".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BackgroundFillGradient) MarshalJSON() ([]byte, error) {
type alias BackgroundFillGradient
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "gradient",
alias: (*alias)(v),
})
}
// The background is a freeform gradient that rotates after every message in the chat.
type BackgroundFillFreeformGradient struct {
// Type of the background fill, always “freeform_gradient”
Type BackgroundFillType `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"`
}
// MarshalJSON encodes BackgroundFillFreeformGradient with the discriminator field
// "type" forced to "freeform_gradient".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BackgroundFillFreeformGradient) MarshalJSON() ([]byte, error) {
type alias BackgroundFillFreeformGradient
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "freeform_gradient",
alias: (*alias)(v),
})
}
// BackgroundType is a union type. The following concrete variants implement
// it:
// - BackgroundTypeFill
// - BackgroundTypeWallpaper
// - BackgroundTypePattern
// - BackgroundTypeChatTheme
//
// This object describes the type of a background. Currently, it can be one of
type BackgroundType interface{ isBackgroundType() }
// isBackgroundType is the marker method that makes BackgroundTypeFill implement BackgroundType.
func (*BackgroundTypeFill) isBackgroundType() {}
// isBackgroundType is the marker method that makes BackgroundTypeWallpaper implement BackgroundType.
func (*BackgroundTypeWallpaper) isBackgroundType() {}
// isBackgroundType is the marker method that makes BackgroundTypePattern implement BackgroundType.
func (*BackgroundTypePattern) isBackgroundType() {}
// isBackgroundType is the marker method that makes BackgroundTypeChatTheme implement BackgroundType.
func (*BackgroundTypeChatTheme) isBackgroundType() {}
// UnmarshalBackgroundType decodes a BackgroundType from JSON by inspecting the
// "type" field and dispatching to the correct concrete type.
func UnmarshalBackgroundType(data []byte) (BackgroundType, error) {
var probe struct {
V string `json:"type"`
}
if err := json.Unmarshal(data, &probe); err != nil {
return nil, err
}
var v BackgroundType
switch probe.V {
case "chat_theme":
v = &BackgroundTypeChatTheme{}
case "fill":
v = &BackgroundTypeFill{}
case "pattern":
v = &BackgroundTypePattern{}
case "wallpaper":
v = &BackgroundTypeWallpaper{}
default:
return nil, fmt.Errorf("BackgroundType: unknown type %q", probe.V)
}
if err := json.Unmarshal(data, v); err != nil {
return nil, err
}
return v, nil
}
// The background is automatically filled based on the selected colors.
type BackgroundTypeFill struct {
// Type of the background, always “fill”
Type BackgroundTypeKind `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"`
}
// MarshalJSON encodes BackgroundTypeFill with the discriminator field
// "type" forced to "fill".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BackgroundTypeFill) MarshalJSON() ([]byte, error) {
type alias BackgroundTypeFill
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "fill",
alias: (*alias)(v),
})
}
// UnmarshalJSON decodes BackgroundTypeFill by dispatching union-typed fields
// (Fill) through their concrete UnmarshalXxx helpers.
func (m *BackgroundTypeFill) UnmarshalJSON(data []byte) error {
type Alias BackgroundTypeFill
aux := &struct {
Fill json.RawMessage `json:"fill,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.Fill) > 0 && string(aux.Fill) != "null" {
v, err := UnmarshalBackgroundFill(aux.Fill)
if err != nil {
return fmt.Errorf("decoding fill: %w", err)
}
m.Fill = v
}
return nil
}
// The background is a wallpaper in the JPEG format.
type BackgroundTypeWallpaper struct {
// Type of the background, always “wallpaper”
Type BackgroundTypeKind `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"`
}
// MarshalJSON encodes BackgroundTypeWallpaper with the discriminator field
// "type" forced to "wallpaper".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BackgroundTypeWallpaper) MarshalJSON() ([]byte, error) {
type alias BackgroundTypeWallpaper
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "wallpaper",
alias: (*alias)(v),
})
}
// 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 BackgroundTypePattern struct {
// Type of the background, always “pattern”
Type BackgroundTypeKind `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"`
}
// MarshalJSON encodes BackgroundTypePattern with the discriminator field
// "type" forced to "pattern".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BackgroundTypePattern) MarshalJSON() ([]byte, error) {
type alias BackgroundTypePattern
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "pattern",
alias: (*alias)(v),
})
}
// UnmarshalJSON decodes BackgroundTypePattern by dispatching union-typed fields
// (Fill) through their concrete UnmarshalXxx helpers.
func (m *BackgroundTypePattern) UnmarshalJSON(data []byte) error {
type Alias BackgroundTypePattern
aux := &struct {
Fill json.RawMessage `json:"fill,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.Fill) > 0 && string(aux.Fill) != "null" {
v, err := UnmarshalBackgroundFill(aux.Fill)
if err != nil {
return fmt.Errorf("decoding fill: %w", err)
}
m.Fill = v
}
return nil
}
// The background is taken directly from a built-in chat theme.
type BackgroundTypeChatTheme struct {
// Type of the background, always “chat_theme”
Type BackgroundTypeKind `json:"type"`
// Name of the chat theme, which is usually an emoji
ThemeName string `json:"theme_name"`
}
// MarshalJSON encodes BackgroundTypeChatTheme with the discriminator field
// "type" forced to "chat_theme".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BackgroundTypeChatTheme) MarshalJSON() ([]byte, error) {
type alias BackgroundTypeChatTheme
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "chat_theme",
alias: (*alias)(v),
})
}
// This object represents a chat background.
type ChatBackground struct {
// Type of the background
Type BackgroundType `json:"type"`
}
// UnmarshalJSON decodes ChatBackground by dispatching union-typed fields
// (Type) through their concrete UnmarshalXxx helpers.
func (m *ChatBackground) UnmarshalJSON(data []byte) error {
type Alias ChatBackground
aux := &struct {
Type json.RawMessage `json:"type,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.Type) > 0 && string(aux.Type) != "null" {
v, err := UnmarshalBackgroundType(aux.Type)
if err != nil {
return fmt.Errorf("decoding type: %w", err)
}
m.Type = v
}
return nil
}
// This object represents a service message about a new forum topic created in the chat.
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"`
}
// This object represents a service message about a forum topic closed in the chat. Currently holds no information.
type ForumTopicClosed struct {
}
// This object represents a service message about an edited forum topic.
type ForumTopicEdited struct {
// Optional. New name of the topic, if it was edited
Name string `json:"name,omitempty"`
// Optional. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
}
// This object represents a service message about a forum topic reopened in the chat. Currently holds no information.
type ForumTopicReopened struct {
}
// This object represents a service message about General forum topic hidden in the chat. Currently holds no information.
type GeneralForumTopicHidden struct {
}
// This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.
type GeneralForumTopicUnhidden struct {
}
// This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.
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"`
}
// This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button.
type UsersShared struct {
// Identifier of the request
RequestID int64 `json:"request_id"`
// Information about users shared with the bot.
Users []SharedUser `json:"users"`
}
// This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.
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"`
}
// 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.
type WriteAccessAllowed struct {
// Optional. True, if the access was granted after the user accepted an explicit request from a Web App sent by the method requestWriteAccess
FromRequest *bool `json:"from_request,omitempty"`
// Optional. Name of the Web App, if the access was granted when the Web App was launched from a link
WebAppName string `json:"web_app_name,omitempty"`
// Optional. True, if the access was granted when the bot was added to the attachment or side menu
FromAttachmentMenu *bool `json:"from_attachment_menu,omitempty"`
}
// This object represents a service message about a video chat scheduled in the chat.
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"`
}
// This object represents a service message about a video chat started in the chat. Currently holds no information.
type VideoChatStarted struct {
}
// This object represents a service message about a video chat ended in the chat.
type VideoChatEnded struct {
// Video chat duration in seconds
Duration int64 `json:"duration"`
}
// This object represents a service message about new members invited to a video chat.
type VideoChatParticipantsInvited struct {
// New members that were invited to the video chat
Users []User `json:"users"`
}
// Describes a service message about a change in the price of paid messages within a chat.
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"`
}
// Describes a service message about a change in the price of direct messages sent to a channel chat.
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"`
}
// Describes a service message about the approval of a suggested post.
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.
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"`
}
// 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 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.
SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`
// Expected price of the post
Price SuggestedPostPrice `json:"price"`
}
// Describes a service message about the rejection of a suggested post.
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.
SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`
// Optional. Comment with which the post was declined
Comment string `json:"comment,omitempty"`
}
// Describes a service message about a successful payment for a suggested post.
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.
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 SuggestedPostPaidCurrency `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"`
}
// Describes a service message about a payment refund for a suggested post.
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.
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 SuggestedPostRefundedReason `json:"reason"`
}
// This object represents a service message about the creation of a scheduled giveaway.
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"`
}
// This object represents a message about a scheduled 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.
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"`
}
// This object represents a message about the completion of a giveaway with public winners.
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"`
}
// This object represents a service message about the completion of a giveaway without public winners.
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"`
}
// Describes the options used for link preview generation.
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"`
}
// Describes the price of a suggested post.
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 SuggestedPostPaidCurrency `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"`
}
// Contains information about a suggested post.
type SuggestedPostInfo struct {
// State of the suggested post. Currently, it can be one of “pending”, “approved”, “declined”.
State SuggestedPostInfoState `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"`
}
// Contains parameters of a post that is being suggested by the bot.
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"`
}
// Describes a topic of a direct messages chat.
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"`
}
// This object represent a user's profile pictures.
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"`
}
// This object represents the audios displayed on a user's profile.
type UserProfileAudios struct {
// Total number of profile audios for the target user
TotalCount int64 `json:"total_count"`
// Requested profile audios
Audios []Audio `json:"audios"`
}
// 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.
// The maximum file size to download is 20 MB
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"`
}
// Describes a Web App.
type WebAppInfo struct {
// An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps
URL string `json:"url"`
}
// 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 business account.
type ReplyKeyboardMarkup struct {
// Array of button rows, each represented by an Array of KeyboardButton objects
Keyboard [][]KeyboardButton `json:"keyboard"`
// Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.
IsPersistent *bool `json:"is_persistent,omitempty"`
// Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
ResizeKeyboard *bool `json:"resize_keyboard,omitempty"`
// Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.
OneTimeKeyboard *bool `json:"one_time_keyboard,omitempty"`
// Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters
InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"`
// Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.
Selective *bool `json:"selective,omitempty"`
}
// This object represents 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 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.
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 KeyboardButtonStyle `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 specified, pressing the button will ask the user to create and share a bot that will be managed by the current bot. Available for bots that enabled management of other bots in the @BotFather Mini App. Available in private chats only.
RequestManagedBot *KeyboardButtonRequestManagedBot `json:"request_managed_bot,omitempty"`
// Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.
RequestContact *bool `json:"request_contact,omitempty"`
// Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.
RequestLocation *bool `json:"request_location,omitempty"`
// Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.
RequestPoll *KeyboardButtonPollType `json:"request_poll,omitempty"`
// Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only.
WebApp *WebAppInfo `json:"web_app,omitempty"`
}
// This object 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 KeyboardButtonRequestUsers struct {
// Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message
RequestID 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"`
}
// 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 KeyboardButtonRequestChat struct {
// Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message
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"`
}
// This object defines the parameters for the creation of a managed bot. Information about the created bot will be shared with the bot using the update managed_bot and a Message with the field managed_bot_created.
type KeyboardButtonRequestManagedBot struct {
// Signed 32-bit identifier of the request. Must be unique within the message
RequestID int64 `json:"request_id"`
// Optional. Suggested name for the bot
SuggestedName string `json:"suggested_name,omitempty"`
// Optional. Suggested username for the bot
SuggestedUsername string `json:"suggested_username,omitempty"`
}
// This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
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"`
}
// 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 business account.
type ReplyKeyboardRemove struct {
// Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)
RemoveKeyboard bool `json:"remove_keyboard"`
// Optional. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.
Selective *bool `json:"selective,omitempty"`
}
// This object represents an inline keyboard that appears right next to the message it belongs to.
type InlineKeyboardMarkup struct {
// Array of button rows, each represented by an Array of InlineKeyboardButton objects
InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"`
}
// 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.
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.
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 KeyboardButtonStyle `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
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 business account.
WebApp *WebAppInfo `json:"web_app,omitempty"`
// Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.
LoginURL *LoginUrl `json:"login_url,omitempty"`
// Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a 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 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 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 *bool `json:"pay,omitempty"`
}
// This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:
// Telegram apps support these buttons as of version 5.7.
// Sample bot: @discussbot
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.
URL string `json:"url"`
// Optional. New text of the button in forwarded messages.
ForwardText string `json:"forward_text,omitempty"`
// Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details.
BotUsername string `json:"bot_username,omitempty"`
// Optional. Pass True to request the permission for your bot to send messages to the user.
RequestWriteAccess *bool `json:"request_write_access,omitempty"`
}
// This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.
type SwitchInlineQueryChosenChat struct {
// Optional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted
Query string `json:"query,omitempty"`
// Optional. True, if private chats with users can be chosen
AllowUserChats *bool `json:"allow_user_chats,omitempty"`
// Optional. True, if private chats with bots can be chosen
AllowBotChats *bool `json:"allow_bot_chats,omitempty"`
// Optional. True, if group and supergroup chats can be chosen
AllowGroupChats *bool `json:"allow_group_chats,omitempty"`
// Optional. True, if channel chats can be chosen
AllowChannelChats *bool `json:"allow_channel_chats,omitempty"`
}
// This object represents an inline keyboard button that copies specified text to the clipboard.
type CopyTextButton struct {
// The text to be copied to the clipboard; 1-256 characters
Text string `json:"text"`
}
// 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.
// NOTE: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters).
type CallbackQuery struct {
// Unique identifier for this query
ID string `json:"id"`
// Sender
From User `json:"from"`
// Optional. Message sent by the bot with the callback button that originated the query
Message MaybeInaccessibleMessage `json:"message,omitempty"`
// Optional. Identifier of the message sent via the bot in inline mode, that originated the query.
InlineMessageID string `json:"inline_message_id,omitempty"`
// Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.
ChatInstance string `json:"chat_instance"`
// Optional. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.
Data string `json:"data,omitempty"`
// Optional. Short name of a Game to be returned, serves as the unique identifier for the game
GameShortName string `json:"game_short_name,omitempty"`
}
// UnmarshalJSON decodes CallbackQuery by dispatching union-typed fields
// (Message) through their concrete UnmarshalXxx helpers.
func (m *CallbackQuery) UnmarshalJSON(data []byte) error {
type Alias CallbackQuery
aux := &struct {
Message json.RawMessage `json:"message,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.Message) > 0 && string(aux.Message) != "null" {
v, err := UnmarshalMaybeInaccessibleMessage(aux.Message)
if err != nil {
return fmt.Errorf("decoding message: %w", err)
}
m.Message = v
}
return nil
}
// 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 user account.
// Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:
// The last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.
type ForceReply struct {
// Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'
ForceReply bool `json:"force_reply"`
// Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters
InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"`
// Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.
Selective *bool `json:"selective,omitempty"`
}
// This object represents a chat photo.
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"`
}
// Represents an invite link for a chat.
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"`
}
// Represents the rights of an administrator in a chat.
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"`
// Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.
CanManageTags *bool `json:"can_manage_tags,omitempty"`
}
// This object represents changes in the status of a chat member.
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"`
}
// UnmarshalJSON decodes ChatMemberUpdated by dispatching union-typed fields
// (OldChatMember, NewChatMember) through their concrete UnmarshalXxx helpers.
func (m *ChatMemberUpdated) UnmarshalJSON(data []byte) error {
type Alias ChatMemberUpdated
aux := &struct {
OldChatMember json.RawMessage `json:"old_chat_member,omitempty"`
NewChatMember json.RawMessage `json:"new_chat_member,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.OldChatMember) > 0 && string(aux.OldChatMember) != "null" {
v, err := UnmarshalChatMember(aux.OldChatMember)
if err != nil {
return fmt.Errorf("decoding old_chat_member: %w", err)
}
m.OldChatMember = v
}
if len(aux.NewChatMember) > 0 && string(aux.NewChatMember) != "null" {
v, err := UnmarshalChatMember(aux.NewChatMember)
if err != nil {
return fmt.Errorf("decoding new_chat_member: %w", err)
}
m.NewChatMember = v
}
return nil
}
// ChatMember is a union type. The following concrete variants implement
// it:
// - ChatMemberOwner
// - ChatMemberAdministrator
// - ChatMemberMember
// - ChatMemberRestricted
// - ChatMemberLeft
// - ChatMemberBanned
//
// This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:
type ChatMember interface{ isChatMember() }
// isChatMember is the marker method that makes ChatMemberOwner implement ChatMember.
func (*ChatMemberOwner) isChatMember() {}
// isChatMember is the marker method that makes ChatMemberAdministrator implement ChatMember.
func (*ChatMemberAdministrator) isChatMember() {}
// isChatMember is the marker method that makes ChatMemberMember implement ChatMember.
func (*ChatMemberMember) isChatMember() {}
// isChatMember is the marker method that makes ChatMemberRestricted implement ChatMember.
func (*ChatMemberRestricted) isChatMember() {}
// isChatMember is the marker method that makes ChatMemberLeft implement ChatMember.
func (*ChatMemberLeft) isChatMember() {}
// isChatMember is the marker method that makes ChatMemberBanned implement ChatMember.
func (*ChatMemberBanned) isChatMember() {}
// UnmarshalChatMember decodes a ChatMember from JSON by inspecting the
// "status" field and dispatching to the correct concrete type.
func UnmarshalChatMember(data []byte) (ChatMember, error) {
var probe struct {
V string `json:"status"`
}
if err := json.Unmarshal(data, &probe); err != nil {
return nil, err
}
var v ChatMember
switch probe.V {
case "administrator":
v = &ChatMemberAdministrator{}
case "creator":
v = &ChatMemberOwner{}
case "kicked":
v = &ChatMemberBanned{}
case "left":
v = &ChatMemberLeft{}
case "member":
v = &ChatMemberMember{}
case "restricted":
v = &ChatMemberRestricted{}
default:
return nil, fmt.Errorf("ChatMember: unknown status %q", probe.V)
}
if err := json.Unmarshal(data, v); err != nil {
return nil, err
}
return v, nil
}
// Represents a chat member that owns the chat and has all administrator privileges.
type ChatMemberOwner struct {
// The member's status in the chat, always “creator”
Status ChatMemberStatus `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"`
}
// MarshalJSON encodes ChatMemberOwner with the discriminator field
// "status" forced to "creator".
// The hardcoded value frees callers from setting Status by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *ChatMemberOwner) MarshalJSON() ([]byte, error) {
type alias ChatMemberOwner
return json.Marshal(&struct {
Status string `json:"status"`
*alias
}{
Status: "creator",
alias: (*alias)(v),
})
}
// Represents a chat member that has some additional privileges.
type ChatMemberAdministrator struct {
// The member's status in the chat, always “administrator”
Status ChatMemberStatus `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. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.
CanManageTags *bool `json:"can_manage_tags,omitempty"`
// Optional. Custom title for this user
CustomTitle string `json:"custom_title,omitempty"`
}
// MarshalJSON encodes ChatMemberAdministrator with the discriminator field
// "status" forced to "administrator".
// The hardcoded value frees callers from setting Status by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *ChatMemberAdministrator) MarshalJSON() ([]byte, error) {
type alias ChatMemberAdministrator
return json.Marshal(&struct {
Status string `json:"status"`
*alias
}{
Status: "administrator",
alias: (*alias)(v),
})
}
// Represents a chat member that has no additional privileges or restrictions.
type ChatMemberMember struct {
// The member's status in the chat, always “member”
Status ChatMemberStatus `json:"status"`
// Optional. Tag of the member
Tag string `json:"tag,omitempty"`
// 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"`
}
// MarshalJSON encodes ChatMemberMember with the discriminator field
// "status" forced to "member".
// The hardcoded value frees callers from setting Status by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *ChatMemberMember) MarshalJSON() ([]byte, error) {
type alias ChatMemberMember
return json.Marshal(&struct {
Status string `json:"status"`
*alias
}{
Status: "member",
alias: (*alias)(v),
})
}
// Represents a chat member that is under certain restrictions in the chat. Supergroups only.
type ChatMemberRestricted struct {
// The member's status in the chat, always “restricted”
Status ChatMemberStatus `json:"status"`
// Optional. Tag of the member
Tag string `json:"tag,omitempty"`
// 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 react to messages
CanReactToMessages bool `json:"can_react_to_messages"`
// True, if the user is allowed to edit their own tag
CanEditTag bool `json:"can_edit_tag"`
// 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"`
}
// MarshalJSON encodes ChatMemberRestricted with the discriminator field
// "status" forced to "restricted".
// The hardcoded value frees callers from setting Status by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *ChatMemberRestricted) MarshalJSON() ([]byte, error) {
type alias ChatMemberRestricted
return json.Marshal(&struct {
Status string `json:"status"`
*alias
}{
Status: "restricted",
alias: (*alias)(v),
})
}
// Represents a chat member that isn't currently a member of the chat, but may join it themselves.
type ChatMemberLeft struct {
// The member's status in the chat, always “left”
Status ChatMemberStatus `json:"status"`
// Information about the user
User User `json:"user"`
}
// MarshalJSON encodes ChatMemberLeft with the discriminator field
// "status" forced to "left".
// The hardcoded value frees callers from setting Status by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *ChatMemberLeft) MarshalJSON() ([]byte, error) {
type alias ChatMemberLeft
return json.Marshal(&struct {
Status string `json:"status"`
*alias
}{
Status: "left",
alias: (*alias)(v),
})
}
// Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.
type ChatMemberBanned struct {
// The member's status in the chat, always “kicked”
Status ChatMemberStatus `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"`
}
// MarshalJSON encodes ChatMemberBanned with the discriminator field
// "status" forced to "kicked".
// The hardcoded value frees callers from setting Status by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *ChatMemberBanned) MarshalJSON() ([]byte, error) {
type alias ChatMemberBanned
return json.Marshal(&struct {
Status string `json:"status"`
*alias
}{
Status: "kicked",
alias: (*alias)(v),
})
}
// Represents a join request sent to a chat.
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"`
}
// Describes actions that a non-administrator user is allowed to take in a chat.
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 react to messages. If omitted, defaults to the value of can_send_messages.
CanReactToMessages *bool `json:"can_react_to_messages,omitempty"`
// Optional. True, if the user is allowed to edit their own tag. If omitted, defaults to the value of can_pin_messages.
CanEditTag *bool `json:"can_edit_tag,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"`
}
// Describes the birthdate of a user.
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"`
}
// Contains information about the start page settings of a Telegram Business account.
type BusinessIntro struct {
// Optional. Title text of the business intro
Title string `json:"title,omitempty"`
// Optional. Message text of the business intro
Message string `json:"message,omitempty"`
// Optional. Sticker of the business intro
Sticker *Sticker `json:"sticker,omitempty"`
}
// Contains information about the location of a Telegram Business account.
type BusinessLocation struct {
// Address of the business
Address string `json:"address"`
// Optional. Location of the business
Location *Location `json:"location,omitempty"`
}
// Describes an interval of time during which a business is open.
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"`
}
// Describes the opening hours of a business.
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"`
}
// This object describes the rating of a user based on their Telegram Star spendings.
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"`
}
// Describes the position of a clickable area within a story.
type StoryAreaPosition struct {
// The abscissa of the area's center, as a percentage of the media width
XPercentage float64 `json:"x_percentage"`
// The ordinate of the area's center, as a percentage of the media height
YPercentage float64 `json:"y_percentage"`
// The width of the area's rectangle, as a percentage of the media width
WidthPercentage float64 `json:"width_percentage"`
// The height of the area's rectangle, as a percentage of the media height
HeightPercentage float64 `json:"height_percentage"`
// The clockwise rotation angle of the rectangle, in degrees; 0-360
RotationAngle float64 `json:"rotation_angle"`
// The radius of the rectangle corner rounding, as a percentage of the media width
CornerRadiusPercentage float64 `json:"corner_radius_percentage"`
}
// Describes the physical address of a location.
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"`
}
// StoryAreaType is a union type. The following concrete variants implement
// it:
// - StoryAreaTypeLocation
// - StoryAreaTypeSuggestedReaction
// - StoryAreaTypeLink
// - StoryAreaTypeWeather
// - StoryAreaTypeUniqueGift
//
// Describes the type of a clickable area on a story. Currently, it can be one of
type StoryAreaType interface{ isStoryAreaType() }
// isStoryAreaType is the marker method that makes StoryAreaTypeLocation implement StoryAreaType.
func (*StoryAreaTypeLocation) isStoryAreaType() {}
// isStoryAreaType is the marker method that makes StoryAreaTypeSuggestedReaction implement StoryAreaType.
func (*StoryAreaTypeSuggestedReaction) isStoryAreaType() {}
// isStoryAreaType is the marker method that makes StoryAreaTypeLink implement StoryAreaType.
func (*StoryAreaTypeLink) isStoryAreaType() {}
// isStoryAreaType is the marker method that makes StoryAreaTypeWeather implement StoryAreaType.
func (*StoryAreaTypeWeather) isStoryAreaType() {}
// isStoryAreaType is the marker method that makes StoryAreaTypeUniqueGift implement StoryAreaType.
func (*StoryAreaTypeUniqueGift) isStoryAreaType() {}
// UnmarshalStoryAreaType decodes a StoryAreaType from JSON by inspecting the
// "type" field and dispatching to the correct concrete type.
func UnmarshalStoryAreaType(data []byte) (StoryAreaType, error) {
var probe struct {
V string `json:"type"`
}
if err := json.Unmarshal(data, &probe); err != nil {
return nil, err
}
var v StoryAreaType
switch probe.V {
case "link":
v = &StoryAreaTypeLink{}
case "location":
v = &StoryAreaTypeLocation{}
case "suggested_reaction":
v = &StoryAreaTypeSuggestedReaction{}
case "unique_gift":
v = &StoryAreaTypeUniqueGift{}
case "weather":
v = &StoryAreaTypeWeather{}
default:
return nil, fmt.Errorf("StoryAreaType: unknown type %q", probe.V)
}
if err := json.Unmarshal(data, v); err != nil {
return nil, err
}
return v, nil
}
// Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.
type StoryAreaTypeLocation struct {
// Type of the area, always “location”
Type StoryAreaTypeKind `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"`
}
// MarshalJSON encodes StoryAreaTypeLocation with the discriminator field
// "type" forced to "location".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *StoryAreaTypeLocation) MarshalJSON() ([]byte, error) {
type alias StoryAreaTypeLocation
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "location",
alias: (*alias)(v),
})
}
// Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.
type StoryAreaTypeSuggestedReaction struct {
// Type of the area, always “suggested_reaction”
Type StoryAreaTypeKind `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"`
}
// MarshalJSON encodes StoryAreaTypeSuggestedReaction with the discriminator field
// "type" forced to "suggested_reaction".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *StoryAreaTypeSuggestedReaction) MarshalJSON() ([]byte, error) {
type alias StoryAreaTypeSuggestedReaction
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "suggested_reaction",
alias: (*alias)(v),
})
}
// UnmarshalJSON decodes StoryAreaTypeSuggestedReaction by dispatching union-typed fields
// (ReactionType) through their concrete UnmarshalXxx helpers.
func (m *StoryAreaTypeSuggestedReaction) UnmarshalJSON(data []byte) error {
type Alias StoryAreaTypeSuggestedReaction
aux := &struct {
ReactionType json.RawMessage `json:"reaction_type,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.ReactionType) > 0 && string(aux.ReactionType) != "null" {
v, err := UnmarshalReactionType(aux.ReactionType)
if err != nil {
return fmt.Errorf("decoding reaction_type: %w", err)
}
m.ReactionType = v
}
return nil
}
// Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.
type StoryAreaTypeLink struct {
// Type of the area, always “link”
Type StoryAreaTypeKind `json:"type"`
// HTTP or tg:// URL to be opened when the area is clicked
URL string `json:"url"`
}
// MarshalJSON encodes StoryAreaTypeLink with the discriminator field
// "type" forced to "link".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *StoryAreaTypeLink) MarshalJSON() ([]byte, error) {
type alias StoryAreaTypeLink
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "link",
alias: (*alias)(v),
})
}
// Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.
type StoryAreaTypeWeather struct {
// Type of the area, always “weather”
Type StoryAreaTypeKind `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"`
}
// MarshalJSON encodes StoryAreaTypeWeather with the discriminator field
// "type" forced to "weather".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *StoryAreaTypeWeather) MarshalJSON() ([]byte, error) {
type alias StoryAreaTypeWeather
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "weather",
alias: (*alias)(v),
})
}
// Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.
type StoryAreaTypeUniqueGift struct {
// Type of the area, always “unique_gift”
Type StoryAreaTypeKind `json:"type"`
// Unique name of the gift
Name string `json:"name"`
}
// MarshalJSON encodes StoryAreaTypeUniqueGift with the discriminator field
// "type" forced to "unique_gift".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *StoryAreaTypeUniqueGift) MarshalJSON() ([]byte, error) {
type alias StoryAreaTypeUniqueGift
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "unique_gift",
alias: (*alias)(v),
})
}
// Describes a clickable area on a story media.
type StoryArea struct {
// Position of the area
Position StoryAreaPosition `json:"position"`
// Type of the area
Type StoryAreaType `json:"type"`
}
// UnmarshalJSON decodes StoryArea by dispatching union-typed fields
// (Type) through their concrete UnmarshalXxx helpers.
func (m *StoryArea) UnmarshalJSON(data []byte) error {
type Alias StoryArea
aux := &struct {
Type json.RawMessage `json:"type,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.Type) > 0 && string(aux.Type) != "null" {
v, err := UnmarshalStoryAreaType(aux.Type)
if err != nil {
return fmt.Errorf("decoding type: %w", err)
}
m.Type = v
}
return nil
}
// Represents a location to which a chat is connected.
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"`
}
// ReactionType is a union type. The following concrete variants implement
// it:
// - ReactionTypeEmoji
// - ReactionTypeCustomEmoji
// - ReactionTypePaid
//
// This object describes the type of a reaction. Currently, it can be one of
type ReactionType interface{ isReactionType() }
// isReactionType is the marker method that makes ReactionTypeEmoji implement ReactionType.
func (*ReactionTypeEmoji) isReactionType() {}
// isReactionType is the marker method that makes ReactionTypeCustomEmoji implement ReactionType.
func (*ReactionTypeCustomEmoji) isReactionType() {}
// isReactionType is the marker method that makes ReactionTypePaid implement ReactionType.
func (*ReactionTypePaid) isReactionType() {}
// UnmarshalReactionType decodes a ReactionType from JSON by inspecting the
// "type" field and dispatching to the correct concrete type.
func UnmarshalReactionType(data []byte) (ReactionType, error) {
var probe struct {
V string `json:"type"`
}
if err := json.Unmarshal(data, &probe); err != nil {
return nil, err
}
var v ReactionType
switch probe.V {
case "custom_emoji":
v = &ReactionTypeCustomEmoji{}
case "emoji":
v = &ReactionTypeEmoji{}
case "paid":
v = &ReactionTypePaid{}
default:
return nil, fmt.Errorf("ReactionType: unknown type %q", probe.V)
}
if err := json.Unmarshal(data, v); err != nil {
return nil, err
}
return v, nil
}
// The reaction is based on an emoji.
type ReactionTypeEmoji struct {
// Type of the reaction, always “emoji”
Type ReactionTypeKind `json:"type"`
// Reaction emoji. Currently, it can be one of "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", ""
Emoji ReactionEmoji `json:"emoji"`
}
// MarshalJSON encodes ReactionTypeEmoji with the discriminator field
// "type" forced to "emoji".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *ReactionTypeEmoji) MarshalJSON() ([]byte, error) {
type alias ReactionTypeEmoji
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "emoji",
alias: (*alias)(v),
})
}
// The reaction is based on a custom emoji.
type ReactionTypeCustomEmoji struct {
// Type of the reaction, always “custom_emoji”
Type ReactionTypeKind `json:"type"`
// Custom emoji identifier
CustomEmojiID string `json:"custom_emoji_id"`
}
// MarshalJSON encodes ReactionTypeCustomEmoji with the discriminator field
// "type" forced to "custom_emoji".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *ReactionTypeCustomEmoji) MarshalJSON() ([]byte, error) {
type alias ReactionTypeCustomEmoji
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "custom_emoji",
alias: (*alias)(v),
})
}
// The reaction is paid.
type ReactionTypePaid struct {
// Type of the reaction, always “paid”
Type ReactionTypeKind `json:"type"`
}
// MarshalJSON encodes ReactionTypePaid with the discriminator field
// "type" forced to "paid".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *ReactionTypePaid) MarshalJSON() ([]byte, error) {
type alias ReactionTypePaid
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "paid",
alias: (*alias)(v),
})
}
// Represents a reaction added to a message along with the number of times it was added.
type ReactionCount struct {
// Type of the reaction
Type ReactionType `json:"type"`
// Number of times the reaction was added
TotalCount int64 `json:"total_count"`
}
// UnmarshalJSON decodes ReactionCount by dispatching union-typed fields
// (Type) through their concrete UnmarshalXxx helpers.
func (m *ReactionCount) UnmarshalJSON(data []byte) error {
type Alias ReactionCount
aux := &struct {
Type json.RawMessage `json:"type,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.Type) > 0 && string(aux.Type) != "null" {
v, err := UnmarshalReactionType(aux.Type)
if err != nil {
return fmt.Errorf("decoding type: %w", err)
}
m.Type = v
}
return nil
}
// This object represents a change of a reaction on a message performed by a user.
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"`
}
// UnmarshalJSON decodes MessageReactionUpdated by dispatching union-typed fields
// (OldReaction, NewReaction) through their concrete UnmarshalXxx helpers.
func (m *MessageReactionUpdated) UnmarshalJSON(data []byte) error {
type Alias MessageReactionUpdated
aux := &struct {
OldReaction json.RawMessage `json:"old_reaction,omitempty"`
NewReaction json.RawMessage `json:"new_reaction,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.OldReaction) > 0 && string(aux.OldReaction) != "null" {
var raws []json.RawMessage
if err := json.Unmarshal(aux.OldReaction, &raws); err != nil {
return fmt.Errorf("decoding old_reaction: %w", err)
}
decoded := make([]ReactionType, 0, len(raws))
for i, r := range raws {
v, err := UnmarshalReactionType(r)
if err != nil {
return fmt.Errorf("decoding old_reaction[%d]: %w", i, err)
}
decoded = append(decoded, v)
}
m.OldReaction = decoded
}
if len(aux.NewReaction) > 0 && string(aux.NewReaction) != "null" {
var raws []json.RawMessage
if err := json.Unmarshal(aux.NewReaction, &raws); err != nil {
return fmt.Errorf("decoding new_reaction: %w", err)
}
decoded := make([]ReactionType, 0, len(raws))
for i, r := range raws {
v, err := UnmarshalReactionType(r)
if err != nil {
return fmt.Errorf("decoding new_reaction[%d]: %w", i, err)
}
decoded = append(decoded, v)
}
m.NewReaction = decoded
}
return nil
}
// This object represents reaction changes on a message with anonymous reactions.
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"`
}
// This object represents a forum topic.
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"`
}
// This object describes the background of a gift.
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"`
}
// This object represents a gift that can be sent by the bot.
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"`
}
// This object represent a list of gifts.
type Gifts struct {
// The list of gifts
Gifts []Gift `json:"gifts"`
}
// This object describes the model of a unique gift.
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 UniqueGiftModelRarity `json:"rarity,omitempty"`
}
// This object describes the symbol shown on the pattern of a unique gift.
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"`
}
// This object describes the colors of the backdrop of a unique gift.
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"`
}
// This object describes the backdrop of a unique gift.
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"`
}
// This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.
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"`
}
// This object describes a unique gift that was upgraded from a regular gift.
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"`
}
// Describes a service message about a regular gift that was sent or received.
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
UniqueGiftNumber *int64 `json:"unique_gift_number,omitempty"`
}
// Describes a service message about a unique gift that was sent or received.
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 UniqueGiftInfoOrigin `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 SuggestedPostPaidCurrency `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"`
}
// OwnedGift is a union type. The following concrete variants implement
// it:
// - OwnedGiftRegular
// - OwnedGiftUnique
//
// This object describes a gift received and owned by a user or a chat. Currently, it can be one of
type OwnedGift interface{ isOwnedGift() }
// isOwnedGift is the marker method that makes OwnedGiftRegular implement OwnedGift.
func (*OwnedGiftRegular) isOwnedGift() {}
// isOwnedGift is the marker method that makes OwnedGiftUnique implement OwnedGift.
func (*OwnedGiftUnique) isOwnedGift() {}
// UnmarshalOwnedGift decodes a OwnedGift from JSON by inspecting the
// "type" field and dispatching to the correct concrete type.
func UnmarshalOwnedGift(data []byte) (OwnedGift, error) {
var probe struct {
V string `json:"type"`
}
if err := json.Unmarshal(data, &probe); err != nil {
return nil, err
}
var v OwnedGift
switch probe.V {
case "regular":
v = &OwnedGiftRegular{}
case "unique":
v = &OwnedGiftUnique{}
default:
return nil, fmt.Errorf("OwnedGift: unknown type %q", probe.V)
}
if err := json.Unmarshal(data, v); err != nil {
return nil, err
}
return v, nil
}
// Describes a regular gift owned by a user or a chat.
type OwnedGiftRegular struct {
// Type of the gift, always “regular”
Type OwnedGiftType `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
UniqueGiftNumber *int64 `json:"unique_gift_number,omitempty"`
}
// MarshalJSON encodes OwnedGiftRegular with the discriminator field
// "type" forced to "regular".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *OwnedGiftRegular) MarshalJSON() ([]byte, error) {
type alias OwnedGiftRegular
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "regular",
alias: (*alias)(v),
})
}
// Describes a unique gift received and owned by a user or a chat.
type OwnedGiftUnique struct {
// Type of the gift, always “unique”
Type OwnedGiftType `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"`
}
// MarshalJSON encodes OwnedGiftUnique with the discriminator field
// "type" forced to "unique".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *OwnedGiftUnique) MarshalJSON() ([]byte, error) {
type alias OwnedGiftUnique
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "unique",
alias: (*alias)(v),
})
}
// Contains the list of gifts received and owned by a user or a chat.
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"`
}
// UnmarshalJSON decodes OwnedGifts by dispatching union-typed fields
// (Gifts) through their concrete UnmarshalXxx helpers.
func (m *OwnedGifts) UnmarshalJSON(data []byte) error {
type Alias OwnedGifts
aux := &struct {
Gifts json.RawMessage `json:"gifts,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.Gifts) > 0 && string(aux.Gifts) != "null" {
var raws []json.RawMessage
if err := json.Unmarshal(aux.Gifts, &raws); err != nil {
return fmt.Errorf("decoding gifts: %w", err)
}
decoded := make([]OwnedGift, 0, len(raws))
for i, r := range raws {
v, err := UnmarshalOwnedGift(r)
if err != nil {
return fmt.Errorf("decoding gifts[%d]: %w", i, err)
}
decoded = append(decoded, v)
}
m.Gifts = decoded
}
return nil
}
// This object describes the access settings of a bot.
type BotAccessSettings struct {
// True, if only selected users can access the bot. The bot's owner can always access it.
IsAccessRestricted bool `json:"is_access_restricted"`
// Optional. The list of other users who have access to the bot if the access is restricted
AddedUsers []User `json:"added_users,omitempty"`
}
// This object describes the types of gifts that can be gifted to a user or a chat.
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"`
}
// Describes an amount of Telegram Stars.
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"`
}
// This object represents a bot command.
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"`
}
// BotCommandScope is a union type. The following concrete variants implement
// it:
// - BotCommandScopeDefault
// - BotCommandScopeAllPrivateChats
// - BotCommandScopeAllGroupChats
// - BotCommandScopeAllChatAdministrators
// - BotCommandScopeChat
// - BotCommandScopeChatAdministrators
// - BotCommandScopeChatMember
//
// This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:
type BotCommandScope interface{ isBotCommandScope() }
// isBotCommandScope is the marker method that makes BotCommandScopeDefault implement BotCommandScope.
func (*BotCommandScopeDefault) isBotCommandScope() {}
// isBotCommandScope is the marker method that makes BotCommandScopeAllPrivateChats implement BotCommandScope.
func (*BotCommandScopeAllPrivateChats) isBotCommandScope() {}
// isBotCommandScope is the marker method that makes BotCommandScopeAllGroupChats implement BotCommandScope.
func (*BotCommandScopeAllGroupChats) isBotCommandScope() {}
// isBotCommandScope is the marker method that makes BotCommandScopeAllChatAdministrators implement BotCommandScope.
func (*BotCommandScopeAllChatAdministrators) isBotCommandScope() {}
// isBotCommandScope is the marker method that makes BotCommandScopeChat implement BotCommandScope.
func (*BotCommandScopeChat) isBotCommandScope() {}
// isBotCommandScope is the marker method that makes BotCommandScopeChatAdministrators implement BotCommandScope.
func (*BotCommandScopeChatAdministrators) isBotCommandScope() {}
// isBotCommandScope is the marker method that makes BotCommandScopeChatMember implement BotCommandScope.
func (*BotCommandScopeChatMember) isBotCommandScope() {}
// Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.
type BotCommandScopeDefault struct {
// Scope type, must be default
Type BotCommandScopeType `json:"type"`
}
// MarshalJSON encodes BotCommandScopeDefault with the discriminator field
// "type" forced to "default".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BotCommandScopeDefault) MarshalJSON() ([]byte, error) {
type alias BotCommandScopeDefault
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "default",
alias: (*alias)(v),
})
}
// Represents the scope of bot commands, covering all private chats.
type BotCommandScopeAllPrivateChats struct {
// Scope type, must be all_private_chats
Type BotCommandScopeType `json:"type"`
}
// MarshalJSON encodes BotCommandScopeAllPrivateChats with the discriminator field
// "type" forced to "all_private_chats".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BotCommandScopeAllPrivateChats) MarshalJSON() ([]byte, error) {
type alias BotCommandScopeAllPrivateChats
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "all_private_chats",
alias: (*alias)(v),
})
}
// Represents the scope of bot commands, covering all group and supergroup chats.
type BotCommandScopeAllGroupChats struct {
// Scope type, must be all_group_chats
Type BotCommandScopeType `json:"type"`
}
// MarshalJSON encodes BotCommandScopeAllGroupChats with the discriminator field
// "type" forced to "all_group_chats".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BotCommandScopeAllGroupChats) MarshalJSON() ([]byte, error) {
type alias BotCommandScopeAllGroupChats
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "all_group_chats",
alias: (*alias)(v),
})
}
// Represents the scope of bot commands, covering all group and supergroup chat administrators.
type BotCommandScopeAllChatAdministrators struct {
// Scope type, must be all_chat_administrators
Type BotCommandScopeType `json:"type"`
}
// MarshalJSON encodes BotCommandScopeAllChatAdministrators with the discriminator field
// "type" forced to "all_chat_administrators".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BotCommandScopeAllChatAdministrators) MarshalJSON() ([]byte, error) {
type alias BotCommandScopeAllChatAdministrators
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "all_chat_administrators",
alias: (*alias)(v),
})
}
// Represents the scope of bot commands, covering a specific chat.
type BotCommandScopeChat struct {
// Scope type, must be chat
Type BotCommandScopeType `json:"type"`
// Unique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren't supported.
ChatID ChatID `json:"chat_id"`
}
// MarshalJSON encodes BotCommandScopeChat with the discriminator field
// "type" forced to "chat".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BotCommandScopeChat) MarshalJSON() ([]byte, error) {
type alias BotCommandScopeChat
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "chat",
alias: (*alias)(v),
})
}
// Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.
type BotCommandScopeChatAdministrators struct {
// Scope type, must be chat_administrators
Type BotCommandScopeType `json:"type"`
// Unique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren't supported.
ChatID ChatID `json:"chat_id"`
}
// MarshalJSON encodes BotCommandScopeChatAdministrators with the discriminator field
// "type" forced to "chat_administrators".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BotCommandScopeChatAdministrators) MarshalJSON() ([]byte, error) {
type alias BotCommandScopeChatAdministrators
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "chat_administrators",
alias: (*alias)(v),
})
}
// Represents the scope of bot commands, covering a specific member of a group or supergroup chat.
type BotCommandScopeChatMember struct {
// Scope type, must be chat_member
Type BotCommandScopeType `json:"type"`
// Unique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren't supported.
ChatID ChatID `json:"chat_id"`
// Unique identifier of the target user
UserID int64 `json:"user_id"`
}
// MarshalJSON encodes BotCommandScopeChatMember with the discriminator field
// "type" forced to "chat_member".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *BotCommandScopeChatMember) MarshalJSON() ([]byte, error) {
type alias BotCommandScopeChatMember
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "chat_member",
alias: (*alias)(v),
})
}
// This object represents the bot's name.
type BotName struct {
// The bot's name
Name string `json:"name"`
}
// This object represents the bot's description.
type BotDescription struct {
// The bot's description
Description string `json:"description"`
}
// This object represents the bot's short description.
type BotShortDescription struct {
// The bot's short description
ShortDescription string `json:"short_description"`
}
// MenuButton is a union type. The following concrete variants implement
// it:
// - MenuButtonCommands
// - MenuButtonWebApp
// - MenuButtonDefault
//
// This object describes the bot's menu button in a private chat. It should be one of
// If a menu button other than MenuButtonDefault is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands.
type MenuButton interface{ isMenuButton() }
// isMenuButton is the marker method that makes MenuButtonCommands implement MenuButton.
func (*MenuButtonCommands) isMenuButton() {}
// isMenuButton is the marker method that makes MenuButtonWebApp implement MenuButton.
func (*MenuButtonWebApp) isMenuButton() {}
// isMenuButton is the marker method that makes MenuButtonDefault implement MenuButton.
func (*MenuButtonDefault) isMenuButton() {}
// UnmarshalMenuButton decodes a MenuButton from JSON by inspecting the
// "type" field and dispatching to the correct concrete type.
func UnmarshalMenuButton(data []byte) (MenuButton, error) {
var probe struct {
V string `json:"type"`
}
if err := json.Unmarshal(data, &probe); err != nil {
return nil, err
}
var v MenuButton
switch probe.V {
case "commands":
v = &MenuButtonCommands{}
case "default":
v = &MenuButtonDefault{}
case "web_app":
v = &MenuButtonWebApp{}
default:
return nil, fmt.Errorf("MenuButton: unknown type %q", probe.V)
}
if err := json.Unmarshal(data, v); err != nil {
return nil, err
}
return v, nil
}
// Represents a menu button, which opens the bot's list of commands.
type MenuButtonCommands struct {
// Type of the button, must be commands
Type MenuButtonType `json:"type"`
}
// MarshalJSON encodes MenuButtonCommands with the discriminator field
// "type" forced to "commands".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *MenuButtonCommands) MarshalJSON() ([]byte, error) {
type alias MenuButtonCommands
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "commands",
alias: (*alias)(v),
})
}
// Represents a menu button, which launches a Web App.
type MenuButtonWebApp struct {
// Type of the button, must be web_app
Type MenuButtonType `json:"type"`
// Text on the button
Text string `json:"text"`
// Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Alternatively, a t.me link to a Web App of the bot can be specified in the object instead of the Web App's URL, in which case the Web App will be opened as if the user pressed the link.
WebApp WebAppInfo `json:"web_app"`
}
// MarshalJSON encodes MenuButtonWebApp with the discriminator field
// "type" forced to "web_app".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *MenuButtonWebApp) MarshalJSON() ([]byte, error) {
type alias MenuButtonWebApp
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "web_app",
alias: (*alias)(v),
})
}
// Describes that no specific value for the menu button was set.
type MenuButtonDefault struct {
// Type of the button, must be default
Type MenuButtonType `json:"type"`
}
// MarshalJSON encodes MenuButtonDefault with the discriminator field
// "type" forced to "default".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *MenuButtonDefault) MarshalJSON() ([]byte, error) {
type alias MenuButtonDefault
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "default",
alias: (*alias)(v),
})
}
// ChatBoostSource is a union type. The following concrete variants implement
// it:
// - ChatBoostSourcePremium
// - ChatBoostSourceGiftCode
// - ChatBoostSourceGiveaway
//
// This object describes the source of a chat boost. It can be one of
type ChatBoostSource interface{ isChatBoostSource() }
// isChatBoostSource is the marker method that makes ChatBoostSourcePremium implement ChatBoostSource.
func (*ChatBoostSourcePremium) isChatBoostSource() {}
// isChatBoostSource is the marker method that makes ChatBoostSourceGiftCode implement ChatBoostSource.
func (*ChatBoostSourceGiftCode) isChatBoostSource() {}
// isChatBoostSource is the marker method that makes ChatBoostSourceGiveaway implement ChatBoostSource.
func (*ChatBoostSourceGiveaway) isChatBoostSource() {}
// UnmarshalChatBoostSource decodes a ChatBoostSource from JSON by inspecting the
// "source" field and dispatching to the correct concrete type.
func UnmarshalChatBoostSource(data []byte) (ChatBoostSource, error) {
var probe struct {
V string `json:"source"`
}
if err := json.Unmarshal(data, &probe); err != nil {
return nil, err
}
var v ChatBoostSource
switch probe.V {
case "gift_code":
v = &ChatBoostSourceGiftCode{}
case "giveaway":
v = &ChatBoostSourceGiveaway{}
case "premium":
v = &ChatBoostSourcePremium{}
default:
return nil, fmt.Errorf("ChatBoostSource: unknown source %q", probe.V)
}
if err := json.Unmarshal(data, v); err != nil {
return nil, err
}
return v, nil
}
// The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.
type ChatBoostSourcePremium struct {
// Source of the boost, always “premium”
Source ChatBoostSourceKind `json:"source"`
// User that boosted the chat
User User `json:"user"`
}
// MarshalJSON encodes ChatBoostSourcePremium with the discriminator field
// "source" forced to "premium".
// The hardcoded value frees callers from setting Source by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *ChatBoostSourcePremium) MarshalJSON() ([]byte, error) {
type alias ChatBoostSourcePremium
return json.Marshal(&struct {
Source string `json:"source"`
*alias
}{
Source: "premium",
alias: (*alias)(v),
})
}
// 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 ChatBoostSourceGiftCode struct {
// Source of the boost, always “gift_code”
Source ChatBoostSourceKind `json:"source"`
// User for which the gift code was created
User User `json:"user"`
}
// MarshalJSON encodes ChatBoostSourceGiftCode with the discriminator field
// "source" forced to "gift_code".
// The hardcoded value frees callers from setting Source by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *ChatBoostSourceGiftCode) MarshalJSON() ([]byte, error) {
type alias ChatBoostSourceGiftCode
return json.Marshal(&struct {
Source string `json:"source"`
*alias
}{
Source: "gift_code",
alias: (*alias)(v),
})
}
// 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 ChatBoostSourceGiveaway struct {
// Source of the boost, always “giveaway”
Source ChatBoostSourceKind `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"`
}
// MarshalJSON encodes ChatBoostSourceGiveaway with the discriminator field
// "source" forced to "giveaway".
// The hardcoded value frees callers from setting Source by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *ChatBoostSourceGiveaway) MarshalJSON() ([]byte, error) {
type alias ChatBoostSourceGiveaway
return json.Marshal(&struct {
Source string `json:"source"`
*alias
}{
Source: "giveaway",
alias: (*alias)(v),
})
}
// This object contains information about a chat boost.
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"`
}
// UnmarshalJSON decodes ChatBoost by dispatching union-typed fields
// (Source) through their concrete UnmarshalXxx helpers.
func (m *ChatBoost) UnmarshalJSON(data []byte) error {
type Alias ChatBoost
aux := &struct {
Source json.RawMessage `json:"source,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.Source) > 0 && string(aux.Source) != "null" {
v, err := UnmarshalChatBoostSource(aux.Source)
if err != nil {
return fmt.Errorf("decoding source: %w", err)
}
m.Source = v
}
return nil
}
// This object represents a boost added to a chat or changed.
type ChatBoostUpdated struct {
// Chat which was boosted
Chat Chat `json:"chat"`
// Information about the chat boost
Boost ChatBoost `json:"boost"`
}
// This object represents a boost removed from a chat.
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"`
}
// UnmarshalJSON decodes ChatBoostRemoved by dispatching union-typed fields
// (Source) through their concrete UnmarshalXxx helpers.
func (m *ChatBoostRemoved) UnmarshalJSON(data []byte) error {
type Alias ChatBoostRemoved
aux := &struct {
Source json.RawMessage `json:"source,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.Source) > 0 && string(aux.Source) != "null" {
v, err := UnmarshalChatBoostSource(aux.Source)
if err != nil {
return fmt.Errorf("decoding source: %w", err)
}
m.Source = v
}
return nil
}
// Describes a service message about the chat owner leaving the chat.
type ChatOwnerLeft struct {
// Optional. The user who will become the new owner of the chat if the previous owner does not return to the chat
NewOwner *User `json:"new_owner,omitempty"`
}
// Describes a service message about an ownership change in the chat.
type ChatOwnerChanged struct {
// The new owner of the chat
NewOwner User `json:"new_owner"`
}
// This object represents a list of boosts added to a chat by a user.
type UserChatBoosts struct {
// The list of boosts added to the chat by the user
Boosts []ChatBoost `json:"boosts"`
}
// Represents the rights of a business bot.
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"`
}
// Describes the connection of the bot with a business account.
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"`
}
// This object is received when messages are deleted from a connected business account.
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"`
}
// Describes an inline message sent by a Web App on behalf of a user.
type SentWebAppMessage struct {
// Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message.
InlineMessageID string `json:"inline_message_id,omitempty"`
}
// Describes an inline message sent by a guest bot.
type SentGuestMessage struct {
// Identifier of the sent inline message
InlineMessageID string `json:"inline_message_id"`
}
// Describes an inline message to be sent by a user of a Mini App.
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"`
}
// Describes a keyboard button to be used by a user of a Mini App.
type PreparedKeyboardButton struct {
// Unique identifier of the keyboard button
ID string `json:"id"`
}
// InputMedia is a union type. The following concrete variants implement
// it:
// - InputMediaAnimation
// - InputMediaAudio
// - InputMediaDocument
// - InputMediaLivePhoto
// - InputMediaPhoto
// - InputMediaVideo
//
// This object represents the content of a media message to be sent. It should be one of
type InputMedia interface{ isInputMedia() }
// isInputMedia is the marker method that makes InputMediaAnimation implement InputMedia.
func (*InputMediaAnimation) isInputMedia() {}
// isInputMedia is the marker method that makes InputMediaAudio implement InputMedia.
func (*InputMediaAudio) isInputMedia() {}
// isInputMedia is the marker method that makes InputMediaDocument implement InputMedia.
func (*InputMediaDocument) isInputMedia() {}
// isInputMedia is the marker method that makes InputMediaLivePhoto implement InputMedia.
func (*InputMediaLivePhoto) isInputMedia() {}
// isInputMedia is the marker method that makes InputMediaPhoto implement InputMedia.
func (*InputMediaPhoto) isInputMedia() {}
// isInputMedia is the marker method that makes InputMediaVideo implement InputMedia.
func (*InputMediaVideo) isInputMedia() {}
// Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
type InputMediaAnimation struct {
// Type of the result, must be animation
Type InputMediaType `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 »
Media string `json:"media"`
// Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
Thumbnail string `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.
ParseMode ParseMode `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"`
}
// MarshalJSON encodes InputMediaAnimation with the discriminator field
// "type" forced to "animation".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputMediaAnimation) MarshalJSON() ([]byte, error) {
type alias InputMediaAnimation
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "animation",
alias: (*alias)(v),
})
}
// Represents an audio file to be treated as music to be sent.
type InputMediaAudio struct {
// Type of the result, must be audio
Type InputMediaType `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 »
Media string `json:"media"`
// Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
Thumbnail string `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.
ParseMode ParseMode `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"`
}
// MarshalJSON encodes InputMediaAudio with the discriminator field
// "type" forced to "audio".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputMediaAudio) MarshalJSON() ([]byte, error) {
type alias InputMediaAudio
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "audio",
alias: (*alias)(v),
})
}
// Represents a general file to be sent.
type InputMediaDocument struct {
// Type of the result, must be document
Type InputMediaType `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 »
Media string `json:"media"`
// Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
Thumbnail string `json:"thumbnail,omitempty"`
// Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
Caption string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the document caption. See formatting options for more details.
ParseMode ParseMode `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"`
}
// MarshalJSON encodes InputMediaDocument with the discriminator field
// "type" forced to "document".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputMediaDocument) MarshalJSON() ([]byte, error) {
type alias InputMediaDocument
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "document",
alias: (*alias)(v),
})
}
// Represents a live photo to be sent.
type InputMediaLivePhoto struct {
// Type of the result, must be live_photo
Type InputMediaType `json:"type"`
// Video of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) 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 ». Sending live photos by a URL is currently unsupported.
Media string `json:"media"`
// The static photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) 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 ». Sending live photos by a URL is currently unsupported.
Photo string `json:"photo"`
// Optional. Caption of the live photo to be sent, 0-1024 characters after entities parsing
Caption string `json:"caption,omitempty"`
// Optional. Mode for parsing entities in the live photo caption. See formatting options for more details.
ParseMode ParseMode `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 live photo needs to be covered with a spoiler animation
HasSpoiler *bool `json:"has_spoiler,omitempty"`
}
// MarshalJSON encodes InputMediaLivePhoto with the discriminator field
// "type" forced to "live_photo".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputMediaLivePhoto) MarshalJSON() ([]byte, error) {
type alias InputMediaLivePhoto
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "live_photo",
alias: (*alias)(v),
})
}
// Represents a location to be sent.
type InputMediaLocation struct {
// Type of the result, must be location
Type InputPollOptionMediaType `json:"type"`
// Latitude of the location
Latitude float64 `json:"latitude"`
// Longitude of the location
Longitude float64 `json:"longitude"`
// Optional. The radius of uncertainty for the location, measured in meters; 0-1500
HorizontalAccuracy *float64 `json:"horizontal_accuracy,omitempty"`
}
// MarshalJSON encodes InputMediaLocation with the discriminator field
// "type" forced to "location".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputMediaLocation) MarshalJSON() ([]byte, error) {
type alias InputMediaLocation
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "location",
alias: (*alias)(v),
})
}
// Represents a photo to be sent.
type InputMediaPhoto struct {
// Type of the result, must be photo
Type InputMediaType `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 »
Media string `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.
ParseMode ParseMode `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"`
}
// MarshalJSON encodes InputMediaPhoto with the discriminator field
// "type" forced to "photo".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputMediaPhoto) MarshalJSON() ([]byte, error) {
type alias InputMediaPhoto
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "photo",
alias: (*alias)(v),
})
}
// Represents a sticker file to be sent.
type InputMediaSticker struct {
// Type of the result, must be sticker
Type InputPollOptionMediaType `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 .WEBP sticker from the Internet, or pass “attach://<file_attach_name>” to upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data under <file_attach_name> name. More information on Sending Files »
Media string `json:"media"`
// Optional. Emoji associated with the sticker; only for just uploaded stickers
Emoji string `json:"emoji,omitempty"`
}
// MarshalJSON encodes InputMediaSticker with the discriminator field
// "type" forced to "sticker".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputMediaSticker) MarshalJSON() ([]byte, error) {
type alias InputMediaSticker
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "sticker",
alias: (*alias)(v),
})
}
// Represents a venue to be sent.
type InputMediaVenue struct {
// Type of the result, must be venue
Type InputPollOptionMediaType `json:"type"`
// Latitude of the location
Latitude float64 `json:"latitude"`
// Longitude of the location
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
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.)
GooglePlaceType string `json:"google_place_type,omitempty"`
}
// MarshalJSON encodes InputMediaVenue with the discriminator field
// "type" forced to "venue".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputMediaVenue) MarshalJSON() ([]byte, error) {
type alias InputMediaVenue
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "venue",
alias: (*alias)(v),
})
}
// Represents a video to be sent.
type InputMediaVideo struct {
// Type of the result, must be video
Type InputMediaType `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 »
Media string `json:"media"`
// Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
Thumbnail string `json:"thumbnail,omitempty"`
// Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
Cover string `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.
ParseMode ParseMode `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"`
}
// MarshalJSON encodes InputMediaVideo with the discriminator field
// "type" forced to "video".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputMediaVideo) MarshalJSON() ([]byte, error) {
type alias InputMediaVideo
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "video",
alias: (*alias)(v),
})
}
// InputPaidMedia is a union type. The following concrete variants implement
// it:
// - InputPaidMediaLivePhoto
// - InputPaidMediaPhoto
// - InputPaidMediaVideo
//
// This object describes the paid media to be sent. Currently, it can be one of
type InputPaidMedia interface{ isInputPaidMedia() }
// isInputPaidMedia is the marker method that makes InputPaidMediaLivePhoto implement InputPaidMedia.
func (*InputPaidMediaLivePhoto) isInputPaidMedia() {}
// isInputPaidMedia is the marker method that makes InputPaidMediaPhoto implement InputPaidMedia.
func (*InputPaidMediaPhoto) isInputPaidMedia() {}
// isInputPaidMedia is the marker method that makes InputPaidMediaVideo implement InputPaidMedia.
func (*InputPaidMediaVideo) isInputPaidMedia() {}
// The paid media to send is a live photo.
type InputPaidMediaLivePhoto struct {
// Type of the media, must be live_photo
Type InputPaidMediaType `json:"type"`
// Video of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) 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 ». Sending live photos by a URL is currently unsupported.
Media string `json:"media"`
// The static photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) 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 ». Sending live photos by a URL is currently unsupported.
Photo string `json:"photo"`
}
// MarshalJSON encodes InputPaidMediaLivePhoto with the discriminator field
// "type" forced to "live_photo".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputPaidMediaLivePhoto) MarshalJSON() ([]byte, error) {
type alias InputPaidMediaLivePhoto
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "live_photo",
alias: (*alias)(v),
})
}
// The paid media to send is a photo.
type InputPaidMediaPhoto struct {
// Type of the media, must be photo
Type InputPaidMediaType `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 »
Media string `json:"media"`
}
// MarshalJSON encodes InputPaidMediaPhoto with the discriminator field
// "type" forced to "photo".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputPaidMediaPhoto) MarshalJSON() ([]byte, error) {
type alias InputPaidMediaPhoto
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "photo",
alias: (*alias)(v),
})
}
// The paid media to send is a video.
type InputPaidMediaVideo struct {
// Type of the media, must be video
Type InputPaidMediaType `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 »
Media string `json:"media"`
// Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
Thumbnail string `json:"thumbnail,omitempty"`
// Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
Cover string `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"`
}
// MarshalJSON encodes InputPaidMediaVideo with the discriminator field
// "type" forced to "video".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputPaidMediaVideo) MarshalJSON() ([]byte, error) {
type alias InputPaidMediaVideo
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "video",
alias: (*alias)(v),
})
}
// InputProfilePhoto is a union type. The following concrete variants implement
// it:
// - InputProfilePhotoStatic
// - InputProfilePhotoAnimated
//
// This object describes a profile photo to set. Currently, it can be one of
type InputProfilePhoto interface{ isInputProfilePhoto() }
// isInputProfilePhoto is the marker method that makes InputProfilePhotoStatic implement InputProfilePhoto.
func (*InputProfilePhotoStatic) isInputProfilePhoto() {}
// isInputProfilePhoto is the marker method that makes InputProfilePhotoAnimated implement InputProfilePhoto.
func (*InputProfilePhotoAnimated) isInputProfilePhoto() {}
// A static profile photo in the .JPG format.
type InputProfilePhotoStatic struct {
// Type of the profile photo, must be static
Type InputProfilePhotoType `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 »
Photo string `json:"photo"`
}
// MarshalJSON encodes InputProfilePhotoStatic with the discriminator field
// "type" forced to "static".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputProfilePhotoStatic) MarshalJSON() ([]byte, error) {
type alias InputProfilePhotoStatic
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "static",
alias: (*alias)(v),
})
}
// An animated profile photo in the MPEG4 format.
type InputProfilePhotoAnimated struct {
// Type of the profile photo, must be animated
Type InputProfilePhotoType `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 »
Animation string `json:"animation"`
// Optional. Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0.
MainFrameTimestamp *float64 `json:"main_frame_timestamp,omitempty"`
}
// MarshalJSON encodes InputProfilePhotoAnimated with the discriminator field
// "type" forced to "animated".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputProfilePhotoAnimated) MarshalJSON() ([]byte, error) {
type alias InputProfilePhotoAnimated
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "animated",
alias: (*alias)(v),
})
}
// InputStoryContent is a union type. The following concrete variants implement
// it:
// - InputStoryContentPhoto
// - InputStoryContentVideo
//
// This object describes the content of a story to post. Currently, it can be one of
type InputStoryContent interface{ isInputStoryContent() }
// isInputStoryContent is the marker method that makes InputStoryContentPhoto implement InputStoryContent.
func (*InputStoryContentPhoto) isInputStoryContent() {}
// isInputStoryContent is the marker method that makes InputStoryContentVideo implement InputStoryContent.
func (*InputStoryContentVideo) isInputStoryContent() {}
// Describes a photo to post as a story.
type InputStoryContentPhoto struct {
// Type of the content, must be photo
Type InputStoryContentType `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 »
Photo string `json:"photo"`
}
// MarshalJSON encodes InputStoryContentPhoto with the discriminator field
// "type" forced to "photo".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputStoryContentPhoto) MarshalJSON() ([]byte, error) {
type alias InputStoryContentPhoto
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "photo",
alias: (*alias)(v),
})
}
// Describes a video to post as a story.
type InputStoryContentVideo struct {
// Type of the content, must be video
Type InputStoryContentType `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 »
Video string `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"`
}
// MarshalJSON encodes InputStoryContentVideo with the discriminator field
// "type" forced to "video".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InputStoryContentVideo) MarshalJSON() ([]byte, error) {
type alias InputStoryContentVideo
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "video",
alias: (*alias)(v),
})
}
// This object represents a 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 StickerType `json:"type"`
// Sticker width
Width int64 `json:"width"`
// Sticker height
Height int64 `json:"height"`
// True, if the sticker is animated
IsAnimated bool `json:"is_animated"`
// True, if the sticker is a video sticker
IsVideo bool `json:"is_video"`
// Optional. Sticker thumbnail in the .WEBP or .JPG format
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
// Optional. Emoji associated with the sticker
Emoji string `json:"emoji,omitempty"`
// Optional. Name of the sticker set to which the sticker belongs
SetName string `json:"set_name,omitempty"`
// Optional. For premium regular stickers, premium animation for the sticker
PremiumAnimation *File `json:"premium_animation,omitempty"`
// Optional. For mask stickers, the position where the mask should be placed
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
// Optional. For custom emoji stickers, unique identifier of the custom emoji
CustomEmojiID string `json:"custom_emoji_id,omitempty"`
// Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places
NeedsRepainting *bool `json:"needs_repainting,omitempty"`
// Optional. File size in bytes
FileSize *int64 `json:"file_size,omitempty"`
}
// This object represents a sticker set.
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 StickerType `json:"sticker_type"`
// List of all set stickers
Stickers []Sticker `json:"stickers"`
// Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
}
// This object describes the position on faces where a mask should be placed by default.
type MaskPosition struct {
// The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.
Point MaskPositionPoint `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"`
}
// This object describes a sticker to be added to a sticker set.
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 »
Sticker string `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 InputStickerFormat `json:"format"`
// List of 1-20 emoji associated with the sticker
EmojiList []string `json:"emoji_list"`
// Optional. Position where the mask should be placed on faces. For “mask” stickers only.
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
// Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only.
Keywords []string `json:"keywords,omitempty"`
}
// This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
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 InlineQueryChatType `json:"chat_type,omitempty"`
// Optional. Sender location, only for bots that request user location
Location *Location `json:"location,omitempty"`
}
// This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.
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.
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.
StartParameter string `json:"start_parameter,omitempty"`
}
// InlineQueryResult is a union type. The following concrete variants implement
// it:
// - InlineQueryResultCachedAudio
// - InlineQueryResultCachedDocument
// - InlineQueryResultCachedGif
// - InlineQueryResultCachedMpeg4Gif
// - InlineQueryResultCachedPhoto
// - InlineQueryResultCachedSticker
// - InlineQueryResultCachedVideo
// - InlineQueryResultCachedVoice
// - InlineQueryResultArticle
// - InlineQueryResultAudio
// - InlineQueryResultContact
// - InlineQueryResultGame
// - InlineQueryResultDocument
// - InlineQueryResultGif
// - InlineQueryResultLocation
// - InlineQueryResultMpeg4Gif
// - InlineQueryResultPhoto
// - InlineQueryResultVenue
// - InlineQueryResultVideo
// - InlineQueryResultVoice
//
// This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:
// Note: All URLs passed in inline query results will be available to end users and therefore must be assumed to be public.
type InlineQueryResult interface{ isInlineQueryResult() }
// isInlineQueryResult is the marker method that makes InlineQueryResultCachedAudio implement InlineQueryResult.
func (*InlineQueryResultCachedAudio) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultCachedDocument implement InlineQueryResult.
func (*InlineQueryResultCachedDocument) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultCachedGif implement InlineQueryResult.
func (*InlineQueryResultCachedGif) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultCachedMpeg4Gif implement InlineQueryResult.
func (*InlineQueryResultCachedMpeg4Gif) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultCachedPhoto implement InlineQueryResult.
func (*InlineQueryResultCachedPhoto) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultCachedSticker implement InlineQueryResult.
func (*InlineQueryResultCachedSticker) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultCachedVideo implement InlineQueryResult.
func (*InlineQueryResultCachedVideo) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultCachedVoice implement InlineQueryResult.
func (*InlineQueryResultCachedVoice) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultArticle implement InlineQueryResult.
func (*InlineQueryResultArticle) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultAudio implement InlineQueryResult.
func (*InlineQueryResultAudio) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultContact implement InlineQueryResult.
func (*InlineQueryResultContact) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultGame implement InlineQueryResult.
func (*InlineQueryResultGame) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultDocument implement InlineQueryResult.
func (*InlineQueryResultDocument) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultGif implement InlineQueryResult.
func (*InlineQueryResultGif) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultLocation implement InlineQueryResult.
func (*InlineQueryResultLocation) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultMpeg4Gif implement InlineQueryResult.
func (*InlineQueryResultMpeg4Gif) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultPhoto implement InlineQueryResult.
func (*InlineQueryResultPhoto) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultVenue implement InlineQueryResult.
func (*InlineQueryResultVenue) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultVideo implement InlineQueryResult.
func (*InlineQueryResultVideo) isInlineQueryResult() {}
// isInlineQueryResult is the marker method that makes InlineQueryResultVoice implement InlineQueryResult.
func (*InlineQueryResultVoice) isInlineQueryResult() {}
// Represents a link to an article or web page.
type InlineQueryResultArticle struct {
// Type of the result, must be article
Type InlineQueryResultType `json:"type"`
// Unique identifier for this result, 1-64 Bytes
ID string `json:"id"`
// Title of the result
Title string `json:"title"`
// Content of the message to be sent
InputMessageContent InputMessageContent `json:"input_message_content"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. URL of the result
URL string `json:"url,omitempty"`
// Optional. 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"`
}
// MarshalJSON encodes InlineQueryResultArticle with the discriminator field
// "type" forced to "article".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultArticle) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultArticle
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "article",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultPhoto struct {
// Type of the result, must be photo
Type InlineQueryResultType `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.
ParseMode ParseMode `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the photo
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
// MarshalJSON encodes InlineQueryResultPhoto with the discriminator field
// "type" forced to "photo".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultPhoto) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultPhoto
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "photo",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultGif struct {
// Type of the result, must be gif
Type InlineQueryResultType `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 InlineQueryResultGifThumbnailMimeType `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.
ParseMode ParseMode `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the GIF animation
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
// MarshalJSON encodes InlineQueryResultGif with the discriminator field
// "type" forced to "gif".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultGif) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultGif
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "gif",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultMpeg4Gif struct {
// Type of the result, must be mpeg4_gif
Type InlineQueryResultType `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 InlineQueryResultGifThumbnailMimeType `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.
ParseMode ParseMode `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the video animation
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
// MarshalJSON encodes InlineQueryResultMpeg4Gif with the discriminator field
// "type" forced to "mpeg4_gif".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultMpeg4Gif) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultMpeg4Gif
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "mpeg4_gif",
alias: (*alias)(v),
})
}
// Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
// If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using input_message_content.
type InlineQueryResultVideo struct {
// Type of the result, must be video
Type InlineQueryResultType `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.
ParseMode ParseMode `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
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"`
}
// MarshalJSON encodes InlineQueryResultVideo with the discriminator field
// "type" forced to "video".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultVideo) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultVideo
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "video",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultAudio struct {
// Type of the result, must be audio
Type InlineQueryResultType `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.
ParseMode ParseMode `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
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"`
}
// MarshalJSON encodes InlineQueryResultAudio with the discriminator field
// "type" forced to "audio".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultAudio) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultAudio
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "audio",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultVoice struct {
// Type of the result, must be voice
Type InlineQueryResultType `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.
ParseMode ParseMode `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
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"`
}
// MarshalJSON encodes InlineQueryResultVoice with the discriminator field
// "type" forced to "voice".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultVoice) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultVoice
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "voice",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultDocument struct {
// Type of the result, must be document
Type InlineQueryResultType `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.
ParseMode ParseMode `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 InlineQueryResultDocumentMimeType `json:"mime_type"`
// Optional. Short description of the result
Description string `json:"description,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the file
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
// Optional. URL of the thumbnail (JPEG only) for the file
ThumbnailURL string `json:"thumbnail_url,omitempty"`
// Optional. Thumbnail width
ThumbnailWidth *int64 `json:"thumbnail_width,omitempty"`
// Optional. Thumbnail height
ThumbnailHeight *int64 `json:"thumbnail_height,omitempty"`
}
// MarshalJSON encodes InlineQueryResultDocument with the discriminator field
// "type" forced to "document".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultDocument) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultDocument
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "document",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultLocation struct {
// Type of the result, must be location
Type InlineQueryResultType `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
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"`
}
// MarshalJSON encodes InlineQueryResultLocation with the discriminator field
// "type" forced to "location".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultLocation) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultLocation
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "location",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultVenue struct {
// Type of the result, must be venue
Type InlineQueryResultType `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.)
GooglePlaceType string `json:"google_place_type,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the venue
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
// Optional. Url of the thumbnail for the result
ThumbnailURL string `json:"thumbnail_url,omitempty"`
// Optional. Thumbnail width
ThumbnailWidth *int64 `json:"thumbnail_width,omitempty"`
// Optional. Thumbnail height
ThumbnailHeight *int64 `json:"thumbnail_height,omitempty"`
}
// MarshalJSON encodes InlineQueryResultVenue with the discriminator field
// "type" forced to "venue".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultVenue) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultVenue
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "venue",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultContact struct {
// Type of the result, must be contact
Type InlineQueryResultType `json:"type"`
// Unique identifier for this result, 1-64 Bytes
ID string `json:"id"`
// Contact's phone number
PhoneNumber string `json:"phone_number"`
// Contact's first name
FirstName string `json:"first_name"`
// Optional. Contact's last name
LastName string `json:"last_name,omitempty"`
// Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes
Vcard string `json:"vcard,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the contact
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
// Optional. Url of the thumbnail for the result
ThumbnailURL string `json:"thumbnail_url,omitempty"`
// Optional. Thumbnail width
ThumbnailWidth *int64 `json:"thumbnail_width,omitempty"`
// Optional. Thumbnail height
ThumbnailHeight *int64 `json:"thumbnail_height,omitempty"`
}
// MarshalJSON encodes InlineQueryResultContact with the discriminator field
// "type" forced to "contact".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultContact) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultContact
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "contact",
alias: (*alias)(v),
})
}
// Represents a Game.
type InlineQueryResultGame struct {
// Type of the result, must be game
Type InlineQueryResultType `json:"type"`
// Unique identifier for this result, 1-64 bytes
ID string `json:"id"`
// Short name of the game
GameShortName string `json:"game_short_name"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}
// MarshalJSON encodes InlineQueryResultGame with the discriminator field
// "type" forced to "game".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultGame) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultGame
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "game",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultCachedPhoto struct {
// Type of the result, must be photo
Type InlineQueryResultType `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.
ParseMode ParseMode `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the photo
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
// MarshalJSON encodes InlineQueryResultCachedPhoto with the discriminator field
// "type" forced to "photo".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultCachedPhoto) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultCachedPhoto
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "photo",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultCachedGif struct {
// Type of the result, must be gif
Type InlineQueryResultType `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.
ParseMode ParseMode `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the GIF animation
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
// MarshalJSON encodes InlineQueryResultCachedGif with the discriminator field
// "type" forced to "gif".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultCachedGif) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultCachedGif
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "gif",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultCachedMpeg4Gif struct {
// Type of the result, must be mpeg4_gif
Type InlineQueryResultType `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.
ParseMode ParseMode `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the video animation
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
// MarshalJSON encodes InlineQueryResultCachedMpeg4Gif with the discriminator field
// "type" forced to "mpeg4_gif".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultCachedMpeg4Gif) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultCachedMpeg4Gif
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "mpeg4_gif",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultCachedSticker struct {
// Type of the result, must be sticker
Type InlineQueryResultType `json:"type"`
// Unique identifier for this result, 1-64 bytes
ID string `json:"id"`
// A valid file identifier of the sticker
StickerFileID string `json:"sticker_file_id"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the sticker
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
// MarshalJSON encodes InlineQueryResultCachedSticker with the discriminator field
// "type" forced to "sticker".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultCachedSticker) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultCachedSticker
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "sticker",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultCachedDocument struct {
// Type of the result, must be document
Type InlineQueryResultType `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.
ParseMode ParseMode `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the file
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
// MarshalJSON encodes InlineQueryResultCachedDocument with the discriminator field
// "type" forced to "document".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultCachedDocument) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultCachedDocument
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "document",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultCachedVideo struct {
// Type of the result, must be video
Type InlineQueryResultType `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.
ParseMode ParseMode `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the video
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
// MarshalJSON encodes InlineQueryResultCachedVideo with the discriminator field
// "type" forced to "video".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultCachedVideo) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultCachedVideo
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "video",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultCachedVoice struct {
// Type of the result, must be voice
Type InlineQueryResultType `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.
ParseMode ParseMode `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the voice message
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
// MarshalJSON encodes InlineQueryResultCachedVoice with the discriminator field
// "type" forced to "voice".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultCachedVoice) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultCachedVoice
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "voice",
alias: (*alias)(v),
})
}
// 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 InlineQueryResultCachedAudio struct {
// Type of the result, must be audio
Type InlineQueryResultType `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.
ParseMode ParseMode `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Optional. Inline keyboard attached to the message
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
// Optional. Content of the message to be sent instead of the audio
InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}
// MarshalJSON encodes InlineQueryResultCachedAudio with the discriminator field
// "type" forced to "audio".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *InlineQueryResultCachedAudio) MarshalJSON() ([]byte, error) {
type alias InlineQueryResultCachedAudio
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "audio",
alias: (*alias)(v),
})
}
// InputMessageContent is a union type. The following concrete variants implement
// it:
// - InputTextMessageContent
// - InputLocationMessageContent
// - InputVenueMessageContent
// - InputContactMessageContent
// - InputInvoiceMessageContent
//
// 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:
type InputMessageContent interface{ isInputMessageContent() }
// isInputMessageContent is the marker method that makes InputTextMessageContent implement InputMessageContent.
func (*InputTextMessageContent) isInputMessageContent() {}
// isInputMessageContent is the marker method that makes InputLocationMessageContent implement InputMessageContent.
func (*InputLocationMessageContent) isInputMessageContent() {}
// isInputMessageContent is the marker method that makes InputVenueMessageContent implement InputMessageContent.
func (*InputVenueMessageContent) isInputMessageContent() {}
// isInputMessageContent is the marker method that makes InputContactMessageContent implement InputMessageContent.
func (*InputContactMessageContent) isInputMessageContent() {}
// isInputMessageContent is the marker method that makes InputInvoiceMessageContent implement InputMessageContent.
func (*InputInvoiceMessageContent) isInputMessageContent() {}
// Represents the content of a text message to be sent as the result of an inline query.
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.
ParseMode ParseMode `json:"parse_mode,omitempty"`
// Optional. List of special entities that appear in message text, which can be specified instead of parse_mode
Entities []MessageEntity `json:"entities,omitempty"`
// Optional. Link preview generation options for the message
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
}
// Represents the content of a location message to be sent as the result of an inline query.
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"`
}
// Represents the content of a venue message to be sent as the result of an inline query.
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.)
GooglePlaceType string `json:"google_place_type,omitempty"`
}
// Represents the content of a contact message to be sent as the result of an inline query.
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 string `json:"vcard,omitempty"`
}
// Represents the content of an invoice message to be sent as the result of an inline query.
type InputInvoiceMessageContent struct {
// Product name, 1-32 characters
Title string `json:"title"`
// Product description, 1-255 characters
Description string `json:"description"`
// Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
Payload string `json:"payload"`
// Optional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
ProviderToken string `json:"provider_token,omitempty"`
// Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
Currency string `json:"currency"`
// Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
Prices []LabeledPrice `json:"prices"`
// Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
MaxTipAmount *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.
NeedName *bool `json:"need_name,omitempty"`
// Optional. Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
NeedPhoneNumber *bool `json:"need_phone_number,omitempty"`
// Optional. Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
NeedEmail *bool `json:"need_email,omitempty"`
// Optional. Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
NeedShippingAddress *bool `json:"need_shipping_address,omitempty"`
// Optional. Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
SendPhoneNumberToProvider *bool `json:"send_phone_number_to_provider,omitempty"`
// Optional. Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
SendEmailToProvider *bool `json:"send_email_to_provider,omitempty"`
// Optional. Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
IsFlexible *bool `json:"is_flexible,omitempty"`
}
// Represents 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 ChosenInlineResult struct {
// The unique identifier for the result that was chosen
ResultID string `json:"result_id"`
// The user that chose the result
From User `json:"from"`
// Optional. Sender location, only for bots that require user location
Location *Location `json:"location,omitempty"`
// Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message.
InlineMessageID string `json:"inline_message_id,omitempty"`
// The query that was used to obtain the result
Query string `json:"query"`
}
// This object represents a portion of the price for goods or services.
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).
Amount int64 `json:"amount"`
}
// This object contains basic information about an invoice.
type Invoice struct {
// Product name
Title string `json:"title"`
// Product description
Description string `json:"description"`
// Unique bot deep-linking parameter that can be used to generate this invoice
StartParameter string `json:"start_parameter"`
// Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
Currency string `json:"currency"`
// Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
TotalAmount int64 `json:"total_amount"`
}
// This object represents a shipping address.
type ShippingAddress struct {
// Two-letter ISO 3166-1 alpha-2 country code
CountryCode string `json:"country_code"`
// State, if applicable
State string `json:"state"`
// City
City string `json:"city"`
// First line for the address
StreetLine1 string `json:"street_line1"`
// Second line for the address
StreetLine2 string `json:"street_line2"`
// Address post code
PostCode string `json:"post_code"`
}
// This object represents information about an order.
type OrderInfo struct {
// Optional. User name
Name string `json:"name,omitempty"`
// Optional. User's phone number
PhoneNumber string `json:"phone_number,omitempty"`
// Optional. User email
Email string `json:"email,omitempty"`
// Optional. User shipping address
ShippingAddress *ShippingAddress `json:"shipping_address,omitempty"`
}
// This object represents one shipping option.
type ShippingOption struct {
// Shipping option identifier
ID string `json:"id"`
// Option title
Title string `json:"title"`
// List of price portions
Prices []LabeledPrice `json:"prices"`
}
// This object 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 SuccessfulPayment struct {
// Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
Currency string `json:"currency"`
// Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
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"`
}
// This object contains basic information about a refunded payment.
type RefundedPayment struct {
// Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars. Currently, always “XTR”
Currency RefundedPaymentCurrency `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).
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"`
}
// This object contains information about an incoming shipping query.
type ShippingQuery struct {
// Unique query identifier
ID string `json:"id"`
// User who sent the query
From User `json:"from"`
// Bot-specified invoice payload
InvoicePayload string `json:"invoice_payload"`
// User specified shipping address
ShippingAddress ShippingAddress `json:"shipping_address"`
}
// This object contains information about an incoming pre-checkout query.
type PreCheckoutQuery struct {
// Unique query identifier
ID string `json:"id"`
// User who sent the query
From User `json:"from"`
// Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
Currency string `json:"currency"`
// Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
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"`
}
// This object contains information about a paid media purchase.
type PaidMediaPurchased struct {
// User who purchased the media
From User `json:"from"`
// Bot-specified paid media payload
PaidMediaPayload string `json:"paid_media_payload"`
}
// RevenueWithdrawalState is a union type. The following concrete variants implement
// it:
// - RevenueWithdrawalStatePending
// - RevenueWithdrawalStateSucceeded
// - RevenueWithdrawalStateFailed
//
// This object describes the state of a revenue withdrawal operation. Currently, it can be one of
type RevenueWithdrawalState interface{ isRevenueWithdrawalState() }
// isRevenueWithdrawalState is the marker method that makes RevenueWithdrawalStatePending implement RevenueWithdrawalState.
func (*RevenueWithdrawalStatePending) isRevenueWithdrawalState() {}
// isRevenueWithdrawalState is the marker method that makes RevenueWithdrawalStateSucceeded implement RevenueWithdrawalState.
func (*RevenueWithdrawalStateSucceeded) isRevenueWithdrawalState() {}
// isRevenueWithdrawalState is the marker method that makes RevenueWithdrawalStateFailed implement RevenueWithdrawalState.
func (*RevenueWithdrawalStateFailed) isRevenueWithdrawalState() {}
// UnmarshalRevenueWithdrawalState decodes a RevenueWithdrawalState from JSON by inspecting the
// "type" field and dispatching to the correct concrete type.
func UnmarshalRevenueWithdrawalState(data []byte) (RevenueWithdrawalState, error) {
var probe struct {
V string `json:"type"`
}
if err := json.Unmarshal(data, &probe); err != nil {
return nil, err
}
var v RevenueWithdrawalState
switch probe.V {
case "failed":
v = &RevenueWithdrawalStateFailed{}
case "pending":
v = &RevenueWithdrawalStatePending{}
case "succeeded":
v = &RevenueWithdrawalStateSucceeded{}
default:
return nil, fmt.Errorf("RevenueWithdrawalState: unknown type %q", probe.V)
}
if err := json.Unmarshal(data, v); err != nil {
return nil, err
}
return v, nil
}
// The withdrawal is in progress.
type RevenueWithdrawalStatePending struct {
// Type of the state, always “pending”
Type RevenueWithdrawalStateKind `json:"type"`
}
// MarshalJSON encodes RevenueWithdrawalStatePending with the discriminator field
// "type" forced to "pending".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *RevenueWithdrawalStatePending) MarshalJSON() ([]byte, error) {
type alias RevenueWithdrawalStatePending
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "pending",
alias: (*alias)(v),
})
}
// The withdrawal succeeded.
type RevenueWithdrawalStateSucceeded struct {
// Type of the state, always “succeeded”
Type RevenueWithdrawalStateKind `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"`
}
// MarshalJSON encodes RevenueWithdrawalStateSucceeded with the discriminator field
// "type" forced to "succeeded".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *RevenueWithdrawalStateSucceeded) MarshalJSON() ([]byte, error) {
type alias RevenueWithdrawalStateSucceeded
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "succeeded",
alias: (*alias)(v),
})
}
// The withdrawal failed and the transaction was refunded.
type RevenueWithdrawalStateFailed struct {
// Type of the state, always “failed”
Type RevenueWithdrawalStateKind `json:"type"`
}
// MarshalJSON encodes RevenueWithdrawalStateFailed with the discriminator field
// "type" forced to "failed".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *RevenueWithdrawalStateFailed) MarshalJSON() ([]byte, error) {
type alias RevenueWithdrawalStateFailed
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "failed",
alias: (*alias)(v),
})
}
// Contains information about the affiliate that received a commission via this transaction.
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"`
}
// TransactionPartner is a union type. The following concrete variants implement
// it:
// - TransactionPartnerUser
// - TransactionPartnerChat
// - TransactionPartnerAffiliateProgram
// - TransactionPartnerFragment
// - TransactionPartnerTelegramAds
// - TransactionPartnerTelegramApi
// - TransactionPartnerOther
//
// This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of
type TransactionPartner interface{ isTransactionPartner() }
// isTransactionPartner is the marker method that makes TransactionPartnerUser implement TransactionPartner.
func (*TransactionPartnerUser) isTransactionPartner() {}
// isTransactionPartner is the marker method that makes TransactionPartnerChat implement TransactionPartner.
func (*TransactionPartnerChat) isTransactionPartner() {}
// isTransactionPartner is the marker method that makes TransactionPartnerAffiliateProgram implement TransactionPartner.
func (*TransactionPartnerAffiliateProgram) isTransactionPartner() {}
// isTransactionPartner is the marker method that makes TransactionPartnerFragment implement TransactionPartner.
func (*TransactionPartnerFragment) isTransactionPartner() {}
// isTransactionPartner is the marker method that makes TransactionPartnerTelegramAds implement TransactionPartner.
func (*TransactionPartnerTelegramAds) isTransactionPartner() {}
// isTransactionPartner is the marker method that makes TransactionPartnerTelegramApi implement TransactionPartner.
func (*TransactionPartnerTelegramApi) isTransactionPartner() {}
// isTransactionPartner is the marker method that makes TransactionPartnerOther implement TransactionPartner.
func (*TransactionPartnerOther) isTransactionPartner() {}
// UnmarshalTransactionPartner decodes a TransactionPartner from JSON by inspecting the
// "type" field and dispatching to the correct concrete type.
func UnmarshalTransactionPartner(data []byte) (TransactionPartner, error) {
var probe struct {
V string `json:"type"`
}
if err := json.Unmarshal(data, &probe); err != nil {
return nil, err
}
var v TransactionPartner
switch probe.V {
case "fragment":
v = &TransactionPartnerFragment{}
case "other":
v = &TransactionPartnerOther{}
case "telegram_ads":
v = &TransactionPartnerTelegramAds{}
case "telegram_api":
v = &TransactionPartnerTelegramApi{}
case "user":
v = &TransactionPartnerUser{}
default:
return nil, fmt.Errorf("TransactionPartner: unknown type %q", probe.V)
}
if err := json.Unmarshal(data, v); err != nil {
return nil, err
}
return v, nil
}
// Describes a transaction with a user.
type TransactionPartnerUser struct {
// Type of the transaction partner, always “user”
Type TransactionPartnerType `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 TransactionPartnerUserTransactionType `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"`
}
// MarshalJSON encodes TransactionPartnerUser with the discriminator field
// "type" forced to "user".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *TransactionPartnerUser) MarshalJSON() ([]byte, error) {
type alias TransactionPartnerUser
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "user",
alias: (*alias)(v),
})
}
// UnmarshalJSON decodes TransactionPartnerUser by dispatching union-typed fields
// (PaidMedia) through their concrete UnmarshalXxx helpers.
func (m *TransactionPartnerUser) UnmarshalJSON(data []byte) error {
type Alias TransactionPartnerUser
aux := &struct {
PaidMedia json.RawMessage `json:"paid_media,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.PaidMedia) > 0 && string(aux.PaidMedia) != "null" {
var raws []json.RawMessage
if err := json.Unmarshal(aux.PaidMedia, &raws); err != nil {
return fmt.Errorf("decoding paid_media: %w", err)
}
decoded := make([]PaidMedia, 0, len(raws))
for i, r := range raws {
v, err := UnmarshalPaidMedia(r)
if err != nil {
return fmt.Errorf("decoding paid_media[%d]: %w", i, err)
}
decoded = append(decoded, v)
}
m.PaidMedia = decoded
}
return nil
}
// Describes a transaction with a chat.
type TransactionPartnerChat struct {
// Type of the transaction partner, always “chat”
Type TransactionPartnerType `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"`
}
// MarshalJSON encodes TransactionPartnerChat with the discriminator field
// "type" forced to "chat".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *TransactionPartnerChat) MarshalJSON() ([]byte, error) {
type alias TransactionPartnerChat
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "chat",
alias: (*alias)(v),
})
}
// Describes the affiliate program that issued the affiliate commission received via this transaction.
type TransactionPartnerAffiliateProgram struct {
// Type of the transaction partner, always “affiliate_program”
Type TransactionPartnerType `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"`
}
// MarshalJSON encodes TransactionPartnerAffiliateProgram with the discriminator field
// "type" forced to "affiliate_program".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *TransactionPartnerAffiliateProgram) MarshalJSON() ([]byte, error) {
type alias TransactionPartnerAffiliateProgram
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "affiliate_program",
alias: (*alias)(v),
})
}
// Describes a withdrawal transaction with Fragment.
type TransactionPartnerFragment struct {
// Type of the transaction partner, always “fragment”
Type TransactionPartnerType `json:"type"`
// Optional. State of the transaction if the transaction is outgoing
WithdrawalState RevenueWithdrawalState `json:"withdrawal_state,omitempty"`
}
// MarshalJSON encodes TransactionPartnerFragment with the discriminator field
// "type" forced to "fragment".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *TransactionPartnerFragment) MarshalJSON() ([]byte, error) {
type alias TransactionPartnerFragment
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "fragment",
alias: (*alias)(v),
})
}
// UnmarshalJSON decodes TransactionPartnerFragment by dispatching union-typed fields
// (WithdrawalState) through their concrete UnmarshalXxx helpers.
func (m *TransactionPartnerFragment) UnmarshalJSON(data []byte) error {
type Alias TransactionPartnerFragment
aux := &struct {
WithdrawalState json.RawMessage `json:"withdrawal_state,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.WithdrawalState) > 0 && string(aux.WithdrawalState) != "null" {
v, err := UnmarshalRevenueWithdrawalState(aux.WithdrawalState)
if err != nil {
return fmt.Errorf("decoding withdrawal_state: %w", err)
}
m.WithdrawalState = v
}
return nil
}
// Describes a withdrawal transaction to the Telegram Ads platform.
type TransactionPartnerTelegramAds struct {
// Type of the transaction partner, always “telegram_ads”
Type TransactionPartnerType `json:"type"`
}
// MarshalJSON encodes TransactionPartnerTelegramAds with the discriminator field
// "type" forced to "telegram_ads".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *TransactionPartnerTelegramAds) MarshalJSON() ([]byte, error) {
type alias TransactionPartnerTelegramAds
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "telegram_ads",
alias: (*alias)(v),
})
}
// Describes a transaction with payment for paid broadcasting.
type TransactionPartnerTelegramApi struct {
// Type of the transaction partner, always “telegram_api”
Type TransactionPartnerType `json:"type"`
// The number of successful requests that exceeded regular limits and were therefore billed
RequestCount int64 `json:"request_count"`
}
// MarshalJSON encodes TransactionPartnerTelegramApi with the discriminator field
// "type" forced to "telegram_api".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *TransactionPartnerTelegramApi) MarshalJSON() ([]byte, error) {
type alias TransactionPartnerTelegramApi
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "telegram_api",
alias: (*alias)(v),
})
}
// Describes a transaction with an unknown source or recipient.
type TransactionPartnerOther struct {
// Type of the transaction partner, always “other”
Type TransactionPartnerType `json:"type"`
}
// MarshalJSON encodes TransactionPartnerOther with the discriminator field
// "type" forced to "other".
// The hardcoded value frees callers from setting Type by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *TransactionPartnerOther) MarshalJSON() ([]byte, error) {
type alias TransactionPartnerOther
return json.Marshal(&struct {
Type string `json:"type"`
*alias
}{
Type: "other",
alias: (*alias)(v),
})
}
// 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 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"`
}
// UnmarshalJSON decodes StarTransaction by dispatching union-typed fields
// (Source, Receiver) through their concrete UnmarshalXxx helpers.
func (m *StarTransaction) UnmarshalJSON(data []byte) error {
type Alias StarTransaction
aux := &struct {
Source json.RawMessage `json:"source,omitempty"`
Receiver json.RawMessage `json:"receiver,omitempty"`
*Alias
}{Alias: (*Alias)(m)}
if err := json.Unmarshal(data, aux); err != nil {
return err
}
if len(aux.Source) > 0 && string(aux.Source) != "null" {
v, err := UnmarshalTransactionPartner(aux.Source)
if err != nil {
return fmt.Errorf("decoding source: %w", err)
}
m.Source = v
}
if len(aux.Receiver) > 0 && string(aux.Receiver) != "null" {
v, err := UnmarshalTransactionPartner(aux.Receiver)
if err != nil {
return fmt.Errorf("decoding receiver: %w", err)
}
m.Receiver = v
}
return nil
}
// Contains a list of Telegram Star transactions.
type StarTransactions struct {
// The list of transactions
Transactions []StarTransaction `json:"transactions"`
}
// Describes Telegram Passport data shared with the bot by the user.
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"`
}
// 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 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"`
}
// Describes documents or other Telegram Passport elements shared with the bot by the user.
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 EncryptedPassportElementType `json:"type"`
// Optional. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.
Data string `json:"data,omitempty"`
// Optional. User's verified phone number; available only for “phone_number” type
PhoneNumber string `json:"phone_number,omitempty"`
// Optional. User's verified email address; available only for “email” type
Email string `json:"email,omitempty"`
// Optional. Array of encrypted files with documents provided by the user; available only for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
Files []PassportFile `json:"files,omitempty"`
// Optional. Encrypted file with the front side of the document, provided by the user; available only for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
FrontSide *PassportFile `json:"front_side,omitempty"`
// Optional. Encrypted file with the reverse side of the document, provided by the user; available only for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
ReverseSide *PassportFile `json:"reverse_side,omitempty"`
// Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
Selfie *PassportFile `json:"selfie,omitempty"`
// Optional. Array of encrypted files with translated versions of documents provided by the user; available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
Translation []PassportFile `json:"translation,omitempty"`
// Base64-encoded element hash for using in PassportElementErrorUnspecified
Hash string `json:"hash"`
}
// 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 EncryptedCredentials struct {
// Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication
Data string `json:"data"`
// Base64-encoded data hash for data authentication
Hash string `json:"hash"`
// Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption
Secret string `json:"secret"`
}
// PassportElementError is a union type. The following concrete variants implement
// it:
// - PassportElementErrorDataField
// - PassportElementErrorFrontSide
// - PassportElementErrorReverseSide
// - PassportElementErrorSelfie
// - PassportElementErrorFile
// - PassportElementErrorFiles
// - PassportElementErrorTranslationFile
// - PassportElementErrorTranslationFiles
// - PassportElementErrorUnspecified
//
// This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:
type PassportElementError interface{ isPassportElementError() }
// isPassportElementError is the marker method that makes PassportElementErrorDataField implement PassportElementError.
func (*PassportElementErrorDataField) isPassportElementError() {}
// isPassportElementError is the marker method that makes PassportElementErrorFrontSide implement PassportElementError.
func (*PassportElementErrorFrontSide) isPassportElementError() {}
// isPassportElementError is the marker method that makes PassportElementErrorReverseSide implement PassportElementError.
func (*PassportElementErrorReverseSide) isPassportElementError() {}
// isPassportElementError is the marker method that makes PassportElementErrorSelfie implement PassportElementError.
func (*PassportElementErrorSelfie) isPassportElementError() {}
// isPassportElementError is the marker method that makes PassportElementErrorFile implement PassportElementError.
func (*PassportElementErrorFile) isPassportElementError() {}
// isPassportElementError is the marker method that makes PassportElementErrorFiles implement PassportElementError.
func (*PassportElementErrorFiles) isPassportElementError() {}
// isPassportElementError is the marker method that makes PassportElementErrorTranslationFile implement PassportElementError.
func (*PassportElementErrorTranslationFile) isPassportElementError() {}
// isPassportElementError is the marker method that makes PassportElementErrorTranslationFiles implement PassportElementError.
func (*PassportElementErrorTranslationFiles) isPassportElementError() {}
// isPassportElementError is the marker method that makes PassportElementErrorUnspecified implement PassportElementError.
func (*PassportElementErrorUnspecified) isPassportElementError() {}
// 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 PassportElementErrorDataField struct {
// Error source, must be data
Source PassportElementErrorSource `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 PassportElementErrorDataFieldType `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"`
}
// MarshalJSON encodes PassportElementErrorDataField with the discriminator field
// "source" forced to "data".
// The hardcoded value frees callers from setting Source by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *PassportElementErrorDataField) MarshalJSON() ([]byte, error) {
type alias PassportElementErrorDataField
return json.Marshal(&struct {
Source string `json:"source"`
*alias
}{
Source: "data",
alias: (*alias)(v),
})
}
// 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 PassportElementErrorFrontSide struct {
// Error source, must be front_side
Source PassportElementErrorSource `json:"source"`
// The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”
Type PassportElementErrorSelfieType `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"`
}
// MarshalJSON encodes PassportElementErrorFrontSide with the discriminator field
// "source" forced to "front_side".
// The hardcoded value frees callers from setting Source by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *PassportElementErrorFrontSide) MarshalJSON() ([]byte, error) {
type alias PassportElementErrorFrontSide
return json.Marshal(&struct {
Source string `json:"source"`
*alias
}{
Source: "front_side",
alias: (*alias)(v),
})
}
// 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 PassportElementErrorReverseSide struct {
// Error source, must be reverse_side
Source PassportElementErrorSource `json:"source"`
// The section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card”
Type PassportElementErrorReverseSideType `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"`
}
// MarshalJSON encodes PassportElementErrorReverseSide with the discriminator field
// "source" forced to "reverse_side".
// The hardcoded value frees callers from setting Source by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *PassportElementErrorReverseSide) MarshalJSON() ([]byte, error) {
type alias PassportElementErrorReverseSide
return json.Marshal(&struct {
Source string `json:"source"`
*alias
}{
Source: "reverse_side",
alias: (*alias)(v),
})
}
// Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
type PassportElementErrorSelfie struct {
// Error source, must be selfie
Source PassportElementErrorSource `json:"source"`
// The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”
Type PassportElementErrorSelfieType `json:"type"`
// Base64-encoded hash of the file with the selfie
FileHash string `json:"file_hash"`
// Error message
Message string `json:"message"`
}
// MarshalJSON encodes PassportElementErrorSelfie with the discriminator field
// "source" forced to "selfie".
// The hardcoded value frees callers from setting Source by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *PassportElementErrorSelfie) MarshalJSON() ([]byte, error) {
type alias PassportElementErrorSelfie
return json.Marshal(&struct {
Source string `json:"source"`
*alias
}{
Source: "selfie",
alias: (*alias)(v),
})
}
// Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
type PassportElementErrorFile struct {
// Error source, must be file
Source PassportElementErrorSource `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 PassportElementErrorFileType `json:"type"`
// Base64-encoded file hash
FileHash string `json:"file_hash"`
// Error message
Message string `json:"message"`
}
// MarshalJSON encodes PassportElementErrorFile with the discriminator field
// "source" forced to "file".
// The hardcoded value frees callers from setting Source by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *PassportElementErrorFile) MarshalJSON() ([]byte, error) {
type alias PassportElementErrorFile
return json.Marshal(&struct {
Source string `json:"source"`
*alias
}{
Source: "file",
alias: (*alias)(v),
})
}
// Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
type PassportElementErrorFiles struct {
// Error source, must be files
Source PassportElementErrorSource `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 PassportElementErrorFileType `json:"type"`
// List of base64-encoded file hashes
FileHashes []string `json:"file_hashes"`
// Error message
Message string `json:"message"`
}
// MarshalJSON encodes PassportElementErrorFiles with the discriminator field
// "source" forced to "files".
// The hardcoded value frees callers from setting Source by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *PassportElementErrorFiles) MarshalJSON() ([]byte, error) {
type alias PassportElementErrorFiles
return json.Marshal(&struct {
Source string `json:"source"`
*alias
}{
Source: "files",
alias: (*alias)(v),
})
}
// 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 PassportElementErrorTranslationFile struct {
// Error source, must be translation_file
Source PassportElementErrorSource `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 PassportElementErrorTranslationFileType `json:"type"`
// Base64-encoded file hash
FileHash string `json:"file_hash"`
// Error message
Message string `json:"message"`
}
// MarshalJSON encodes PassportElementErrorTranslationFile with the discriminator field
// "source" forced to "translation_file".
// The hardcoded value frees callers from setting Source by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *PassportElementErrorTranslationFile) MarshalJSON() ([]byte, error) {
type alias PassportElementErrorTranslationFile
return json.Marshal(&struct {
Source string `json:"source"`
*alias
}{
Source: "translation_file",
alias: (*alias)(v),
})
}
// Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
type PassportElementErrorTranslationFiles struct {
// Error source, must be translation_files
Source PassportElementErrorSource `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 PassportElementErrorTranslationFileType `json:"type"`
// List of base64-encoded file hashes
FileHashes []string `json:"file_hashes"`
// Error message
Message string `json:"message"`
}
// MarshalJSON encodes PassportElementErrorTranslationFiles with the discriminator field
// "source" forced to "translation_files".
// The hardcoded value frees callers from setting Source by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *PassportElementErrorTranslationFiles) MarshalJSON() ([]byte, error) {
type alias PassportElementErrorTranslationFiles
return json.Marshal(&struct {
Source string `json:"source"`
*alias
}{
Source: "translation_files",
alias: (*alias)(v),
})
}
// Represents an issue in an unspecified place. The error is considered resolved when new data is added.
type PassportElementErrorUnspecified struct {
// Error source, must be unspecified
Source PassportElementErrorSource `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"`
}
// MarshalJSON encodes PassportElementErrorUnspecified with the discriminator field
// "source" forced to "unspecified".
// The hardcoded value frees callers from setting Source by hand —
// any user-supplied value on the struct literal is overridden so a typo
// can't slip through to Telegram.
func (v *PassportElementErrorUnspecified) MarshalJSON() ([]byte, error) {
type alias PassportElementErrorUnspecified
return json.Marshal(&struct {
Source string `json:"source"`
*alias
}{
Source: "unspecified",
alias: (*alias)(v),
})
}
// This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
type Game struct {
// Title of the game
Title string `json:"title"`
// Description of the game
Description string `json:"description"`
// Photo that will be displayed in the game message in chats.
Photo []PhotoSize `json:"photo"`
// Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters.
Text string `json:"text,omitempty"`
// Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
TextEntities []MessageEntity `json:"text_entities,omitempty"`
// Optional. Animation that will be displayed in the game message in chats. Upload via BotFather
Animation *Animation `json:"animation,omitempty"`
}
// A placeholder, currently holds no information. Use BotFather to set up your game.
type CallbackGame struct {
}
// This object represents one row of the high scores table for a game.
// And that's about all we've got for now.If you've got any questions, please check out our Bot FAQ »
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"`
}
Reference in New Issue View Git Blame Copy Permalink